chore: regens API reference docs (#889)
diff --git a/docs/dyn/appengine_v1.apps.services.versions.html b/docs/dyn/appengine_v1.apps.services.versions.html
index 6b62feb..b2b7332 100644
--- a/docs/dyn/appengine_v1.apps.services.versions.html
+++ b/docs/dyn/appengine_v1.apps.services.versions.html
@@ -80,7 +80,7 @@
<p class="firstline">Returns the instances Resource.</p>
<p class="toc_element">
- <code><a href="#create">create(appsId, servicesId, body, x__xgafv=None)</a></code></p>
+ <code><a href="#create">create(appsId, servicesId, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Deploys code and resource files to a new version.</p>
<p class="toc_element">
<code><a href="#delete">delete(appsId, servicesId, versionsId, x__xgafv=None)</a></code></p>
@@ -95,17 +95,17 @@
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
- <code><a href="#patch">patch(appsId, servicesId, versionsId, body, updateMask=None, x__xgafv=None)</a></code></p>
+ <code><a href="#patch">patch(appsId, servicesId, versionsId, body=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates the specified Version resource. You can specify the following fields depending on the App Engine environment and type of scaling that the version resource uses:Standard environment</p>
<h3>Method Details</h3>
<div class="method">
- <code class="details" id="create">create(appsId, servicesId, body, x__xgafv=None)</code>
+ <code class="details" id="create">create(appsId, servicesId, body=None, x__xgafv=None)</code>
<pre>Deploys code and resource files to a new version.
Args:
appsId: string, Part of `parent`. Name of the parent resource to create this version under. Example: apps/myapp/services/default. (required)
servicesId: string, Part of `parent`. See documentation of `appsId`. (required)
- body: object, The request body. (required)
+ body: object, The request body.
The object takes the form of:
{ # A Version resource is a specific set of source code and configuration files that are deployed into a service.
@@ -134,7 +134,7 @@
"staticFile": "A String", # Static file content to be served for this error.
},
],
- "versionUrl": "A String", # Serving URL for this version. Example: "https://myversion-dot-myservice-dot-myapp.appspot.com"@OutputOnly
+ "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-".
"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.
"checkInterval": "A String", # Interval between health checks.
"host": "A String", # Host header to send when performing a HTTP Readiness check. Example: "myapp.appspot.com"
@@ -148,11 +148,22 @@
"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.
"url": "A String", # URL to serve the endpoint at.
"securityLevel": "A String", # Security (HTTPS) enforcement for this URL.
- "authFailAction": "A String", # Action to take when users access resources that require authentication. Defaults to redirect.
"login": "A String", # Level of login required to access this resource. Defaults to optional.
+ "authFailAction": "A String", # Action to take when users access resources that require authentication. Defaults to redirect.
"script": "A String", # Path to the script from the application root directory.
},
- "threadsafe": True or False, # Whether multiple requests can be dispatched to this version at once.
+ "network": { # Extra network settings. Only applicable in the App Engine flexible environment. # Extra network settings. Only applicable in the App Engine flexible environment.
+ "instanceTag": "A String", # Tag to apply to the instance during creation. Only applicable in the App Engine flexible environment.
+ "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.
+ "A String",
+ ],
+ "sessionAffinity": True or False, # Enable session affinity. Only applicable in the App Engine flexible environment.
+ "name": "A String", # Google Compute Engine network where the virtual machines are created. Specify the short name, not the resource path.Defaults to default.
+ "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.
+ },
"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.
"restartThreshold": 42, # Number of consecutive failed health checks required before an instance is restarted.
"checkInterval": "A String", # Interval between health checks.
@@ -162,7 +173,7 @@
"timeout": "A String", # Time before the health check is considered failed.
"disableHealthCheck": True or False, # Whether to explicitly disable health checks for this instance.
},
- "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-".
+ "versionUrl": "A String", # Serving URL for this version. Example: "https://myversion-dot-myservice-dot-myapp.appspot.com"@OutputOnly
"libraries": [ # Configuration for third-party Python runtime libraries that are required by the application.Only returned in GET requests if view=FULL is set.
{ # Third-party Python runtime library that is required by the application.
"version": "A String", # Version of the library to select, or "latest".
@@ -176,29 +187,29 @@
"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
"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.
"minPendingLatency": "A String", # Minimum amount of time a request should wait in the pending queue before starting a new instance to handle it.
- "cpuUtilization": { # Target scaling by CPU usage. # Target scaling by CPU usage.
- "targetUtilization": 3.14, # Target CPU utilization ratio to maintain when scaling. Must be between 0 and 1.
- "aggregationWindowLength": "A String", # Period of time over which CPU utilization is calculated.
- },
"networkUtilization": { # Target scaling by network usage. Only applicable in the App Engine flexible environment. # Target scaling by network usage.
"targetReceivedPacketsPerSecond": 42, # Target packets received per second.
"targetSentPacketsPerSecond": 42, # Target packets sent per second.
"targetReceivedBytesPerSecond": 42, # Target bytes received per second.
"targetSentBytesPerSecond": 42, # Target bytes sent per second.
},
+ "minIdleInstances": 42, # Minimum number of idle instances that should be maintained for this version. Only applicable for the default version of a service.
+ "maxPendingLatency": "A String", # Maximum amount of time that a request should wait in the pending queue before starting a new instance to handle it.
+ "maxIdleInstances": 42, # Maximum number of idle instances that should be maintained for this version.
"diskUtilization": { # Target scaling by disk usage. Only applicable in the App Engine flexible environment. # Target scaling by disk usage.
"targetReadOpsPerSecond": 42, # Target ops read per seconds.
"targetWriteBytesPerSecond": 42, # Target bytes written per second.
"targetReadBytesPerSecond": 42, # Target bytes read per second.
"targetWriteOpsPerSecond": 42, # Target ops written per second.
},
- "maxPendingLatency": "A String", # Maximum amount of time that a request should wait in the pending queue before starting a new instance to handle it.
- "maxIdleInstances": 42, # Maximum number of idle instances that should be maintained for this version.
- "minIdleInstances": 42, # Minimum number of idle instances that should be maintained for this version. Only applicable for the default version of a service.
"requestUtilization": { # Target scaling by request utilization. Only applicable in the App Engine flexible environment. # Target scaling by request utilization.
"targetConcurrentRequests": 42, # Target number of concurrent requests.
"targetRequestCountPerSecond": 42, # Target requests per second.
},
+ "cpuUtilization": { # Target scaling by CPU usage. # Target scaling by CPU usage.
+ "targetUtilization": 3.14, # Target CPU utilization ratio to maintain when scaling. Must be between 0 and 1.
+ "aggregationWindowLength": "A String", # Period of time over which CPU utilization is calculated.
+ },
"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.
"maxTotalInstances": 42, # Maximum number of instances that should be started to handle requests for this version.
"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.
@@ -243,7 +254,7 @@
"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.
"a_key": { # Single source file that is part of the version to be deployed. Each source file that is deployed must be specified separately.
"mimeType": "A String", # The MIME type of the file.Defaults to the value from Google Cloud Storage.
- "sourceUrl": "A String", # URL source to use to fetch this file. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com/<bucket>/<object>'.
+ "sourceUrl": "A String", # URL source to use to fetch this file. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com/<bucket>/<object>'.
"sha1Sum": "A String", # The SHA1 hash of the file, in hex.
},
},
@@ -256,7 +267,7 @@
},
"zip": { # The zip file information for a zip deployment. # The zip file for this deployment, if this is a zip deployment.
"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.
- "sourceUrl": "A String", # URL of the zip file to deploy from. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com/<bucket>/<object>'.
+ "sourceUrl": "A String", # URL of the zip file to deploy from. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com/<bucket>/<object>'.
},
},
"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.
@@ -269,19 +280,8 @@
"failureThreshold": 42, # Number of consecutive failed checks required before considering the VM unhealthy.
},
"createTime": "A String", # Time that this version was created.@OutputOnly
- "network": { # Extra network settings. Only applicable in the App Engine flexible environment. # Extra network settings. Only applicable in the App Engine flexible environment.
- "instanceTag": "A String", # Tag to apply to the instance during creation. Only applicable in the App Engine flexible environment.
- "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.
- "A String",
- ],
- "sessionAffinity": True or False, # Enable session affinity. Only applicable in the App Engine flexible environment.
- "name": "A String", # Google Compute Engine network where the virtual machines are created. Specify the short name, not the resource path.Defaults to default.
- "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.
- },
- "runtimeApiVersion": "A String", # The version of the API in the given runtime environment. Please see the app.yaml reference for valid values at https://cloud.google.com/appengine/docs/standard/<language>/config/appref
+ "threadsafe": True or False, # Whether multiple requests can be dispatched to this version at once.
+ "runtimeApiVersion": "A String", # The version of the API in the given runtime environment. Please see the app.yaml reference for valid values at https://cloud.google.com/appengine/docs/standard/<language>/config/appref
"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.
"name": "A String", # Full path to the Version resource in the API. Example: apps/myapp/services/default/versions/v1.@OutputOnly
"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.
@@ -294,20 +294,20 @@
},
"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.
"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.
- "httpHeaders": { # HTTP headers to use for all responses from these URLs.
- "a_key": "A String",
- },
+ "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.
"expiration": "A String", # Time a static file served by this handler should be cached by web proxies and browsers.
"requireMatchingFile": True or False, # Whether this handler should match the request if the file referenced by the handler does not exist.
"uploadPathRegex": "A String", # Regular expression that matches the file paths for all files that should be referenced by this handler.
"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.
- "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.
+ "httpHeaders": { # HTTP headers to use for all responses from these URLs.
+ "a_key": "A String",
+ },
},
"apiEndpoint": { # Uses Google Cloud Endpoints to handle requests. # Uses API Endpoints to handle requests.
"scriptPath": "A String", # Path to the script from the application root directory.
},
- "redirectHttpResponseCode": "A String", # 30x code to use when performing redirects for the secure field. Defaults to 302.
"login": "A String", # Level of login required to access this resource. Not supported for Node.js in the App Engine standard environment.
+ "redirectHttpResponseCode": "A String", # 30x code to use when performing redirects for the secure field. Defaults to 302.
},
],
"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.
@@ -323,9 +323,14 @@
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
+ "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.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
"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.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
+ "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.
+ "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}.
"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.
"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.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
@@ -335,11 +340,6 @@
},
],
},
- "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.
- "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.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- "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}.
}</pre>
</div>
@@ -360,9 +360,14 @@
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
+ "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.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
"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.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
+ "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.
+ "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}.
"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.
"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.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
@@ -372,11 +377,6 @@
},
],
},
- "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.
- "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.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- "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}.
}</pre>
</div>
@@ -423,7 +423,7 @@
"staticFile": "A String", # Static file content to be served for this error.
},
],
- "versionUrl": "A String", # Serving URL for this version. Example: "https://myversion-dot-myservice-dot-myapp.appspot.com"@OutputOnly
+ "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-".
"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.
"checkInterval": "A String", # Interval between health checks.
"host": "A String", # Host header to send when performing a HTTP Readiness check. Example: "myapp.appspot.com"
@@ -437,11 +437,22 @@
"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.
"url": "A String", # URL to serve the endpoint at.
"securityLevel": "A String", # Security (HTTPS) enforcement for this URL.
- "authFailAction": "A String", # Action to take when users access resources that require authentication. Defaults to redirect.
"login": "A String", # Level of login required to access this resource. Defaults to optional.
+ "authFailAction": "A String", # Action to take when users access resources that require authentication. Defaults to redirect.
"script": "A String", # Path to the script from the application root directory.
},
- "threadsafe": True or False, # Whether multiple requests can be dispatched to this version at once.
+ "network": { # Extra network settings. Only applicable in the App Engine flexible environment. # Extra network settings. Only applicable in the App Engine flexible environment.
+ "instanceTag": "A String", # Tag to apply to the instance during creation. Only applicable in the App Engine flexible environment.
+ "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.
+ "A String",
+ ],
+ "sessionAffinity": True or False, # Enable session affinity. Only applicable in the App Engine flexible environment.
+ "name": "A String", # Google Compute Engine network where the virtual machines are created. Specify the short name, not the resource path.Defaults to default.
+ "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.
+ },
"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.
"restartThreshold": 42, # Number of consecutive failed health checks required before an instance is restarted.
"checkInterval": "A String", # Interval between health checks.
@@ -451,7 +462,7 @@
"timeout": "A String", # Time before the health check is considered failed.
"disableHealthCheck": True or False, # Whether to explicitly disable health checks for this instance.
},
- "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-".
+ "versionUrl": "A String", # Serving URL for this version. Example: "https://myversion-dot-myservice-dot-myapp.appspot.com"@OutputOnly
"libraries": [ # Configuration for third-party Python runtime libraries that are required by the application.Only returned in GET requests if view=FULL is set.
{ # Third-party Python runtime library that is required by the application.
"version": "A String", # Version of the library to select, or "latest".
@@ -465,29 +476,29 @@
"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
"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.
"minPendingLatency": "A String", # Minimum amount of time a request should wait in the pending queue before starting a new instance to handle it.
- "cpuUtilization": { # Target scaling by CPU usage. # Target scaling by CPU usage.
- "targetUtilization": 3.14, # Target CPU utilization ratio to maintain when scaling. Must be between 0 and 1.
- "aggregationWindowLength": "A String", # Period of time over which CPU utilization is calculated.
- },
"networkUtilization": { # Target scaling by network usage. Only applicable in the App Engine flexible environment. # Target scaling by network usage.
"targetReceivedPacketsPerSecond": 42, # Target packets received per second.
"targetSentPacketsPerSecond": 42, # Target packets sent per second.
"targetReceivedBytesPerSecond": 42, # Target bytes received per second.
"targetSentBytesPerSecond": 42, # Target bytes sent per second.
},
+ "minIdleInstances": 42, # Minimum number of idle instances that should be maintained for this version. Only applicable for the default version of a service.
+ "maxPendingLatency": "A String", # Maximum amount of time that a request should wait in the pending queue before starting a new instance to handle it.
+ "maxIdleInstances": 42, # Maximum number of idle instances that should be maintained for this version.
"diskUtilization": { # Target scaling by disk usage. Only applicable in the App Engine flexible environment. # Target scaling by disk usage.
"targetReadOpsPerSecond": 42, # Target ops read per seconds.
"targetWriteBytesPerSecond": 42, # Target bytes written per second.
"targetReadBytesPerSecond": 42, # Target bytes read per second.
"targetWriteOpsPerSecond": 42, # Target ops written per second.
},
- "maxPendingLatency": "A String", # Maximum amount of time that a request should wait in the pending queue before starting a new instance to handle it.
- "maxIdleInstances": 42, # Maximum number of idle instances that should be maintained for this version.
- "minIdleInstances": 42, # Minimum number of idle instances that should be maintained for this version. Only applicable for the default version of a service.
"requestUtilization": { # Target scaling by request utilization. Only applicable in the App Engine flexible environment. # Target scaling by request utilization.
"targetConcurrentRequests": 42, # Target number of concurrent requests.
"targetRequestCountPerSecond": 42, # Target requests per second.
},
+ "cpuUtilization": { # Target scaling by CPU usage. # Target scaling by CPU usage.
+ "targetUtilization": 3.14, # Target CPU utilization ratio to maintain when scaling. Must be between 0 and 1.
+ "aggregationWindowLength": "A String", # Period of time over which CPU utilization is calculated.
+ },
"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.
"maxTotalInstances": 42, # Maximum number of instances that should be started to handle requests for this version.
"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.
@@ -532,7 +543,7 @@
"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.
"a_key": { # Single source file that is part of the version to be deployed. Each source file that is deployed must be specified separately.
"mimeType": "A String", # The MIME type of the file.Defaults to the value from Google Cloud Storage.
- "sourceUrl": "A String", # URL source to use to fetch this file. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com/<bucket>/<object>'.
+ "sourceUrl": "A String", # URL source to use to fetch this file. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com/<bucket>/<object>'.
"sha1Sum": "A String", # The SHA1 hash of the file, in hex.
},
},
@@ -545,7 +556,7 @@
},
"zip": { # The zip file information for a zip deployment. # The zip file for this deployment, if this is a zip deployment.
"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.
- "sourceUrl": "A String", # URL of the zip file to deploy from. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com/<bucket>/<object>'.
+ "sourceUrl": "A String", # URL of the zip file to deploy from. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com/<bucket>/<object>'.
},
},
"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.
@@ -558,19 +569,8 @@
"failureThreshold": 42, # Number of consecutive failed checks required before considering the VM unhealthy.
},
"createTime": "A String", # Time that this version was created.@OutputOnly
- "network": { # Extra network settings. Only applicable in the App Engine flexible environment. # Extra network settings. Only applicable in the App Engine flexible environment.
- "instanceTag": "A String", # Tag to apply to the instance during creation. Only applicable in the App Engine flexible environment.
- "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.
- "A String",
- ],
- "sessionAffinity": True or False, # Enable session affinity. Only applicable in the App Engine flexible environment.
- "name": "A String", # Google Compute Engine network where the virtual machines are created. Specify the short name, not the resource path.Defaults to default.
- "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.
- },
- "runtimeApiVersion": "A String", # The version of the API in the given runtime environment. Please see the app.yaml reference for valid values at https://cloud.google.com/appengine/docs/standard/<language>/config/appref
+ "threadsafe": True or False, # Whether multiple requests can be dispatched to this version at once.
+ "runtimeApiVersion": "A String", # The version of the API in the given runtime environment. Please see the app.yaml reference for valid values at https://cloud.google.com/appengine/docs/standard/<language>/config/appref
"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.
"name": "A String", # Full path to the Version resource in the API. Example: apps/myapp/services/default/versions/v1.@OutputOnly
"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.
@@ -583,20 +583,20 @@
},
"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.
"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.
- "httpHeaders": { # HTTP headers to use for all responses from these URLs.
- "a_key": "A String",
- },
+ "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.
"expiration": "A String", # Time a static file served by this handler should be cached by web proxies and browsers.
"requireMatchingFile": True or False, # Whether this handler should match the request if the file referenced by the handler does not exist.
"uploadPathRegex": "A String", # Regular expression that matches the file paths for all files that should be referenced by this handler.
"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.
- "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.
+ "httpHeaders": { # HTTP headers to use for all responses from these URLs.
+ "a_key": "A String",
+ },
},
"apiEndpoint": { # Uses Google Cloud Endpoints to handle requests. # Uses API Endpoints to handle requests.
"scriptPath": "A String", # Path to the script from the application root directory.
},
- "redirectHttpResponseCode": "A String", # 30x code to use when performing redirects for the secure field. Defaults to 302.
"login": "A String", # Level of login required to access this resource. Not supported for Node.js in the App Engine standard environment.
+ "redirectHttpResponseCode": "A String", # 30x code to use when performing redirects for the secure field. Defaults to 302.
},
],
"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.
@@ -651,7 +651,7 @@
"staticFile": "A String", # Static file content to be served for this error.
},
],
- "versionUrl": "A String", # Serving URL for this version. Example: "https://myversion-dot-myservice-dot-myapp.appspot.com"@OutputOnly
+ "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-".
"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.
"checkInterval": "A String", # Interval between health checks.
"host": "A String", # Host header to send when performing a HTTP Readiness check. Example: "myapp.appspot.com"
@@ -665,11 +665,22 @@
"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.
"url": "A String", # URL to serve the endpoint at.
"securityLevel": "A String", # Security (HTTPS) enforcement for this URL.
- "authFailAction": "A String", # Action to take when users access resources that require authentication. Defaults to redirect.
"login": "A String", # Level of login required to access this resource. Defaults to optional.
+ "authFailAction": "A String", # Action to take when users access resources that require authentication. Defaults to redirect.
"script": "A String", # Path to the script from the application root directory.
},
- "threadsafe": True or False, # Whether multiple requests can be dispatched to this version at once.
+ "network": { # Extra network settings. Only applicable in the App Engine flexible environment. # Extra network settings. Only applicable in the App Engine flexible environment.
+ "instanceTag": "A String", # Tag to apply to the instance during creation. Only applicable in the App Engine flexible environment.
+ "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.
+ "A String",
+ ],
+ "sessionAffinity": True or False, # Enable session affinity. Only applicable in the App Engine flexible environment.
+ "name": "A String", # Google Compute Engine network where the virtual machines are created. Specify the short name, not the resource path.Defaults to default.
+ "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.
+ },
"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.
"restartThreshold": 42, # Number of consecutive failed health checks required before an instance is restarted.
"checkInterval": "A String", # Interval between health checks.
@@ -679,7 +690,7 @@
"timeout": "A String", # Time before the health check is considered failed.
"disableHealthCheck": True or False, # Whether to explicitly disable health checks for this instance.
},
- "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-".
+ "versionUrl": "A String", # Serving URL for this version. Example: "https://myversion-dot-myservice-dot-myapp.appspot.com"@OutputOnly
"libraries": [ # Configuration for third-party Python runtime libraries that are required by the application.Only returned in GET requests if view=FULL is set.
{ # Third-party Python runtime library that is required by the application.
"version": "A String", # Version of the library to select, or "latest".
@@ -693,29 +704,29 @@
"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
"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.
"minPendingLatency": "A String", # Minimum amount of time a request should wait in the pending queue before starting a new instance to handle it.
- "cpuUtilization": { # Target scaling by CPU usage. # Target scaling by CPU usage.
- "targetUtilization": 3.14, # Target CPU utilization ratio to maintain when scaling. Must be between 0 and 1.
- "aggregationWindowLength": "A String", # Period of time over which CPU utilization is calculated.
- },
"networkUtilization": { # Target scaling by network usage. Only applicable in the App Engine flexible environment. # Target scaling by network usage.
"targetReceivedPacketsPerSecond": 42, # Target packets received per second.
"targetSentPacketsPerSecond": 42, # Target packets sent per second.
"targetReceivedBytesPerSecond": 42, # Target bytes received per second.
"targetSentBytesPerSecond": 42, # Target bytes sent per second.
},
+ "minIdleInstances": 42, # Minimum number of idle instances that should be maintained for this version. Only applicable for the default version of a service.
+ "maxPendingLatency": "A String", # Maximum amount of time that a request should wait in the pending queue before starting a new instance to handle it.
+ "maxIdleInstances": 42, # Maximum number of idle instances that should be maintained for this version.
"diskUtilization": { # Target scaling by disk usage. Only applicable in the App Engine flexible environment. # Target scaling by disk usage.
"targetReadOpsPerSecond": 42, # Target ops read per seconds.
"targetWriteBytesPerSecond": 42, # Target bytes written per second.
"targetReadBytesPerSecond": 42, # Target bytes read per second.
"targetWriteOpsPerSecond": 42, # Target ops written per second.
},
- "maxPendingLatency": "A String", # Maximum amount of time that a request should wait in the pending queue before starting a new instance to handle it.
- "maxIdleInstances": 42, # Maximum number of idle instances that should be maintained for this version.
- "minIdleInstances": 42, # Minimum number of idle instances that should be maintained for this version. Only applicable for the default version of a service.
"requestUtilization": { # Target scaling by request utilization. Only applicable in the App Engine flexible environment. # Target scaling by request utilization.
"targetConcurrentRequests": 42, # Target number of concurrent requests.
"targetRequestCountPerSecond": 42, # Target requests per second.
},
+ "cpuUtilization": { # Target scaling by CPU usage. # Target scaling by CPU usage.
+ "targetUtilization": 3.14, # Target CPU utilization ratio to maintain when scaling. Must be between 0 and 1.
+ "aggregationWindowLength": "A String", # Period of time over which CPU utilization is calculated.
+ },
"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.
"maxTotalInstances": 42, # Maximum number of instances that should be started to handle requests for this version.
"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.
@@ -760,7 +771,7 @@
"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.
"a_key": { # Single source file that is part of the version to be deployed. Each source file that is deployed must be specified separately.
"mimeType": "A String", # The MIME type of the file.Defaults to the value from Google Cloud Storage.
- "sourceUrl": "A String", # URL source to use to fetch this file. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com/<bucket>/<object>'.
+ "sourceUrl": "A String", # URL source to use to fetch this file. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com/<bucket>/<object>'.
"sha1Sum": "A String", # The SHA1 hash of the file, in hex.
},
},
@@ -773,7 +784,7 @@
},
"zip": { # The zip file information for a zip deployment. # The zip file for this deployment, if this is a zip deployment.
"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.
- "sourceUrl": "A String", # URL of the zip file to deploy from. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com/<bucket>/<object>'.
+ "sourceUrl": "A String", # URL of the zip file to deploy from. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com/<bucket>/<object>'.
},
},
"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.
@@ -786,19 +797,8 @@
"failureThreshold": 42, # Number of consecutive failed checks required before considering the VM unhealthy.
},
"createTime": "A String", # Time that this version was created.@OutputOnly
- "network": { # Extra network settings. Only applicable in the App Engine flexible environment. # Extra network settings. Only applicable in the App Engine flexible environment.
- "instanceTag": "A String", # Tag to apply to the instance during creation. Only applicable in the App Engine flexible environment.
- "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.
- "A String",
- ],
- "sessionAffinity": True or False, # Enable session affinity. Only applicable in the App Engine flexible environment.
- "name": "A String", # Google Compute Engine network where the virtual machines are created. Specify the short name, not the resource path.Defaults to default.
- "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.
- },
- "runtimeApiVersion": "A String", # The version of the API in the given runtime environment. Please see the app.yaml reference for valid values at https://cloud.google.com/appengine/docs/standard/<language>/config/appref
+ "threadsafe": True or False, # Whether multiple requests can be dispatched to this version at once.
+ "runtimeApiVersion": "A String", # The version of the API in the given runtime environment. Please see the app.yaml reference for valid values at https://cloud.google.com/appengine/docs/standard/<language>/config/appref
"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.
"name": "A String", # Full path to the Version resource in the API. Example: apps/myapp/services/default/versions/v1.@OutputOnly
"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.
@@ -811,20 +811,20 @@
},
"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.
"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.
- "httpHeaders": { # HTTP headers to use for all responses from these URLs.
- "a_key": "A String",
- },
+ "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.
"expiration": "A String", # Time a static file served by this handler should be cached by web proxies and browsers.
"requireMatchingFile": True or False, # Whether this handler should match the request if the file referenced by the handler does not exist.
"uploadPathRegex": "A String", # Regular expression that matches the file paths for all files that should be referenced by this handler.
"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.
- "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.
+ "httpHeaders": { # HTTP headers to use for all responses from these URLs.
+ "a_key": "A String",
+ },
},
"apiEndpoint": { # Uses Google Cloud Endpoints to handle requests. # Uses API Endpoints to handle requests.
"scriptPath": "A String", # Path to the script from the application root directory.
},
- "redirectHttpResponseCode": "A String", # 30x code to use when performing redirects for the secure field. Defaults to 302.
"login": "A String", # Level of login required to access this resource. Not supported for Node.js in the App Engine standard environment.
+ "redirectHttpResponseCode": "A String", # 30x code to use when performing redirects for the secure field. Defaults to 302.
},
],
"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.
@@ -849,7 +849,7 @@
</div>
<div class="method">
- <code class="details" id="patch">patch(appsId, servicesId, versionsId, body, updateMask=None, x__xgafv=None)</code>
+ <code class="details" id="patch">patch(appsId, servicesId, versionsId, body=None, updateMask=None, x__xgafv=None)</code>
<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)
@@ -869,7 +869,7 @@
appsId: string, Part of `name`. Name of the resource to update. Example: apps/myapp/services/default/versions/1. (required)
servicesId: string, Part of `name`. See documentation of `appsId`. (required)
versionsId: string, Part of `name`. See documentation of `appsId`. (required)
- body: object, The request body. (required)
+ body: object, The request body.
The object takes the form of:
{ # A Version resource is a specific set of source code and configuration files that are deployed into a service.
@@ -898,7 +898,7 @@
"staticFile": "A String", # Static file content to be served for this error.
},
],
- "versionUrl": "A String", # Serving URL for this version. Example: "https://myversion-dot-myservice-dot-myapp.appspot.com"@OutputOnly
+ "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-".
"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.
"checkInterval": "A String", # Interval between health checks.
"host": "A String", # Host header to send when performing a HTTP Readiness check. Example: "myapp.appspot.com"
@@ -912,11 +912,22 @@
"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.
"url": "A String", # URL to serve the endpoint at.
"securityLevel": "A String", # Security (HTTPS) enforcement for this URL.
- "authFailAction": "A String", # Action to take when users access resources that require authentication. Defaults to redirect.
"login": "A String", # Level of login required to access this resource. Defaults to optional.
+ "authFailAction": "A String", # Action to take when users access resources that require authentication. Defaults to redirect.
"script": "A String", # Path to the script from the application root directory.
},
- "threadsafe": True or False, # Whether multiple requests can be dispatched to this version at once.
+ "network": { # Extra network settings. Only applicable in the App Engine flexible environment. # Extra network settings. Only applicable in the App Engine flexible environment.
+ "instanceTag": "A String", # Tag to apply to the instance during creation. Only applicable in the App Engine flexible environment.
+ "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.
+ "A String",
+ ],
+ "sessionAffinity": True or False, # Enable session affinity. Only applicable in the App Engine flexible environment.
+ "name": "A String", # Google Compute Engine network where the virtual machines are created. Specify the short name, not the resource path.Defaults to default.
+ "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.
+ },
"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.
"restartThreshold": 42, # Number of consecutive failed health checks required before an instance is restarted.
"checkInterval": "A String", # Interval between health checks.
@@ -926,7 +937,7 @@
"timeout": "A String", # Time before the health check is considered failed.
"disableHealthCheck": True or False, # Whether to explicitly disable health checks for this instance.
},
- "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-".
+ "versionUrl": "A String", # Serving URL for this version. Example: "https://myversion-dot-myservice-dot-myapp.appspot.com"@OutputOnly
"libraries": [ # Configuration for third-party Python runtime libraries that are required by the application.Only returned in GET requests if view=FULL is set.
{ # Third-party Python runtime library that is required by the application.
"version": "A String", # Version of the library to select, or "latest".
@@ -940,29 +951,29 @@
"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
"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.
"minPendingLatency": "A String", # Minimum amount of time a request should wait in the pending queue before starting a new instance to handle it.
- "cpuUtilization": { # Target scaling by CPU usage. # Target scaling by CPU usage.
- "targetUtilization": 3.14, # Target CPU utilization ratio to maintain when scaling. Must be between 0 and 1.
- "aggregationWindowLength": "A String", # Period of time over which CPU utilization is calculated.
- },
"networkUtilization": { # Target scaling by network usage. Only applicable in the App Engine flexible environment. # Target scaling by network usage.
"targetReceivedPacketsPerSecond": 42, # Target packets received per second.
"targetSentPacketsPerSecond": 42, # Target packets sent per second.
"targetReceivedBytesPerSecond": 42, # Target bytes received per second.
"targetSentBytesPerSecond": 42, # Target bytes sent per second.
},
+ "minIdleInstances": 42, # Minimum number of idle instances that should be maintained for this version. Only applicable for the default version of a service.
+ "maxPendingLatency": "A String", # Maximum amount of time that a request should wait in the pending queue before starting a new instance to handle it.
+ "maxIdleInstances": 42, # Maximum number of idle instances that should be maintained for this version.
"diskUtilization": { # Target scaling by disk usage. Only applicable in the App Engine flexible environment. # Target scaling by disk usage.
"targetReadOpsPerSecond": 42, # Target ops read per seconds.
"targetWriteBytesPerSecond": 42, # Target bytes written per second.
"targetReadBytesPerSecond": 42, # Target bytes read per second.
"targetWriteOpsPerSecond": 42, # Target ops written per second.
},
- "maxPendingLatency": "A String", # Maximum amount of time that a request should wait in the pending queue before starting a new instance to handle it.
- "maxIdleInstances": 42, # Maximum number of idle instances that should be maintained for this version.
- "minIdleInstances": 42, # Minimum number of idle instances that should be maintained for this version. Only applicable for the default version of a service.
"requestUtilization": { # Target scaling by request utilization. Only applicable in the App Engine flexible environment. # Target scaling by request utilization.
"targetConcurrentRequests": 42, # Target number of concurrent requests.
"targetRequestCountPerSecond": 42, # Target requests per second.
},
+ "cpuUtilization": { # Target scaling by CPU usage. # Target scaling by CPU usage.
+ "targetUtilization": 3.14, # Target CPU utilization ratio to maintain when scaling. Must be between 0 and 1.
+ "aggregationWindowLength": "A String", # Period of time over which CPU utilization is calculated.
+ },
"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.
"maxTotalInstances": 42, # Maximum number of instances that should be started to handle requests for this version.
"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.
@@ -1007,7 +1018,7 @@
"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.
"a_key": { # Single source file that is part of the version to be deployed. Each source file that is deployed must be specified separately.
"mimeType": "A String", # The MIME type of the file.Defaults to the value from Google Cloud Storage.
- "sourceUrl": "A String", # URL source to use to fetch this file. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com/<bucket>/<object>'.
+ "sourceUrl": "A String", # URL source to use to fetch this file. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com/<bucket>/<object>'.
"sha1Sum": "A String", # The SHA1 hash of the file, in hex.
},
},
@@ -1020,7 +1031,7 @@
},
"zip": { # The zip file information for a zip deployment. # The zip file for this deployment, if this is a zip deployment.
"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.
- "sourceUrl": "A String", # URL of the zip file to deploy from. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com/<bucket>/<object>'.
+ "sourceUrl": "A String", # URL of the zip file to deploy from. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com/<bucket>/<object>'.
},
},
"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.
@@ -1033,19 +1044,8 @@
"failureThreshold": 42, # Number of consecutive failed checks required before considering the VM unhealthy.
},
"createTime": "A String", # Time that this version was created.@OutputOnly
- "network": { # Extra network settings. Only applicable in the App Engine flexible environment. # Extra network settings. Only applicable in the App Engine flexible environment.
- "instanceTag": "A String", # Tag to apply to the instance during creation. Only applicable in the App Engine flexible environment.
- "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.
- "A String",
- ],
- "sessionAffinity": True or False, # Enable session affinity. Only applicable in the App Engine flexible environment.
- "name": "A String", # Google Compute Engine network where the virtual machines are created. Specify the short name, not the resource path.Defaults to default.
- "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.
- },
- "runtimeApiVersion": "A String", # The version of the API in the given runtime environment. Please see the app.yaml reference for valid values at https://cloud.google.com/appengine/docs/standard/<language>/config/appref
+ "threadsafe": True or False, # Whether multiple requests can be dispatched to this version at once.
+ "runtimeApiVersion": "A String", # The version of the API in the given runtime environment. Please see the app.yaml reference for valid values at https://cloud.google.com/appengine/docs/standard/<language>/config/appref
"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.
"name": "A String", # Full path to the Version resource in the API. Example: apps/myapp/services/default/versions/v1.@OutputOnly
"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.
@@ -1058,20 +1058,20 @@
},
"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.
"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.
- "httpHeaders": { # HTTP headers to use for all responses from these URLs.
- "a_key": "A String",
- },
+ "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.
"expiration": "A String", # Time a static file served by this handler should be cached by web proxies and browsers.
"requireMatchingFile": True or False, # Whether this handler should match the request if the file referenced by the handler does not exist.
"uploadPathRegex": "A String", # Regular expression that matches the file paths for all files that should be referenced by this handler.
"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.
- "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.
+ "httpHeaders": { # HTTP headers to use for all responses from these URLs.
+ "a_key": "A String",
+ },
},
"apiEndpoint": { # Uses Google Cloud Endpoints to handle requests. # Uses API Endpoints to handle requests.
"scriptPath": "A String", # Path to the script from the application root directory.
},
- "redirectHttpResponseCode": "A String", # 30x code to use when performing redirects for the secure field. Defaults to 302.
"login": "A String", # Level of login required to access this resource. Not supported for Node.js in the App Engine standard environment.
+ "redirectHttpResponseCode": "A String", # 30x code to use when performing redirects for the secure field. Defaults to 302.
},
],
"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.
@@ -1088,9 +1088,14 @@
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
+ "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.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
"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.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
+ "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.
+ "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}.
"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.
"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.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
@@ -1100,11 +1105,6 @@
},
],
},
- "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.
- "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.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- "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}.
}</pre>
</div>