| Jon Wayne Parrott | 7d5badb | 2016-08-16 12:44:29 -0700 | [diff] [blame] | 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 | |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 75 | <h1><a href="appengine_v1.html">App Engine Admin API</a> . <a href="appengine_v1.apps.html">apps</a> . <a href="appengine_v1.apps.services.html">services</a> . <a href="appengine_v1.apps.services.versions.html">versions</a></h1> |
| Jon Wayne Parrott | 7d5badb | 2016-08-16 12:44:29 -0700 | [diff] [blame] | 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"> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 83 | <code><a href="#close">close()</a></code></p> |
| 84 | <p class="firstline">Close httplib2 connections.</p> |
| 85 | <p class="toc_element"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 86 | <code><a href="#create">create(appsId, servicesId, body=None, x__xgafv=None)</a></code></p> |
| Jon Wayne Parrott | 7d5badb | 2016-08-16 12:44:29 -0700 | [diff] [blame] | 87 | <p class="firstline">Deploys code and resource files to a new version.</p> |
| 88 | <p class="toc_element"> |
| 89 | <code><a href="#delete">delete(appsId, servicesId, versionsId, x__xgafv=None)</a></code></p> |
| 90 | <p class="firstline">Deletes an existing Version resource.</p> |
| 91 | <p class="toc_element"> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 92 | <code><a href="#get">get(appsId, servicesId, versionsId, view=None, x__xgafv=None)</a></code></p> |
| Jon Wayne Parrott | 692617a | 2017-01-06 09:58:29 -0800 | [diff] [blame] | 93 | <p class="firstline">Gets the specified Version resource. By default, only a BASIC_VIEW will be returned. Specify the FULL_VIEW parameter to get the full resource.</p> |
| Jon Wayne Parrott | 7d5badb | 2016-08-16 12:44:29 -0700 | [diff] [blame] | 94 | <p class="toc_element"> |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 95 | <code><a href="#list">list(appsId, servicesId, pageSize=None, pageToken=None, view=None, x__xgafv=None)</a></code></p> |
| Jon Wayne Parrott | 7d5badb | 2016-08-16 12:44:29 -0700 | [diff] [blame] | 96 | <p class="firstline">Lists the versions of a service.</p> |
| 97 | <p class="toc_element"> |
| 98 | <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| 99 | <p class="firstline">Retrieves the next page of results.</p> |
| 100 | <p class="toc_element"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 101 | <code><a href="#patch">patch(appsId, servicesId, versionsId, body=None, updateMask=None, x__xgafv=None)</a></code></p> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 102 | <p class="firstline">Updates the specified Version resource. You can specify the following fields depending on the App Engine environment and type of scaling that the version resource uses:Standard environment instance_class (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.instance_class)automatic scaling in the standard environment: automatic_scaling.min_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling) automatic_scaling.max_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling) automaticScaling.standard_scheduler_settings.max_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#StandardSchedulerSettings) automaticScaling.standard_scheduler_settings.min_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#StandardSchedulerSettings) automaticScaling.standard_scheduler_settings.target_cpu_utilization (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#StandardSchedulerSettings) automaticScaling.standard_scheduler_settings.target_throughput_utilization (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#StandardSchedulerSettings)basic scaling or manual scaling in the standard environment: serving_status (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.serving_status) manual_scaling.instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#manualscaling)Flexible environment serving_status (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.serving_status)automatic scaling in the flexible environment: automatic_scaling.min_total_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling) automatic_scaling.max_total_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling) automatic_scaling.cool_down_period_sec (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling) automatic_scaling.cpu_utilization.target_utilization (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling)manual scaling in the flexible environment: manual_scaling.instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#manualscaling)</p> |
| Jon Wayne Parrott | 7d5badb | 2016-08-16 12:44:29 -0700 | [diff] [blame] | 103 | <h3>Method Details</h3> |
| 104 | <div class="method"> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 105 | <code class="details" id="close">close()</code> |
| 106 | <pre>Close httplib2 connections.</pre> |
| 107 | </div> |
| 108 | |
| 109 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 110 | <code class="details" id="create">create(appsId, servicesId, body=None, x__xgafv=None)</code> |
| Jon Wayne Parrott | 7d5badb | 2016-08-16 12:44:29 -0700 | [diff] [blame] | 111 | <pre>Deploys code and resource files to a new version. |
| 112 | |
| 113 | Args: |
| Jon Wayne Parrott | 692617a | 2017-01-06 09:58:29 -0800 | [diff] [blame] | 114 | appsId: string, Part of `parent`. Name of the parent resource to create this version under. Example: apps/myapp/services/default. (required) |
| Jon Wayne Parrott | 7d5badb | 2016-08-16 12:44:29 -0700 | [diff] [blame] | 115 | servicesId: string, Part of `parent`. See documentation of `appsId`. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 116 | body: object, The request body. |
| Jon Wayne Parrott | 7d5badb | 2016-08-16 12:44:29 -0700 | [diff] [blame] | 117 | The object takes the form of: |
| 118 | |
| 119 | { # A Version resource is a specific set of source code and configuration files that are deployed into a service. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame^] | 120 | "betaSettings": { # Metadata settings that are supplied to this version to enable beta runtime features. |
| 121 | "a_key": "A String", |
| 122 | }, |
| 123 | "createTime": "A String", # Time that this version was created.@OutputOnly |
| 124 | "vm": True or False, # Whether to deploy this version in a container on a virtual machine. |
| 125 | "network": { # Extra network settings. Only applicable in the App Engine flexible environment. # Extra network settings. Only applicable in the App Engine flexible environment. |
| 126 | "name": "A String", # Google Compute Engine network where the virtual machines are created. Specify the short name, not the resource path.Defaults to default. |
| 127 | "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. If the network that the instance is being created in is a Legacy network, then the IP address is allocated from the IPv4Range. If the network that the instance is being created in is an auto Subnet Mode Network, then only network name should be specified (not the subnetwork_name) and the IP address is created from the IPCidrRange of the subnetwork that exists in that zone for that network. If the network that the instance is being created in is a custom Subnet Mode Network, then the subnetwork_name must be specified and the IP address is created from the IPCidrRange of the subnetwork.If specified, the subnetwork must exist in the same region as the App Engine flexible environment application. |
| 128 | "forwardedPorts": [ # List of ports, or port pairs, to forward from the virtual machine to the application container. Only applicable in the App Engine flexible environment. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 129 | "A String", |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 130 | ], |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame^] | 131 | "sessionAffinity": True or False, # Enable session affinity. Only applicable in the App Engine flexible environment. |
| 132 | "instanceTag": "A String", # Tag to apply to the instance during creation. Only applicable in the App Engine flexible environment. |
| 133 | }, |
| 134 | "envVariables": { # Environment variables available to the application.Only returned in GET requests if view=FULL is set. |
| 135 | "a_key": "A String", |
| 136 | }, |
| 137 | "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. |
| 138 | "maxInstances": 42, # Maximum number of instances to create for this version. |
| 139 | "idleTimeout": "A String", # Duration of time after the last request that an instance must wait before the instance is shut down. |
| 140 | }, |
| 141 | "entrypoint": { # The entrypoint for the application. # The entrypoint for the application. |
| 142 | "shell": "A String", # The format should be a shell command that can be fed to bash -c. |
| 143 | }, |
| 144 | "zones": [ # The Google Compute Engine zones that are supported by this version in the App Engine flexible environment. Deprecated. |
| 145 | "A String", |
| 146 | ], |
| 147 | "instanceClass": "A String", # Instance class that is used to run this version. Valid values are: AutomaticScaling: F1, F2, F4, F4_1G ManualScaling or BasicScaling: B1, B2, B4, B8, B4_1GDefaults to F1 for AutomaticScaling and B1 for ManualScaling or BasicScaling. |
| 148 | "readinessCheck": { # Readiness checking configuration for VM instances. Unhealthy instances are removed from traffic rotation. # Configures readiness health checking for instances. Unhealthy instances are not put into the backend traffic rotation.Only returned in GET requests if view=FULL is set. |
| 149 | "appStartTimeout": "A String", # A maximum time limit on application initialization, measured from moment the application successfully replies to a healthcheck until it is ready to serve traffic. |
| 150 | "path": "A String", # The request path. |
| 151 | "successThreshold": 42, # Number of consecutive successful checks required before receiving traffic. |
| 152 | "failureThreshold": 42, # Number of consecutive failed checks required before removing traffic. |
| 153 | "host": "A String", # Host header to send when performing a HTTP Readiness check. Example: "myapp.appspot.com" |
| 154 | "checkInterval": "A String", # Interval between health checks. |
| 155 | "timeout": "A String", # Time before the check is considered failed. |
| 156 | }, |
| 157 | "createdBy": "A String", # Email address of the user who created this version.@OutputOnly |
| 158 | "name": "A String", # Full path to the Version resource in the API. Example: apps/myapp/services/default/versions/v1.@OutputOnly |
| 159 | "vpcAccessConnector": { # VPC access connector specification. # Enables VPC connectivity for standard apps. |
| 160 | "name": "A String", # Full Serverless VPC Access Connector name e.g. /projects/my-project/locations/us-central1/connectors/c1. |
| 161 | }, |
| 162 | "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-". |
| 163 | "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. |
| 164 | "healthCheck": { # Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances. Only applicable for instances in App Engine flexible environment. # Configures health checking for instances. Unhealthy instances are stopped and replaced with new instances. Only applicable in the App Engine flexible environment.Only returned in GET requests if view=FULL is set. |
| 165 | "disableHealthCheck": True or False, # Whether to explicitly disable health checks for this instance. |
| 166 | "unhealthyThreshold": 42, # Number of consecutive failed health checks required before removing traffic. |
| 167 | "checkInterval": "A String", # Interval between health checks. |
| 168 | "healthyThreshold": 42, # Number of consecutive successful health checks required before receiving traffic. |
| 169 | "host": "A String", # Host header to send when performing an HTTP health check. Example: "myapp.appspot.com" |
| 170 | "timeout": "A String", # Time before the health check is considered failed. |
| 171 | "restartThreshold": 42, # Number of consecutive failed health checks required before an instance is restarted. |
| 172 | }, |
| 173 | "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. |
| 174 | { # 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. |
| 175 | "redirectHttpResponseCode": "A String", # 30x code to use when performing redirects for the secure field. Defaults to 302. |
| 176 | "login": "A String", # Level of login required to access this resource. Not supported for Node.js in the App Engine standard environment. |
| 177 | "apiEndpoint": { # Uses Google Cloud Endpoints to handle requests. # Uses API Endpoints to handle requests. |
| 178 | "scriptPath": "A String", # Path to the script from the application root directory. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 179 | }, |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 180 | "securityLevel": "A String", # Security (HTTPS) enforcement for this URL. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 181 | "authFailAction": "A String", # Action to take when users access resources that require authentication. Defaults to redirect. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame^] | 182 | "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. |
| 183 | "script": { # Executes a script to handle the request that matches the URL pattern. # Executes a script to handle the requests that match this URL pattern. Only the auto value is supported for Node.js in the App Engine standard environment, for example "script": "auto". |
| 184 | "scriptPath": "A String", # Path to the script from the application root directory. |
| 185 | }, |
| 186 | "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. |
| 187 | "expiration": "A String", # Time a static file served by this handler should be cached by web proxies and browsers. |
| 188 | "requireMatchingFile": True or False, # Whether this handler should match the request if the file referenced by the handler does not exist. |
| 189 | "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. |
| 190 | "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. |
| 191 | "uploadPathRegex": "A String", # Regular expression that matches the file paths for all files that should be referenced by this handler. |
| 192 | "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. |
| 193 | "httpHeaders": { # HTTP headers to use for all responses from these URLs. |
| 194 | "a_key": "A String", |
| 195 | }, |
| 196 | }, |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 197 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame^] | 198 | ], |
| 199 | "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. Instances are dynamically created and destroyed as needed in order to handle traffic. |
| 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 | "standardSchedulerSettings": { # Scheduler settings for standard environment. # Scheduler settings for standard environment. |
| 202 | "maxInstances": 42, # Maximum number of instances to run for this version. Set to zero to disable max_instances configuration. |
| 203 | "targetThroughputUtilization": 3.14, # Target throughput utilization ratio to maintain when scaling |
| 204 | "minInstances": 42, # Minimum number of instances to run for this version. Set to zero to disable min_instances configuration. |
| 205 | "targetCpuUtilization": 3.14, # Target CPU utilization ratio to maintain when scaling. |
| 206 | }, |
| 207 | "cpuUtilization": { # Target scaling by CPU usage. # Target scaling by CPU usage. |
| 208 | "targetUtilization": 3.14, # Target CPU utilization ratio to maintain when scaling. Must be between 0 and 1. |
| 209 | "aggregationWindowLength": "A String", # Period of time over which CPU utilization is calculated. |
| 210 | }, |
| 211 | "minIdleInstances": 42, # Minimum number of idle instances that should be maintained for this version. Only applicable for the default version of a service. |
| 212 | "diskUtilization": { # Target scaling by disk usage. Only applicable in the App Engine flexible environment. # Target scaling by disk usage. |
| 213 | "targetWriteBytesPerSecond": 42, # Target bytes written per second. |
| 214 | "targetReadBytesPerSecond": 42, # Target bytes read per second. |
| 215 | "targetWriteOpsPerSecond": 42, # Target ops written per second. |
| 216 | "targetReadOpsPerSecond": 42, # Target ops read per seconds. |
| 217 | }, |
| 218 | "minPendingLatency": "A String", # Minimum amount of time a request should wait in the pending queue before starting a new instance to handle it. |
| 219 | "coolDownPeriod": "A String", # The time period that the Autoscaler (https://cloud.google.com/compute/docs/autoscaler/) should wait before it starts collecting information from a new instance. This prevents the autoscaler from collecting information when the instance is initializing, during which the collected usage would not be reliable. Only applicable in the App Engine flexible environment. |
| 220 | "networkUtilization": { # Target scaling by network usage. Only applicable in the App Engine flexible environment. # Target scaling by network usage. |
| 221 | "targetReceivedBytesPerSecond": 42, # Target bytes received per second. |
| 222 | "targetSentPacketsPerSecond": 42, # Target packets sent per second. |
| 223 | "targetSentBytesPerSecond": 42, # Target bytes sent per second. |
| 224 | "targetReceivedPacketsPerSecond": 42, # Target packets received per second. |
| 225 | }, |
| 226 | "maxTotalInstances": 42, # Maximum number of instances that should be started to handle requests for this version. |
| 227 | "requestUtilization": { # Target scaling by request utilization. Only applicable in the App Engine flexible environment. # Target scaling by request utilization. |
| 228 | "targetConcurrentRequests": 42, # Target number of concurrent requests. |
| 229 | "targetRequestCountPerSecond": 42, # Target requests per second. |
| 230 | }, |
| 231 | "maxIdleInstances": 42, # Maximum number of idle instances that should be maintained for this version. |
| 232 | "minTotalInstances": 42, # Minimum number of running instances that should be maintained for this version. |
| 233 | "maxPendingLatency": "A String", # Maximum amount of time that a request should wait in the pending queue before starting a new instance to handle it. |
| 234 | }, |
| 235 | "livenessCheck": { # Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances. # Configures liveness health checking for instances. Unhealthy instances are stopped and replaced with new instancesOnly returned in GET requests if view=FULL is set. |
| 236 | "successThreshold": 42, # Number of consecutive successful checks required before considering the VM healthy. |
| 237 | "host": "A String", # Host header to send when performing a HTTP Liveness check. Example: "myapp.appspot.com" |
| 238 | "timeout": "A String", # Time before the check is considered failed. |
| 239 | "checkInterval": "A String", # Interval between health checks. |
| 240 | "initialDelay": "A String", # The initial delay before starting to execute the checks. |
| 241 | "failureThreshold": 42, # Number of consecutive failed checks required before considering the VM unhealthy. |
| 242 | "path": "A String", # The request path. |
| 243 | }, |
| 244 | "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. |
| 245 | "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. |
| 246 | "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" |
| 247 | }, |
| 248 | "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. |
| 249 | "a_key": { # Single source file that is part of the version to be deployed. Each source file that is deployed must be specified separately. |
| 250 | "mimeType": "A String", # The MIME type of the file.Defaults to the value from Google Cloud Storage. |
| 251 | "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//'. |
| 252 | "sha1Sum": "A String", # The SHA1 hash of the file, in hex. |
| 253 | }, |
| 254 | }, |
| 255 | "zip": { # The zip file information for a zip deployment. # The zip file for this deployment, if this is a zip deployment. |
| 256 | "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//'. |
| 257 | "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. |
| 258 | }, |
| 259 | "cloudBuildOptions": { # Options for the build operations performed as a part of the version deployment. Only applicable for App Engine flexible environment when creating a version using source code directly. # Options for any Google Cloud Build builds created as a part of this deployment.These options will only be used if a new build is created, such as when deploying to the App Engine flexible environment using files or zip. |
| 260 | "appYamlPath": "A String", # Path to the yaml file used in deployment, used to determine runtime configuration details.Required for flexible environment builds.See https://cloud.google.com/appengine/docs/standard/python/config/appref for more details. |
| 261 | "cloudBuildTimeout": "A String", # The Cloud Build timeout used as part of any dependent builds performed by version creation. Defaults to 10 minutes. |
| 262 | }, |
| 263 | }, |
| 264 | "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. |
| 265 | "endpointsApiService": { # Cloud Endpoints (https://cloud.google.com/endpoints) configuration. The Endpoints API Service provides tooling for serving Open API and gRPC endpoints via an NGINX proxy. Only valid for App Engine Flexible environment deployments.The fields here refer to the name and configuration ID of a "service" resource in the Service Management API (https://cloud.google.com/service-management/overview). # Cloud Endpoints configuration.If endpoints_api_service is set, the Cloud Endpoints Extensible Service Proxy will be provided to serve the API implemented by the app. |
| 266 | "rolloutStrategy": "A String", # Endpoints rollout strategy. If FIXED, config_id must be specified. If MANAGED, config_id must be omitted. |
| 267 | "configId": "A String", # Endpoints service configuration ID as specified by the Service Management API. For example "2016-09-19r1".By default, the rollout strategy for Endpoints is RolloutStrategy.FIXED. This means that Endpoints starts up with a particular configuration ID. When a new configuration is rolled out, Endpoints must be given the new configuration ID. The config_id field is used to give the configuration ID and is required in this case.Endpoints also has a rollout strategy called RolloutStrategy.MANAGED. When using this, Endpoints fetches the latest configuration and does not need the configuration ID. In this case, config_id must be omitted. |
| 268 | "disableTraceSampling": True or False, # Enable or disable trace sampling. By default, this is set to false for enabled. |
| 269 | "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" |
| 270 | }, |
| 271 | "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//config/appref |
| 272 | "resources": { # Machine resources for a version. # Machine resources for this version. Only applicable in the App Engine flexible environment. |
| 273 | "kmsKeyReference": "A String", # The name of the encryption key that is stored in Google Cloud KMS. Only should be used by Cloud Composer to encrypt the vm disk |
| 274 | "diskGb": 3.14, # Disk size (GB) needed. |
| 275 | "memoryGb": 3.14, # Memory (GB) needed. |
| 276 | "cpu": 3.14, # Number of CPU cores needed. |
| 277 | "volumes": [ # User specified volumes. |
| 278 | { # Volumes mounted within the app container. Only applicable in the App Engine flexible environment. |
| 279 | "sizeGb": 3.14, # Volume size in gigabytes. |
| 280 | "name": "A String", # Unique name for the volume. |
| 281 | "volumeType": "A String", # Underlying volume type, e.g. 'tmpfs'. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 282 | }, |
| 283 | ], |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame^] | 284 | }, |
| 285 | "env": "A String", # App Engine execution environment for this version.Defaults to standard. |
| 286 | "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. |
| 287 | "login": "A String", # Level of login required to access this resource. Defaults to optional. |
| 288 | "url": "A String", # URL to serve the endpoint at. |
| 289 | "script": "A String", # Path to the script from the application root directory. |
| 290 | "securityLevel": "A String", # Security (HTTPS) enforcement for this URL. |
| 291 | "authFailAction": "A String", # Action to take when users access resources that require authentication. Defaults to redirect. |
| 292 | }, |
| 293 | "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. Manually scaled versions are sometimes referred to as "backends". |
| 294 | "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. |
| 295 | }, |
| 296 | "threadsafe": True or False, # Whether multiple requests can be dispatched to this version at once. |
| 297 | "libraries": [ # Configuration for third-party Python runtime libraries that are required by the application.Only returned in GET requests if view=FULL is set. |
| 298 | { # Third-party Python runtime library that is required by the application. |
| 299 | "version": "A String", # Version of the library to select, or "latest". |
| 300 | "name": "A String", # Name of the library. Example: "django". |
| 301 | }, |
| 302 | ], |
| 303 | "diskUsageBytes": "A String", # Total size in bytes of all the files that are included in this version and currently hosted on the App Engine disk.@OutputOnly |
| 304 | "errorHandlers": [ # Custom static error pages. Limited to 10KB per page.Only returned in GET requests if view=FULL is set. |
| 305 | { # Custom static error page to be served when an error occurs. |
| 306 | "staticFile": "A String", # Static file content to be served for this error. |
| 307 | "errorCode": "A String", # Error condition this handler applies to. |
| 308 | "mimeType": "A String", # MIME type of file. Defaults to text/html. |
| 309 | }, |
| 310 | ], |
| 311 | "runtime": "A String", # Desired runtime. Example: python27. |
| 312 | "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. |
| 313 | "runtimeMainExecutablePath": "A String", # The path or name of the app's main executable. |
| 314 | "runtimeChannel": "A String", # The channel of the runtime to use. Only available for some runtimes. Defaults to the default channel. |
| 315 | "inboundServices": [ # Before an application can receive email or XMPP messages, the application must be configured to enable the service. |
| 316 | "A String", |
| 317 | ], |
| 318 | "buildEnvVariables": { # Environment variables available to the build environment.Only returned in GET requests if view=FULL is set. |
| 319 | "a_key": "A String", |
| 320 | }, |
| 321 | "versionUrl": "A String", # Serving URL for this version. Example: "https://myversion-dot-myservice-dot-myapp.appspot.com"@OutputOnly |
| 322 | } |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 323 | |
| 324 | x__xgafv: string, V1 error format. |
| 325 | Allowed values |
| 326 | 1 - v1 error format |
| 327 | 2 - v2 error format |
| 328 | |
| 329 | Returns: |
| 330 | An object of the form: |
| 331 | |
| 332 | { # This resource represents a long-running operation that is the result of a network API call. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame^] | 333 | "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. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 334 | "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. |
| 335 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 336 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame^] | 337 | "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should be a resource name ending with operations/{unique_id}. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 338 | "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. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 339 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 340 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 341 | "error": { # The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). Each Status message contains three pieces of data: error code, error message, and error details.You can find out more about this error model and how to work with it in the API Design Guide (https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 342 | "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. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 343 | "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. |
| 344 | { |
| 345 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 346 | }, |
| 347 | ], |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 348 | "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 349 | }, |
| 350 | }</pre> |
| 351 | </div> |
| 352 | |
| 353 | <div class="method"> |
| 354 | <code class="details" id="delete">delete(appsId, servicesId, versionsId, x__xgafv=None)</code> |
| 355 | <pre>Deletes an existing Version resource. |
| 356 | |
| 357 | Args: |
| 358 | appsId: string, Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1. (required) |
| 359 | servicesId: string, Part of `name`. See documentation of `appsId`. (required) |
| 360 | versionsId: string, Part of `name`. See documentation of `appsId`. (required) |
| 361 | x__xgafv: string, V1 error format. |
| 362 | Allowed values |
| 363 | 1 - v1 error format |
| 364 | 2 - v2 error format |
| 365 | |
| 366 | Returns: |
| 367 | An object of the form: |
| 368 | |
| 369 | { # This resource represents a long-running operation that is the result of a network API call. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame^] | 370 | "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. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 371 | "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. |
| 372 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 373 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame^] | 374 | "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should be a resource name ending with operations/{unique_id}. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 375 | "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. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 376 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 377 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 378 | "error": { # The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). Each Status message contains three pieces of data: error code, error message, and error details.You can find out more about this error model and how to work with it in the API Design Guide (https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 379 | "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. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 380 | "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. |
| 381 | { |
| 382 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 383 | }, |
| 384 | ], |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 385 | "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 386 | }, |
| 387 | }</pre> |
| 388 | </div> |
| 389 | |
| 390 | <div class="method"> |
| 391 | <code class="details" id="get">get(appsId, servicesId, versionsId, view=None, x__xgafv=None)</code> |
| 392 | <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. |
| 393 | |
| 394 | Args: |
| 395 | appsId: string, Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1. (required) |
| 396 | servicesId: string, Part of `name`. See documentation of `appsId`. (required) |
| 397 | versionsId: string, Part of `name`. See documentation of `appsId`. (required) |
| 398 | view: string, Controls the set of fields returned in the Get response. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 399 | Allowed values |
| 400 | BASIC - Basic version information including scaling and inbound services, but not detailed deployment information. |
| 401 | FULL - The information from BASIC, plus detailed information about the deployment. This format is required when creating resources, but is not returned in Get or List by default. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 402 | x__xgafv: string, V1 error format. |
| 403 | Allowed values |
| 404 | 1 - v1 error format |
| 405 | 2 - v2 error format |
| 406 | |
| 407 | Returns: |
| 408 | An object of the form: |
| 409 | |
| 410 | { # A Version resource is a specific set of source code and configuration files that are deployed into a service. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame^] | 411 | "betaSettings": { # Metadata settings that are supplied to this version to enable beta runtime features. |
| 412 | "a_key": "A String", |
| 413 | }, |
| 414 | "createTime": "A String", # Time that this version was created.@OutputOnly |
| 415 | "vm": True or False, # Whether to deploy this version in a container on a virtual machine. |
| 416 | "network": { # Extra network settings. Only applicable in the App Engine flexible environment. # Extra network settings. Only applicable in the App Engine flexible environment. |
| 417 | "name": "A String", # Google Compute Engine network where the virtual machines are created. Specify the short name, not the resource path.Defaults to default. |
| 418 | "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. If the network that the instance is being created in is a Legacy network, then the IP address is allocated from the IPv4Range. If the network that the instance is being created in is an auto Subnet Mode Network, then only network name should be specified (not the subnetwork_name) and the IP address is created from the IPCidrRange of the subnetwork that exists in that zone for that network. If the network that the instance is being created in is a custom Subnet Mode Network, then the subnetwork_name must be specified and the IP address is created from the IPCidrRange of the subnetwork.If specified, the subnetwork must exist in the same region as the App Engine flexible environment application. |
| 419 | "forwardedPorts": [ # List of ports, or port pairs, to forward from the virtual machine to the application container. Only applicable in the App Engine flexible environment. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 420 | "A String", |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 421 | ], |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame^] | 422 | "sessionAffinity": True or False, # Enable session affinity. Only applicable in the App Engine flexible environment. |
| 423 | "instanceTag": "A String", # Tag to apply to the instance during creation. Only applicable in the App Engine flexible environment. |
| 424 | }, |
| 425 | "envVariables": { # Environment variables available to the application.Only returned in GET requests if view=FULL is set. |
| 426 | "a_key": "A String", |
| 427 | }, |
| 428 | "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. |
| 429 | "maxInstances": 42, # Maximum number of instances to create for this version. |
| 430 | "idleTimeout": "A String", # Duration of time after the last request that an instance must wait before the instance is shut down. |
| 431 | }, |
| 432 | "entrypoint": { # The entrypoint for the application. # The entrypoint for the application. |
| 433 | "shell": "A String", # The format should be a shell command that can be fed to bash -c. |
| 434 | }, |
| 435 | "zones": [ # The Google Compute Engine zones that are supported by this version in the App Engine flexible environment. Deprecated. |
| 436 | "A String", |
| 437 | ], |
| 438 | "instanceClass": "A String", # Instance class that is used to run this version. Valid values are: AutomaticScaling: F1, F2, F4, F4_1G ManualScaling or BasicScaling: B1, B2, B4, B8, B4_1GDefaults to F1 for AutomaticScaling and B1 for ManualScaling or BasicScaling. |
| 439 | "readinessCheck": { # Readiness checking configuration for VM instances. Unhealthy instances are removed from traffic rotation. # Configures readiness health checking for instances. Unhealthy instances are not put into the backend traffic rotation.Only returned in GET requests if view=FULL is set. |
| 440 | "appStartTimeout": "A String", # A maximum time limit on application initialization, measured from moment the application successfully replies to a healthcheck until it is ready to serve traffic. |
| 441 | "path": "A String", # The request path. |
| 442 | "successThreshold": 42, # Number of consecutive successful checks required before receiving traffic. |
| 443 | "failureThreshold": 42, # Number of consecutive failed checks required before removing traffic. |
| 444 | "host": "A String", # Host header to send when performing a HTTP Readiness check. Example: "myapp.appspot.com" |
| 445 | "checkInterval": "A String", # Interval between health checks. |
| 446 | "timeout": "A String", # Time before the check is considered failed. |
| 447 | }, |
| 448 | "createdBy": "A String", # Email address of the user who created this version.@OutputOnly |
| 449 | "name": "A String", # Full path to the Version resource in the API. Example: apps/myapp/services/default/versions/v1.@OutputOnly |
| 450 | "vpcAccessConnector": { # VPC access connector specification. # Enables VPC connectivity for standard apps. |
| 451 | "name": "A String", # Full Serverless VPC Access Connector name e.g. /projects/my-project/locations/us-central1/connectors/c1. |
| 452 | }, |
| 453 | "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-". |
| 454 | "nobuildFilesRegex": "A String", # Files that match this pattern will not be built into this version. Only applicable for Go runtimes.Only returned in GET requests if view=FULL is set. |
| 455 | "healthCheck": { # Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances. Only applicable for instances in App Engine flexible environment. # Configures health checking for instances. Unhealthy instances are stopped and replaced with new instances. Only applicable in the App Engine flexible environment.Only returned in GET requests if view=FULL is set. |
| 456 | "disableHealthCheck": True or False, # Whether to explicitly disable health checks for this instance. |
| 457 | "unhealthyThreshold": 42, # Number of consecutive failed health checks required before removing traffic. |
| 458 | "checkInterval": "A String", # Interval between health checks. |
| 459 | "healthyThreshold": 42, # Number of consecutive successful health checks required before receiving traffic. |
| 460 | "host": "A String", # Host header to send when performing an HTTP health check. Example: "myapp.appspot.com" |
| 461 | "timeout": "A String", # Time before the health check is considered failed. |
| 462 | "restartThreshold": 42, # Number of consecutive failed health checks required before an instance is restarted. |
| 463 | }, |
| 464 | "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. |
| 465 | { # 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. |
| 466 | "redirectHttpResponseCode": "A String", # 30x code to use when performing redirects for the secure field. Defaults to 302. |
| 467 | "login": "A String", # Level of login required to access this resource. Not supported for Node.js in the App Engine standard environment. |
| 468 | "apiEndpoint": { # Uses Google Cloud Endpoints to handle requests. # Uses API Endpoints to handle requests. |
| 469 | "scriptPath": "A String", # Path to the script from the application root directory. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 470 | }, |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 471 | "securityLevel": "A String", # Security (HTTPS) enforcement for this URL. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 472 | "authFailAction": "A String", # Action to take when users access resources that require authentication. Defaults to redirect. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame^] | 473 | "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. |
| 474 | "script": { # Executes a script to handle the request that matches the URL pattern. # Executes a script to handle the requests that match this URL pattern. Only the auto value is supported for Node.js in the App Engine standard environment, for example "script": "auto". |
| 475 | "scriptPath": "A String", # Path to the script from the application root directory. |
| 476 | }, |
| 477 | "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. |
| 478 | "expiration": "A String", # Time a static file served by this handler should be cached by web proxies and browsers. |
| 479 | "requireMatchingFile": True or False, # Whether this handler should match the request if the file referenced by the handler does not exist. |
| 480 | "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. |
| 481 | "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. |
| 482 | "uploadPathRegex": "A String", # Regular expression that matches the file paths for all files that should be referenced by this handler. |
| 483 | "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. |
| 484 | "httpHeaders": { # HTTP headers to use for all responses from these URLs. |
| 485 | "a_key": "A String", |
| 486 | }, |
| 487 | }, |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 488 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame^] | 489 | ], |
| 490 | "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. Instances are dynamically created and destroyed as needed in order to handle traffic. |
| 491 | "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. |
| 492 | "standardSchedulerSettings": { # Scheduler settings for standard environment. # Scheduler settings for standard environment. |
| 493 | "maxInstances": 42, # Maximum number of instances to run for this version. Set to zero to disable max_instances configuration. |
| 494 | "targetThroughputUtilization": 3.14, # Target throughput utilization ratio to maintain when scaling |
| 495 | "minInstances": 42, # Minimum number of instances to run for this version. Set to zero to disable min_instances configuration. |
| 496 | "targetCpuUtilization": 3.14, # Target CPU utilization ratio to maintain when scaling. |
| 497 | }, |
| 498 | "cpuUtilization": { # Target scaling by CPU usage. # Target scaling by CPU usage. |
| 499 | "targetUtilization": 3.14, # Target CPU utilization ratio to maintain when scaling. Must be between 0 and 1. |
| 500 | "aggregationWindowLength": "A String", # Period of time over which CPU utilization is calculated. |
| 501 | }, |
| 502 | "minIdleInstances": 42, # Minimum number of idle instances that should be maintained for this version. Only applicable for the default version of a service. |
| 503 | "diskUtilization": { # Target scaling by disk usage. Only applicable in the App Engine flexible environment. # Target scaling by disk usage. |
| 504 | "targetWriteBytesPerSecond": 42, # Target bytes written per second. |
| 505 | "targetReadBytesPerSecond": 42, # Target bytes read per second. |
| 506 | "targetWriteOpsPerSecond": 42, # Target ops written per second. |
| 507 | "targetReadOpsPerSecond": 42, # Target ops read per seconds. |
| 508 | }, |
| 509 | "minPendingLatency": "A String", # Minimum amount of time a request should wait in the pending queue before starting a new instance to handle it. |
| 510 | "coolDownPeriod": "A String", # The time period that the Autoscaler (https://cloud.google.com/compute/docs/autoscaler/) should wait before it starts collecting information from a new instance. This prevents the autoscaler from collecting information when the instance is initializing, during which the collected usage would not be reliable. Only applicable in the App Engine flexible environment. |
| 511 | "networkUtilization": { # Target scaling by network usage. Only applicable in the App Engine flexible environment. # Target scaling by network usage. |
| 512 | "targetReceivedBytesPerSecond": 42, # Target bytes received per second. |
| 513 | "targetSentPacketsPerSecond": 42, # Target packets sent per second. |
| 514 | "targetSentBytesPerSecond": 42, # Target bytes sent per second. |
| 515 | "targetReceivedPacketsPerSecond": 42, # Target packets received per second. |
| 516 | }, |
| 517 | "maxTotalInstances": 42, # Maximum number of instances that should be started to handle requests for this version. |
| 518 | "requestUtilization": { # Target scaling by request utilization. Only applicable in the App Engine flexible environment. # Target scaling by request utilization. |
| 519 | "targetConcurrentRequests": 42, # Target number of concurrent requests. |
| 520 | "targetRequestCountPerSecond": 42, # Target requests per second. |
| 521 | }, |
| 522 | "maxIdleInstances": 42, # Maximum number of idle instances that should be maintained for this version. |
| 523 | "minTotalInstances": 42, # Minimum number of running instances that should be maintained for this version. |
| 524 | "maxPendingLatency": "A String", # Maximum amount of time that a request should wait in the pending queue before starting a new instance to handle it. |
| 525 | }, |
| 526 | "livenessCheck": { # Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances. # Configures liveness health checking for instances. Unhealthy instances are stopped and replaced with new instancesOnly returned in GET requests if view=FULL is set. |
| 527 | "successThreshold": 42, # Number of consecutive successful checks required before considering the VM healthy. |
| 528 | "host": "A String", # Host header to send when performing a HTTP Liveness check. Example: "myapp.appspot.com" |
| 529 | "timeout": "A String", # Time before the check is considered failed. |
| 530 | "checkInterval": "A String", # Interval between health checks. |
| 531 | "initialDelay": "A String", # The initial delay before starting to execute the checks. |
| 532 | "failureThreshold": 42, # Number of consecutive failed checks required before considering the VM unhealthy. |
| 533 | "path": "A String", # The request path. |
| 534 | }, |
| 535 | "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. |
| 536 | "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. |
| 537 | "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" |
| 538 | }, |
| 539 | "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. |
| 540 | "a_key": { # Single source file that is part of the version to be deployed. Each source file that is deployed must be specified separately. |
| 541 | "mimeType": "A String", # The MIME type of the file.Defaults to the value from Google Cloud Storage. |
| 542 | "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//'. |
| 543 | "sha1Sum": "A String", # The SHA1 hash of the file, in hex. |
| 544 | }, |
| 545 | }, |
| 546 | "zip": { # The zip file information for a zip deployment. # The zip file for this deployment, if this is a zip deployment. |
| 547 | "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//'. |
| 548 | "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. |
| 549 | }, |
| 550 | "cloudBuildOptions": { # Options for the build operations performed as a part of the version deployment. Only applicable for App Engine flexible environment when creating a version using source code directly. # Options for any Google Cloud Build builds created as a part of this deployment.These options will only be used if a new build is created, such as when deploying to the App Engine flexible environment using files or zip. |
| 551 | "appYamlPath": "A String", # Path to the yaml file used in deployment, used to determine runtime configuration details.Required for flexible environment builds.See https://cloud.google.com/appengine/docs/standard/python/config/appref for more details. |
| 552 | "cloudBuildTimeout": "A String", # The Cloud Build timeout used as part of any dependent builds performed by version creation. Defaults to 10 minutes. |
| 553 | }, |
| 554 | }, |
| 555 | "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. |
| 556 | "endpointsApiService": { # Cloud Endpoints (https://cloud.google.com/endpoints) configuration. The Endpoints API Service provides tooling for serving Open API and gRPC endpoints via an NGINX proxy. Only valid for App Engine Flexible environment deployments.The fields here refer to the name and configuration ID of a "service" resource in the Service Management API (https://cloud.google.com/service-management/overview). # Cloud Endpoints configuration.If endpoints_api_service is set, the Cloud Endpoints Extensible Service Proxy will be provided to serve the API implemented by the app. |
| 557 | "rolloutStrategy": "A String", # Endpoints rollout strategy. If FIXED, config_id must be specified. If MANAGED, config_id must be omitted. |
| 558 | "configId": "A String", # Endpoints service configuration ID as specified by the Service Management API. For example "2016-09-19r1".By default, the rollout strategy for Endpoints is RolloutStrategy.FIXED. This means that Endpoints starts up with a particular configuration ID. When a new configuration is rolled out, Endpoints must be given the new configuration ID. The config_id field is used to give the configuration ID and is required in this case.Endpoints also has a rollout strategy called RolloutStrategy.MANAGED. When using this, Endpoints fetches the latest configuration and does not need the configuration ID. In this case, config_id must be omitted. |
| 559 | "disableTraceSampling": True or False, # Enable or disable trace sampling. By default, this is set to false for enabled. |
| 560 | "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" |
| 561 | }, |
| 562 | "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//config/appref |
| 563 | "resources": { # Machine resources for a version. # Machine resources for this version. Only applicable in the App Engine flexible environment. |
| 564 | "kmsKeyReference": "A String", # The name of the encryption key that is stored in Google Cloud KMS. Only should be used by Cloud Composer to encrypt the vm disk |
| 565 | "diskGb": 3.14, # Disk size (GB) needed. |
| 566 | "memoryGb": 3.14, # Memory (GB) needed. |
| 567 | "cpu": 3.14, # Number of CPU cores needed. |
| 568 | "volumes": [ # User specified volumes. |
| 569 | { # Volumes mounted within the app container. Only applicable in the App Engine flexible environment. |
| 570 | "sizeGb": 3.14, # Volume size in gigabytes. |
| 571 | "name": "A String", # Unique name for the volume. |
| 572 | "volumeType": "A String", # Underlying volume type, e.g. 'tmpfs'. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 573 | }, |
| 574 | ], |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame^] | 575 | }, |
| 576 | "env": "A String", # App Engine execution environment for this version.Defaults to standard. |
| 577 | "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. |
| 578 | "login": "A String", # Level of login required to access this resource. Defaults to optional. |
| 579 | "url": "A String", # URL to serve the endpoint at. |
| 580 | "script": "A String", # Path to the script from the application root directory. |
| 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 | }, |
| 584 | "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. Manually scaled versions are sometimes referred to as "backends". |
| 585 | "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. |
| 586 | }, |
| 587 | "threadsafe": True or False, # Whether multiple requests can be dispatched to this version at once. |
| 588 | "libraries": [ # Configuration for third-party Python runtime libraries that are required by the application.Only returned in GET requests if view=FULL is set. |
| 589 | { # Third-party Python runtime library that is required by the application. |
| 590 | "version": "A String", # Version of the library to select, or "latest". |
| 591 | "name": "A String", # Name of the library. Example: "django". |
| 592 | }, |
| 593 | ], |
| 594 | "diskUsageBytes": "A String", # Total size in bytes of all the files that are included in this version and currently hosted on the App Engine disk.@OutputOnly |
| 595 | "errorHandlers": [ # Custom static error pages. Limited to 10KB per page.Only returned in GET requests if view=FULL is set. |
| 596 | { # Custom static error page to be served when an error occurs. |
| 597 | "staticFile": "A String", # Static file content to be served for this error. |
| 598 | "errorCode": "A String", # Error condition this handler applies to. |
| 599 | "mimeType": "A String", # MIME type of file. Defaults to text/html. |
| 600 | }, |
| 601 | ], |
| 602 | "runtime": "A String", # Desired runtime. Example: python27. |
| 603 | "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. |
| 604 | "runtimeMainExecutablePath": "A String", # The path or name of the app's main executable. |
| 605 | "runtimeChannel": "A String", # The channel of the runtime to use. Only available for some runtimes. Defaults to the default channel. |
| 606 | "inboundServices": [ # Before an application can receive email or XMPP messages, the application must be configured to enable the service. |
| 607 | "A String", |
| 608 | ], |
| 609 | "buildEnvVariables": { # Environment variables available to the build environment.Only returned in GET requests if view=FULL is set. |
| 610 | "a_key": "A String", |
| 611 | }, |
| 612 | "versionUrl": "A String", # Serving URL for this version. Example: "https://myversion-dot-myservice-dot-myapp.appspot.com"@OutputOnly |
| 613 | }</pre> |
| Jon Wayne Parrott | 7d5badb | 2016-08-16 12:44:29 -0700 | [diff] [blame] | 614 | </div> |
| 615 | |
| 616 | <div class="method"> |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 617 | <code class="details" id="list">list(appsId, servicesId, pageSize=None, pageToken=None, view=None, x__xgafv=None)</code> |
| Jon Wayne Parrott | 7d5badb | 2016-08-16 12:44:29 -0700 | [diff] [blame] | 618 | <pre>Lists the versions of a service. |
| 619 | |
| 620 | Args: |
| Jon Wayne Parrott | 692617a | 2017-01-06 09:58:29 -0800 | [diff] [blame] | 621 | appsId: string, Part of `parent`. Name of the parent Service resource. Example: apps/myapp/services/default. (required) |
| Jon Wayne Parrott | 7d5badb | 2016-08-16 12:44:29 -0700 | [diff] [blame] | 622 | servicesId: string, Part of `parent`. See documentation of `appsId`. (required) |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 623 | pageSize: integer, Maximum results to return per page. |
| 624 | pageToken: string, Continuation token for fetching the next page of results. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 625 | view: string, Controls the set of fields returned in the List response. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 626 | Allowed values |
| 627 | BASIC - Basic version information including scaling and inbound services, but not detailed deployment information. |
| 628 | FULL - The information from BASIC, plus detailed information about the deployment. This format is required when creating resources, but is not returned in Get or List by default. |
| Jon Wayne Parrott | 7d5badb | 2016-08-16 12:44:29 -0700 | [diff] [blame] | 629 | x__xgafv: string, V1 error format. |
| Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 630 | Allowed values |
| 631 | 1 - v1 error format |
| 632 | 2 - v2 error format |
| Jon Wayne Parrott | 7d5badb | 2016-08-16 12:44:29 -0700 | [diff] [blame] | 633 | |
| 634 | Returns: |
| 635 | An object of the form: |
| 636 | |
| Jon Wayne Parrott | 692617a | 2017-01-06 09:58:29 -0800 | [diff] [blame] | 637 | { # Response message for Versions.ListVersions. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 638 | "nextPageToken": "A String", # Continuation token for fetching the next page of results. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 639 | "versions": [ # The versions belonging to the requested service. |
| Jon Wayne Parrott | 7d5badb | 2016-08-16 12:44:29 -0700 | [diff] [blame] | 640 | { # A Version resource is a specific set of source code and configuration files that are deployed into a service. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame^] | 641 | "betaSettings": { # Metadata settings that are supplied to this version to enable beta runtime features. |
| 642 | "a_key": "A String", |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 643 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame^] | 644 | "createTime": "A String", # Time that this version was created.@OutputOnly |
| 645 | "vm": True or False, # Whether to deploy this version in a container on a virtual machine. |
| 646 | "network": { # Extra network settings. Only applicable in the App Engine flexible environment. # Extra network settings. Only applicable in the App Engine flexible environment. |
| 647 | "name": "A String", # Google Compute Engine network where the virtual machines are created. Specify the short name, not the resource path.Defaults to default. |
| 648 | "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. If the network that the instance is being created in is a Legacy network, then the IP address is allocated from the IPv4Range. If the network that the instance is being created in is an auto Subnet Mode Network, then only network name should be specified (not the subnetwork_name) and the IP address is created from the IPCidrRange of the subnetwork that exists in that zone for that network. If the network that the instance is being created in is a custom Subnet Mode Network, then the subnetwork_name must be specified and the IP address is created from the IPCidrRange of the subnetwork.If specified, the subnetwork must exist in the same region as the App Engine flexible environment application. |
| 649 | "forwardedPorts": [ # List of ports, or port pairs, to forward from the virtual machine to the application container. Only applicable in the App Engine flexible environment. |
| 650 | "A String", |
| 651 | ], |
| 652 | "sessionAffinity": True or False, # Enable session affinity. Only applicable in the App Engine flexible environment. |
| 653 | "instanceTag": "A String", # Tag to apply to the instance during creation. Only applicable in the App Engine flexible environment. |
| 654 | }, |
| 655 | "envVariables": { # Environment variables available to the application.Only returned in GET requests if view=FULL is set. |
| 656 | "a_key": "A String", |
| 657 | }, |
| 658 | "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. |
| 659 | "maxInstances": 42, # Maximum number of instances to create for this version. |
| 660 | "idleTimeout": "A String", # Duration of time after the last request that an instance must wait before the instance is shut down. |
| 661 | }, |
| 662 | "entrypoint": { # The entrypoint for the application. # The entrypoint for the application. |
| 663 | "shell": "A String", # The format should be a shell command that can be fed to bash -c. |
| 664 | }, |
| 665 | "zones": [ # The Google Compute Engine zones that are supported by this version in the App Engine flexible environment. Deprecated. |
| 666 | "A String", |
| 667 | ], |
| 668 | "instanceClass": "A String", # Instance class that is used to run this version. Valid values are: AutomaticScaling: F1, F2, F4, F4_1G ManualScaling or BasicScaling: B1, B2, B4, B8, B4_1GDefaults to F1 for AutomaticScaling and B1 for ManualScaling or BasicScaling. |
| 669 | "readinessCheck": { # Readiness checking configuration for VM instances. Unhealthy instances are removed from traffic rotation. # Configures readiness health checking for instances. Unhealthy instances are not put into the backend traffic rotation.Only returned in GET requests if view=FULL is set. |
| 670 | "appStartTimeout": "A String", # A maximum time limit on application initialization, measured from moment the application successfully replies to a healthcheck until it is ready to serve traffic. |
| 671 | "path": "A String", # The request path. |
| 672 | "successThreshold": 42, # Number of consecutive successful checks required before receiving traffic. |
| 673 | "failureThreshold": 42, # Number of consecutive failed checks required before removing traffic. |
| 674 | "host": "A String", # Host header to send when performing a HTTP Readiness check. Example: "myapp.appspot.com" |
| 675 | "checkInterval": "A String", # Interval between health checks. |
| 676 | "timeout": "A String", # Time before the check is considered failed. |
| 677 | }, |
| 678 | "createdBy": "A String", # Email address of the user who created this version.@OutputOnly |
| 679 | "name": "A String", # Full path to the Version resource in the API. Example: apps/myapp/services/default/versions/v1.@OutputOnly |
| 680 | "vpcAccessConnector": { # VPC access connector specification. # Enables VPC connectivity for standard apps. |
| 681 | "name": "A String", # Full Serverless VPC Access Connector name e.g. /projects/my-project/locations/us-central1/connectors/c1. |
| 682 | }, |
| 683 | "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-". |
| 684 | "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. |
| 685 | "healthCheck": { # Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances. Only applicable for instances in App Engine flexible environment. # Configures health checking for instances. Unhealthy instances are stopped and replaced with new instances. Only applicable in the App Engine flexible environment.Only returned in GET requests if view=FULL is set. |
| 686 | "disableHealthCheck": True or False, # Whether to explicitly disable health checks for this instance. |
| 687 | "unhealthyThreshold": 42, # Number of consecutive failed health checks required before removing traffic. |
| 688 | "checkInterval": "A String", # Interval between health checks. |
| 689 | "healthyThreshold": 42, # Number of consecutive successful health checks required before receiving traffic. |
| 690 | "host": "A String", # Host header to send when performing an HTTP health check. Example: "myapp.appspot.com" |
| 691 | "timeout": "A String", # Time before the health check is considered failed. |
| 692 | "restartThreshold": 42, # Number of consecutive failed health checks required before an instance is restarted. |
| 693 | }, |
| 694 | "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. |
| 695 | { # 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. |
| 696 | "redirectHttpResponseCode": "A String", # 30x code to use when performing redirects for the secure field. Defaults to 302. |
| 697 | "login": "A String", # Level of login required to access this resource. Not supported for Node.js in the App Engine standard environment. |
| 698 | "apiEndpoint": { # Uses Google Cloud Endpoints to handle requests. # Uses API Endpoints to handle requests. |
| 699 | "scriptPath": "A String", # Path to the script from the application root directory. |
| 700 | }, |
| 701 | "securityLevel": "A String", # Security (HTTPS) enforcement for this URL. |
| 702 | "authFailAction": "A String", # Action to take when users access resources that require authentication. Defaults to redirect. |
| 703 | "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. |
| 704 | "script": { # Executes a script to handle the request that matches the URL pattern. # Executes a script to handle the requests that match this URL pattern. Only the auto value is supported for Node.js in the App Engine standard environment, for example "script": "auto". |
| 705 | "scriptPath": "A String", # Path to the script from the application root directory. |
| 706 | }, |
| 707 | "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. |
| 708 | "expiration": "A String", # Time a static file served by this handler should be cached by web proxies and browsers. |
| 709 | "requireMatchingFile": True or False, # Whether this handler should match the request if the file referenced by the handler does not exist. |
| 710 | "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. |
| 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 | "uploadPathRegex": "A String", # Regular expression that matches the file paths for all files that should be referenced by this handler. |
| 713 | "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. |
| 714 | "httpHeaders": { # HTTP headers to use for all responses from these URLs. |
| 715 | "a_key": "A String", |
| 716 | }, |
| 717 | }, |
| 718 | }, |
| 719 | ], |
| 720 | "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. Instances are dynamically created and destroyed as needed in order to handle traffic. |
| 721 | "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. |
| 722 | "standardSchedulerSettings": { # Scheduler settings for standard environment. # Scheduler settings for standard environment. |
| 723 | "maxInstances": 42, # Maximum number of instances to run for this version. Set to zero to disable max_instances configuration. |
| 724 | "targetThroughputUtilization": 3.14, # Target throughput utilization ratio to maintain when scaling |
| 725 | "minInstances": 42, # Minimum number of instances to run for this version. Set to zero to disable min_instances configuration. |
| 726 | "targetCpuUtilization": 3.14, # Target CPU utilization ratio to maintain when scaling. |
| 727 | }, |
| 728 | "cpuUtilization": { # Target scaling by CPU usage. # Target scaling by CPU usage. |
| 729 | "targetUtilization": 3.14, # Target CPU utilization ratio to maintain when scaling. Must be between 0 and 1. |
| 730 | "aggregationWindowLength": "A String", # Period of time over which CPU utilization is calculated. |
| 731 | }, |
| 732 | "minIdleInstances": 42, # Minimum number of idle instances that should be maintained for this version. Only applicable for the default version of a service. |
| 733 | "diskUtilization": { # Target scaling by disk usage. Only applicable in the App Engine flexible environment. # Target scaling by disk usage. |
| 734 | "targetWriteBytesPerSecond": 42, # Target bytes written per second. |
| 735 | "targetReadBytesPerSecond": 42, # Target bytes read per second. |
| 736 | "targetWriteOpsPerSecond": 42, # Target ops written per second. |
| 737 | "targetReadOpsPerSecond": 42, # Target ops read per seconds. |
| 738 | }, |
| 739 | "minPendingLatency": "A String", # Minimum amount of time a request should wait in the pending queue before starting a new instance to handle it. |
| 740 | "coolDownPeriod": "A String", # The time period that the Autoscaler (https://cloud.google.com/compute/docs/autoscaler/) should wait before it starts collecting information from a new instance. This prevents the autoscaler from collecting information when the instance is initializing, during which the collected usage would not be reliable. Only applicable in the App Engine flexible environment. |
| 741 | "networkUtilization": { # Target scaling by network usage. Only applicable in the App Engine flexible environment. # Target scaling by network usage. |
| 742 | "targetReceivedBytesPerSecond": 42, # Target bytes received per second. |
| 743 | "targetSentPacketsPerSecond": 42, # Target packets sent per second. |
| 744 | "targetSentBytesPerSecond": 42, # Target bytes sent per second. |
| 745 | "targetReceivedPacketsPerSecond": 42, # Target packets received per second. |
| 746 | }, |
| 747 | "maxTotalInstances": 42, # Maximum number of instances that should be started to handle requests for this version. |
| 748 | "requestUtilization": { # Target scaling by request utilization. Only applicable in the App Engine flexible environment. # Target scaling by request utilization. |
| 749 | "targetConcurrentRequests": 42, # Target number of concurrent requests. |
| 750 | "targetRequestCountPerSecond": 42, # Target requests per second. |
| 751 | }, |
| 752 | "maxIdleInstances": 42, # Maximum number of idle instances that should be maintained for this version. |
| 753 | "minTotalInstances": 42, # Minimum number of running instances that should be maintained for this version. |
| 754 | "maxPendingLatency": "A String", # Maximum amount of time that a request should wait in the pending queue before starting a new instance to handle it. |
| 755 | }, |
| 756 | "livenessCheck": { # Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances. # Configures liveness health checking for instances. Unhealthy instances are stopped and replaced with new instancesOnly returned in GET requests if view=FULL is set. |
| 757 | "successThreshold": 42, # Number of consecutive successful checks required before considering the VM healthy. |
| 758 | "host": "A String", # Host header to send when performing a HTTP Liveness check. Example: "myapp.appspot.com" |
| 759 | "timeout": "A String", # Time before the check is considered failed. |
| 760 | "checkInterval": "A String", # Interval between health checks. |
| 761 | "initialDelay": "A String", # The initial delay before starting to execute the checks. |
| 762 | "failureThreshold": 42, # Number of consecutive failed checks required before considering the VM unhealthy. |
| 763 | "path": "A String", # The request path. |
| 764 | }, |
| 765 | "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. |
| 766 | "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. |
| 767 | "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" |
| 768 | }, |
| 769 | "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. |
| 770 | "a_key": { # Single source file that is part of the version to be deployed. Each source file that is deployed must be specified separately. |
| 771 | "mimeType": "A String", # The MIME type of the file.Defaults to the value from Google Cloud Storage. |
| 772 | "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//'. |
| 773 | "sha1Sum": "A String", # The SHA1 hash of the file, in hex. |
| 774 | }, |
| 775 | }, |
| 776 | "zip": { # The zip file information for a zip deployment. # The zip file for this deployment, if this is a zip deployment. |
| 777 | "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//'. |
| 778 | "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. |
| 779 | }, |
| 780 | "cloudBuildOptions": { # Options for the build operations performed as a part of the version deployment. Only applicable for App Engine flexible environment when creating a version using source code directly. # Options for any Google Cloud Build builds created as a part of this deployment.These options will only be used if a new build is created, such as when deploying to the App Engine flexible environment using files or zip. |
| 781 | "appYamlPath": "A String", # Path to the yaml file used in deployment, used to determine runtime configuration details.Required for flexible environment builds.See https://cloud.google.com/appengine/docs/standard/python/config/appref for more details. |
| 782 | "cloudBuildTimeout": "A String", # The Cloud Build timeout used as part of any dependent builds performed by version creation. Defaults to 10 minutes. |
| 783 | }, |
| 784 | }, |
| 785 | "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. |
| 786 | "endpointsApiService": { # Cloud Endpoints (https://cloud.google.com/endpoints) configuration. The Endpoints API Service provides tooling for serving Open API and gRPC endpoints via an NGINX proxy. Only valid for App Engine Flexible environment deployments.The fields here refer to the name and configuration ID of a "service" resource in the Service Management API (https://cloud.google.com/service-management/overview). # Cloud Endpoints configuration.If endpoints_api_service is set, the Cloud Endpoints Extensible Service Proxy will be provided to serve the API implemented by the app. |
| 787 | "rolloutStrategy": "A String", # Endpoints rollout strategy. If FIXED, config_id must be specified. If MANAGED, config_id must be omitted. |
| 788 | "configId": "A String", # Endpoints service configuration ID as specified by the Service Management API. For example "2016-09-19r1".By default, the rollout strategy for Endpoints is RolloutStrategy.FIXED. This means that Endpoints starts up with a particular configuration ID. When a new configuration is rolled out, Endpoints must be given the new configuration ID. The config_id field is used to give the configuration ID and is required in this case.Endpoints also has a rollout strategy called RolloutStrategy.MANAGED. When using this, Endpoints fetches the latest configuration and does not need the configuration ID. In this case, config_id must be omitted. |
| 789 | "disableTraceSampling": True or False, # Enable or disable trace sampling. By default, this is set to false for enabled. |
| 790 | "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" |
| 791 | }, |
| 792 | "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//config/appref |
| 793 | "resources": { # Machine resources for a version. # Machine resources for this version. Only applicable in the App Engine flexible environment. |
| 794 | "kmsKeyReference": "A String", # The name of the encryption key that is stored in Google Cloud KMS. Only should be used by Cloud Composer to encrypt the vm disk |
| 795 | "diskGb": 3.14, # Disk size (GB) needed. |
| 796 | "memoryGb": 3.14, # Memory (GB) needed. |
| 797 | "cpu": 3.14, # Number of CPU cores needed. |
| 798 | "volumes": [ # User specified volumes. |
| 799 | { # Volumes mounted within the app container. Only applicable in the App Engine flexible environment. |
| 800 | "sizeGb": 3.14, # Volume size in gigabytes. |
| 801 | "name": "A String", # Unique name for the volume. |
| 802 | "volumeType": "A String", # Underlying volume type, e.g. 'tmpfs'. |
| 803 | }, |
| 804 | ], |
| 805 | }, |
| 806 | "env": "A String", # App Engine execution environment for this version.Defaults to standard. |
| 807 | "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. |
| 808 | "login": "A String", # Level of login required to access this resource. Defaults to optional. |
| 809 | "url": "A String", # URL to serve the endpoint at. |
| 810 | "script": "A String", # Path to the script from the application root directory. |
| 811 | "securityLevel": "A String", # Security (HTTPS) enforcement for this URL. |
| 812 | "authFailAction": "A String", # Action to take when users access resources that require authentication. Defaults to redirect. |
| 813 | }, |
| 814 | "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. Manually scaled versions are sometimes referred to as "backends". |
| 815 | "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. |
| 816 | }, |
| 817 | "threadsafe": True or False, # Whether multiple requests can be dispatched to this version at once. |
| 818 | "libraries": [ # Configuration for third-party Python runtime libraries that are required by the application.Only returned in GET requests if view=FULL is set. |
| 819 | { # Third-party Python runtime library that is required by the application. |
| 820 | "version": "A String", # Version of the library to select, or "latest". |
| 821 | "name": "A String", # Name of the library. Example: "django". |
| 822 | }, |
| 823 | ], |
| 824 | "diskUsageBytes": "A String", # Total size in bytes of all the files that are included in this version and currently hosted on the App Engine disk.@OutputOnly |
| 825 | "errorHandlers": [ # Custom static error pages. Limited to 10KB per page.Only returned in GET requests if view=FULL is set. |
| 826 | { # Custom static error page to be served when an error occurs. |
| 827 | "staticFile": "A String", # Static file content to be served for this error. |
| 828 | "errorCode": "A String", # Error condition this handler applies to. |
| 829 | "mimeType": "A String", # MIME type of file. Defaults to text/html. |
| 830 | }, |
| 831 | ], |
| 832 | "runtime": "A String", # Desired runtime. Example: python27. |
| 833 | "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. |
| 834 | "runtimeMainExecutablePath": "A String", # The path or name of the app's main executable. |
| 835 | "runtimeChannel": "A String", # The channel of the runtime to use. Only available for some runtimes. Defaults to the default channel. |
| 836 | "inboundServices": [ # Before an application can receive email or XMPP messages, the application must be configured to enable the service. |
| 837 | "A String", |
| 838 | ], |
| 839 | "buildEnvVariables": { # Environment variables available to the build environment.Only returned in GET requests if view=FULL is set. |
| 840 | "a_key": "A String", |
| 841 | }, |
| 842 | "versionUrl": "A String", # Serving URL for this version. Example: "https://myversion-dot-myservice-dot-myapp.appspot.com"@OutputOnly |
| 843 | }, |
| Jon Wayne Parrott | 7d5badb | 2016-08-16 12:44:29 -0700 | [diff] [blame] | 844 | ], |
| 845 | }</pre> |
| 846 | </div> |
| 847 | |
| 848 | <div class="method"> |
| 849 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 850 | <pre>Retrieves the next page of results. |
| 851 | |
| 852 | Args: |
| 853 | previous_request: The request for the previous page. (required) |
| 854 | previous_response: The response from the request for the previous page. (required) |
| 855 | |
| 856 | Returns: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 857 | A request object that you can call 'execute()' on to request the next |
| Jon Wayne Parrott | 7d5badb | 2016-08-16 12:44:29 -0700 | [diff] [blame] | 858 | page. Returns None if there are no more items in the collection. |
| 859 | </pre> |
| 860 | </div> |
| 861 | |
| 862 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 863 | <code class="details" id="patch">patch(appsId, servicesId, versionsId, body=None, updateMask=None, x__xgafv=None)</code> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 864 | <pre>Updates the specified Version resource. You can specify the following fields depending on the App Engine environment and type of scaling that the version resource uses:Standard environment instance_class (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.instance_class)automatic scaling in the standard environment: automatic_scaling.min_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling) automatic_scaling.max_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling) automaticScaling.standard_scheduler_settings.max_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#StandardSchedulerSettings) automaticScaling.standard_scheduler_settings.min_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#StandardSchedulerSettings) automaticScaling.standard_scheduler_settings.target_cpu_utilization (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#StandardSchedulerSettings) automaticScaling.standard_scheduler_settings.target_throughput_utilization (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#StandardSchedulerSettings)basic scaling or manual scaling in the standard environment: serving_status (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.serving_status) manual_scaling.instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#manualscaling)Flexible environment serving_status (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.serving_status)automatic scaling in the flexible environment: automatic_scaling.min_total_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling) automatic_scaling.max_total_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling) automatic_scaling.cool_down_period_sec (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling) automatic_scaling.cpu_utilization.target_utilization (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling)manual scaling in the flexible environment: manual_scaling.instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#manualscaling) |
| Jon Wayne Parrott | 7d5badb | 2016-08-16 12:44:29 -0700 | [diff] [blame] | 865 | |
| 866 | Args: |
| Jon Wayne Parrott | 692617a | 2017-01-06 09:58:29 -0800 | [diff] [blame] | 867 | appsId: string, Part of `name`. Name of the resource to update. Example: apps/myapp/services/default/versions/1. (required) |
| Jon Wayne Parrott | 7d5badb | 2016-08-16 12:44:29 -0700 | [diff] [blame] | 868 | servicesId: string, Part of `name`. See documentation of `appsId`. (required) |
| 869 | versionsId: string, Part of `name`. See documentation of `appsId`. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 870 | body: object, The request body. |
| Jon Wayne Parrott | 7d5badb | 2016-08-16 12:44:29 -0700 | [diff] [blame] | 871 | The object takes the form of: |
| 872 | |
| 873 | { # A Version resource is a specific set of source code and configuration files that are deployed into a service. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame^] | 874 | "betaSettings": { # Metadata settings that are supplied to this version to enable beta runtime features. |
| 875 | "a_key": "A String", |
| 876 | }, |
| 877 | "createTime": "A String", # Time that this version was created.@OutputOnly |
| 878 | "vm": True or False, # Whether to deploy this version in a container on a virtual machine. |
| 879 | "network": { # Extra network settings. Only applicable in the App Engine flexible environment. # Extra network settings. Only applicable in the App Engine flexible environment. |
| 880 | "name": "A String", # Google Compute Engine network where the virtual machines are created. Specify the short name, not the resource path.Defaults to default. |
| 881 | "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. If the network that the instance is being created in is a Legacy network, then the IP address is allocated from the IPv4Range. If the network that the instance is being created in is an auto Subnet Mode Network, then only network name should be specified (not the subnetwork_name) and the IP address is created from the IPCidrRange of the subnetwork that exists in that zone for that network. If the network that the instance is being created in is a custom Subnet Mode Network, then the subnetwork_name must be specified and the IP address is created from the IPCidrRange of the subnetwork.If specified, the subnetwork must exist in the same region as the App Engine flexible environment application. |
| 882 | "forwardedPorts": [ # List of ports, or port pairs, to forward from the virtual machine to the application container. Only applicable in the App Engine flexible environment. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 883 | "A String", |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 884 | ], |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame^] | 885 | "sessionAffinity": True or False, # Enable session affinity. Only applicable in the App Engine flexible environment. |
| 886 | "instanceTag": "A String", # Tag to apply to the instance during creation. Only applicable in the App Engine flexible environment. |
| 887 | }, |
| 888 | "envVariables": { # Environment variables available to the application.Only returned in GET requests if view=FULL is set. |
| 889 | "a_key": "A String", |
| 890 | }, |
| 891 | "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. |
| 892 | "maxInstances": 42, # Maximum number of instances to create for this version. |
| 893 | "idleTimeout": "A String", # Duration of time after the last request that an instance must wait before the instance is shut down. |
| 894 | }, |
| 895 | "entrypoint": { # The entrypoint for the application. # The entrypoint for the application. |
| 896 | "shell": "A String", # The format should be a shell command that can be fed to bash -c. |
| 897 | }, |
| 898 | "zones": [ # The Google Compute Engine zones that are supported by this version in the App Engine flexible environment. Deprecated. |
| 899 | "A String", |
| 900 | ], |
| 901 | "instanceClass": "A String", # Instance class that is used to run this version. Valid values are: AutomaticScaling: F1, F2, F4, F4_1G ManualScaling or BasicScaling: B1, B2, B4, B8, B4_1GDefaults to F1 for AutomaticScaling and B1 for ManualScaling or BasicScaling. |
| 902 | "readinessCheck": { # Readiness checking configuration for VM instances. Unhealthy instances are removed from traffic rotation. # Configures readiness health checking for instances. Unhealthy instances are not put into the backend traffic rotation.Only returned in GET requests if view=FULL is set. |
| 903 | "appStartTimeout": "A String", # A maximum time limit on application initialization, measured from moment the application successfully replies to a healthcheck until it is ready to serve traffic. |
| 904 | "path": "A String", # The request path. |
| 905 | "successThreshold": 42, # Number of consecutive successful checks required before receiving traffic. |
| 906 | "failureThreshold": 42, # Number of consecutive failed checks required before removing traffic. |
| 907 | "host": "A String", # Host header to send when performing a HTTP Readiness check. Example: "myapp.appspot.com" |
| 908 | "checkInterval": "A String", # Interval between health checks. |
| 909 | "timeout": "A String", # Time before the check is considered failed. |
| 910 | }, |
| 911 | "createdBy": "A String", # Email address of the user who created this version.@OutputOnly |
| 912 | "name": "A String", # Full path to the Version resource in the API. Example: apps/myapp/services/default/versions/v1.@OutputOnly |
| 913 | "vpcAccessConnector": { # VPC access connector specification. # Enables VPC connectivity for standard apps. |
| 914 | "name": "A String", # Full Serverless VPC Access Connector name e.g. /projects/my-project/locations/us-central1/connectors/c1. |
| 915 | }, |
| 916 | "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-". |
| 917 | "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. |
| 918 | "healthCheck": { # Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances. Only applicable for instances in App Engine flexible environment. # Configures health checking for instances. Unhealthy instances are stopped and replaced with new instances. Only applicable in the App Engine flexible environment.Only returned in GET requests if view=FULL is set. |
| 919 | "disableHealthCheck": True or False, # Whether to explicitly disable health checks for this instance. |
| 920 | "unhealthyThreshold": 42, # Number of consecutive failed health checks required before removing traffic. |
| 921 | "checkInterval": "A String", # Interval between health checks. |
| 922 | "healthyThreshold": 42, # Number of consecutive successful health checks required before receiving traffic. |
| 923 | "host": "A String", # Host header to send when performing an HTTP health check. Example: "myapp.appspot.com" |
| 924 | "timeout": "A String", # Time before the health check is considered failed. |
| 925 | "restartThreshold": 42, # Number of consecutive failed health checks required before an instance is restarted. |
| 926 | }, |
| 927 | "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. |
| 928 | { # 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. |
| 929 | "redirectHttpResponseCode": "A String", # 30x code to use when performing redirects for the secure field. Defaults to 302. |
| 930 | "login": "A String", # Level of login required to access this resource. Not supported for Node.js in the App Engine standard environment. |
| 931 | "apiEndpoint": { # Uses Google Cloud Endpoints to handle requests. # Uses API Endpoints to handle requests. |
| 932 | "scriptPath": "A String", # Path to the script from the application root directory. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 933 | }, |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 934 | "securityLevel": "A String", # Security (HTTPS) enforcement for this URL. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 935 | "authFailAction": "A String", # Action to take when users access resources that require authentication. Defaults to redirect. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame^] | 936 | "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. |
| 937 | "script": { # Executes a script to handle the request that matches the URL pattern. # Executes a script to handle the requests that match this URL pattern. Only the auto value is supported for Node.js in the App Engine standard environment, for example "script": "auto". |
| 938 | "scriptPath": "A String", # Path to the script from the application root directory. |
| 939 | }, |
| 940 | "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. |
| 941 | "expiration": "A String", # Time a static file served by this handler should be cached by web proxies and browsers. |
| 942 | "requireMatchingFile": True or False, # Whether this handler should match the request if the file referenced by the handler does not exist. |
| 943 | "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. |
| 944 | "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. |
| 945 | "uploadPathRegex": "A String", # Regular expression that matches the file paths for all files that should be referenced by this handler. |
| 946 | "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. |
| 947 | "httpHeaders": { # HTTP headers to use for all responses from these URLs. |
| 948 | "a_key": "A String", |
| 949 | }, |
| 950 | }, |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 951 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame^] | 952 | ], |
| 953 | "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. Instances are dynamically created and destroyed as needed in order to handle traffic. |
| 954 | "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. |
| 955 | "standardSchedulerSettings": { # Scheduler settings for standard environment. # Scheduler settings for standard environment. |
| 956 | "maxInstances": 42, # Maximum number of instances to run for this version. Set to zero to disable max_instances configuration. |
| 957 | "targetThroughputUtilization": 3.14, # Target throughput utilization ratio to maintain when scaling |
| 958 | "minInstances": 42, # Minimum number of instances to run for this version. Set to zero to disable min_instances configuration. |
| 959 | "targetCpuUtilization": 3.14, # Target CPU utilization ratio to maintain when scaling. |
| 960 | }, |
| 961 | "cpuUtilization": { # Target scaling by CPU usage. # Target scaling by CPU usage. |
| 962 | "targetUtilization": 3.14, # Target CPU utilization ratio to maintain when scaling. Must be between 0 and 1. |
| 963 | "aggregationWindowLength": "A String", # Period of time over which CPU utilization is calculated. |
| 964 | }, |
| 965 | "minIdleInstances": 42, # Minimum number of idle instances that should be maintained for this version. Only applicable for the default version of a service. |
| 966 | "diskUtilization": { # Target scaling by disk usage. Only applicable in the App Engine flexible environment. # Target scaling by disk usage. |
| 967 | "targetWriteBytesPerSecond": 42, # Target bytes written per second. |
| 968 | "targetReadBytesPerSecond": 42, # Target bytes read per second. |
| 969 | "targetWriteOpsPerSecond": 42, # Target ops written per second. |
| 970 | "targetReadOpsPerSecond": 42, # Target ops read per seconds. |
| 971 | }, |
| 972 | "minPendingLatency": "A String", # Minimum amount of time a request should wait in the pending queue before starting a new instance to handle it. |
| 973 | "coolDownPeriod": "A String", # The time period that the Autoscaler (https://cloud.google.com/compute/docs/autoscaler/) should wait before it starts collecting information from a new instance. This prevents the autoscaler from collecting information when the instance is initializing, during which the collected usage would not be reliable. Only applicable in the App Engine flexible environment. |
| 974 | "networkUtilization": { # Target scaling by network usage. Only applicable in the App Engine flexible environment. # Target scaling by network usage. |
| 975 | "targetReceivedBytesPerSecond": 42, # Target bytes received per second. |
| 976 | "targetSentPacketsPerSecond": 42, # Target packets sent per second. |
| 977 | "targetSentBytesPerSecond": 42, # Target bytes sent per second. |
| 978 | "targetReceivedPacketsPerSecond": 42, # Target packets received per second. |
| 979 | }, |
| 980 | "maxTotalInstances": 42, # Maximum number of instances that should be started to handle requests for this version. |
| 981 | "requestUtilization": { # Target scaling by request utilization. Only applicable in the App Engine flexible environment. # Target scaling by request utilization. |
| 982 | "targetConcurrentRequests": 42, # Target number of concurrent requests. |
| 983 | "targetRequestCountPerSecond": 42, # Target requests per second. |
| 984 | }, |
| 985 | "maxIdleInstances": 42, # Maximum number of idle instances that should be maintained for this version. |
| 986 | "minTotalInstances": 42, # Minimum number of running instances that should be maintained for this version. |
| 987 | "maxPendingLatency": "A String", # Maximum amount of time that a request should wait in the pending queue before starting a new instance to handle it. |
| 988 | }, |
| 989 | "livenessCheck": { # Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances. # Configures liveness health checking for instances. Unhealthy instances are stopped and replaced with new instancesOnly returned in GET requests if view=FULL is set. |
| 990 | "successThreshold": 42, # Number of consecutive successful checks required before considering the VM healthy. |
| 991 | "host": "A String", # Host header to send when performing a HTTP Liveness check. Example: "myapp.appspot.com" |
| 992 | "timeout": "A String", # Time before the check is considered failed. |
| 993 | "checkInterval": "A String", # Interval between health checks. |
| 994 | "initialDelay": "A String", # The initial delay before starting to execute the checks. |
| 995 | "failureThreshold": 42, # Number of consecutive failed checks required before considering the VM unhealthy. |
| 996 | "path": "A String", # The request path. |
| 997 | }, |
| 998 | "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. |
| 999 | "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. |
| 1000 | "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" |
| 1001 | }, |
| 1002 | "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. |
| 1003 | "a_key": { # Single source file that is part of the version to be deployed. Each source file that is deployed must be specified separately. |
| 1004 | "mimeType": "A String", # The MIME type of the file.Defaults to the value from Google Cloud Storage. |
| 1005 | "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//'. |
| 1006 | "sha1Sum": "A String", # The SHA1 hash of the file, in hex. |
| 1007 | }, |
| 1008 | }, |
| 1009 | "zip": { # The zip file information for a zip deployment. # The zip file for this deployment, if this is a zip deployment. |
| 1010 | "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//'. |
| 1011 | "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. |
| 1012 | }, |
| 1013 | "cloudBuildOptions": { # Options for the build operations performed as a part of the version deployment. Only applicable for App Engine flexible environment when creating a version using source code directly. # Options for any Google Cloud Build builds created as a part of this deployment.These options will only be used if a new build is created, such as when deploying to the App Engine flexible environment using files or zip. |
| 1014 | "appYamlPath": "A String", # Path to the yaml file used in deployment, used to determine runtime configuration details.Required for flexible environment builds.See https://cloud.google.com/appengine/docs/standard/python/config/appref for more details. |
| 1015 | "cloudBuildTimeout": "A String", # The Cloud Build timeout used as part of any dependent builds performed by version creation. Defaults to 10 minutes. |
| 1016 | }, |
| 1017 | }, |
| 1018 | "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. |
| 1019 | "endpointsApiService": { # Cloud Endpoints (https://cloud.google.com/endpoints) configuration. The Endpoints API Service provides tooling for serving Open API and gRPC endpoints via an NGINX proxy. Only valid for App Engine Flexible environment deployments.The fields here refer to the name and configuration ID of a "service" resource in the Service Management API (https://cloud.google.com/service-management/overview). # Cloud Endpoints configuration.If endpoints_api_service is set, the Cloud Endpoints Extensible Service Proxy will be provided to serve the API implemented by the app. |
| 1020 | "rolloutStrategy": "A String", # Endpoints rollout strategy. If FIXED, config_id must be specified. If MANAGED, config_id must be omitted. |
| 1021 | "configId": "A String", # Endpoints service configuration ID as specified by the Service Management API. For example "2016-09-19r1".By default, the rollout strategy for Endpoints is RolloutStrategy.FIXED. This means that Endpoints starts up with a particular configuration ID. When a new configuration is rolled out, Endpoints must be given the new configuration ID. The config_id field is used to give the configuration ID and is required in this case.Endpoints also has a rollout strategy called RolloutStrategy.MANAGED. When using this, Endpoints fetches the latest configuration and does not need the configuration ID. In this case, config_id must be omitted. |
| 1022 | "disableTraceSampling": True or False, # Enable or disable trace sampling. By default, this is set to false for enabled. |
| 1023 | "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" |
| 1024 | }, |
| 1025 | "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//config/appref |
| 1026 | "resources": { # Machine resources for a version. # Machine resources for this version. Only applicable in the App Engine flexible environment. |
| 1027 | "kmsKeyReference": "A String", # The name of the encryption key that is stored in Google Cloud KMS. Only should be used by Cloud Composer to encrypt the vm disk |
| 1028 | "diskGb": 3.14, # Disk size (GB) needed. |
| 1029 | "memoryGb": 3.14, # Memory (GB) needed. |
| 1030 | "cpu": 3.14, # Number of CPU cores needed. |
| 1031 | "volumes": [ # User specified volumes. |
| 1032 | { # Volumes mounted within the app container. Only applicable in the App Engine flexible environment. |
| 1033 | "sizeGb": 3.14, # Volume size in gigabytes. |
| 1034 | "name": "A String", # Unique name for the volume. |
| 1035 | "volumeType": "A String", # Underlying volume type, e.g. 'tmpfs'. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 1036 | }, |
| 1037 | ], |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame^] | 1038 | }, |
| 1039 | "env": "A String", # App Engine execution environment for this version.Defaults to standard. |
| 1040 | "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. |
| 1041 | "login": "A String", # Level of login required to access this resource. Defaults to optional. |
| 1042 | "url": "A String", # URL to serve the endpoint at. |
| 1043 | "script": "A String", # Path to the script from the application root directory. |
| 1044 | "securityLevel": "A String", # Security (HTTPS) enforcement for this URL. |
| 1045 | "authFailAction": "A String", # Action to take when users access resources that require authentication. Defaults to redirect. |
| 1046 | }, |
| 1047 | "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. Manually scaled versions are sometimes referred to as "backends". |
| 1048 | "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. |
| 1049 | }, |
| 1050 | "threadsafe": True or False, # Whether multiple requests can be dispatched to this version at once. |
| 1051 | "libraries": [ # Configuration for third-party Python runtime libraries that are required by the application.Only returned in GET requests if view=FULL is set. |
| 1052 | { # Third-party Python runtime library that is required by the application. |
| 1053 | "version": "A String", # Version of the library to select, or "latest". |
| 1054 | "name": "A String", # Name of the library. Example: "django". |
| 1055 | }, |
| 1056 | ], |
| 1057 | "diskUsageBytes": "A String", # Total size in bytes of all the files that are included in this version and currently hosted on the App Engine disk.@OutputOnly |
| 1058 | "errorHandlers": [ # Custom static error pages. Limited to 10KB per page.Only returned in GET requests if view=FULL is set. |
| 1059 | { # Custom static error page to be served when an error occurs. |
| 1060 | "staticFile": "A String", # Static file content to be served for this error. |
| 1061 | "errorCode": "A String", # Error condition this handler applies to. |
| 1062 | "mimeType": "A String", # MIME type of file. Defaults to text/html. |
| 1063 | }, |
| 1064 | ], |
| 1065 | "runtime": "A String", # Desired runtime. Example: python27. |
| 1066 | "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. |
| 1067 | "runtimeMainExecutablePath": "A String", # The path or name of the app's main executable. |
| 1068 | "runtimeChannel": "A String", # The channel of the runtime to use. Only available for some runtimes. Defaults to the default channel. |
| 1069 | "inboundServices": [ # Before an application can receive email or XMPP messages, the application must be configured to enable the service. |
| 1070 | "A String", |
| 1071 | ], |
| 1072 | "buildEnvVariables": { # Environment variables available to the build environment.Only returned in GET requests if view=FULL is set. |
| 1073 | "a_key": "A String", |
| 1074 | }, |
| 1075 | "versionUrl": "A String", # Serving URL for this version. Example: "https://myversion-dot-myservice-dot-myapp.appspot.com"@OutputOnly |
| 1076 | } |
| Jon Wayne Parrott | 7d5badb | 2016-08-16 12:44:29 -0700 | [diff] [blame] | 1077 | |
| 1078 | updateMask: string, Standard field mask for the set of fields to be updated. |
| 1079 | x__xgafv: string, V1 error format. |
| Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 1080 | Allowed values |
| 1081 | 1 - v1 error format |
| 1082 | 2 - v2 error format |
| Jon Wayne Parrott | 7d5badb | 2016-08-16 12:44:29 -0700 | [diff] [blame] | 1083 | |
| 1084 | Returns: |
| 1085 | An object of the form: |
| 1086 | |
| 1087 | { # This resource represents a long-running operation that is the result of a network API call. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame^] | 1088 | "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. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 1089 | "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. |
| 1090 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 1091 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame^] | 1092 | "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should be a resource name ending with operations/{unique_id}. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 1093 | "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. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 1094 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 1095 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1096 | "error": { # The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). Each Status message contains three pieces of data: error code, error message, and error details.You can find out more about this error model and how to work with it in the API Design Guide (https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 1097 | "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. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1098 | "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. |
| Jon Wayne Parrott | 7d5badb | 2016-08-16 12:44:29 -0700 | [diff] [blame] | 1099 | { |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1100 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| Jon Wayne Parrott | 7d5badb | 2016-08-16 12:44:29 -0700 | [diff] [blame] | 1101 | }, |
| 1102 | ], |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 1103 | "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1104 | }, |
| Jon Wayne Parrott | 7d5badb | 2016-08-16 12:44:29 -0700 | [diff] [blame] | 1105 | }</pre> |
| 1106 | </div> |
| 1107 | |
| 1108 | </body></html> |