Regen docs (#373)
diff --git a/docs/dyn/appengine_v1beta.apps.services.versions.html b/docs/dyn/appengine_v1beta.apps.services.versions.html
index f011702..e60d96b 100644
--- a/docs/dyn/appengine_v1beta.apps.services.versions.html
+++ b/docs/dyn/appengine_v1beta.apps.services.versions.html
@@ -89,14 +89,14 @@
<code><a href="#get">get(appsId, servicesId, versionsId, x__xgafv=None, view=None)</a></code></p>
<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>
<p class="toc_element">
- <code><a href="#list">list(appsId, servicesId, pageSize=None, pageToken=None, x__xgafv=None, view=None)</a></code></p>
+ <code><a href="#list">list(appsId, servicesId, pageSize=None, x__xgafv=None, pageToken=None, view=None)</a></code></p>
<p class="firstline">Lists the versions of a service.</p>
<p class="toc_element">
<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>
-<p class="firstline">Updates the specified Version resource. You can specify the following fields depending on the App Engine environment and type of scaling that the version resource uses:</p>
+<p class="firstline">Updates the specified Version resource. You can specify the following fields depending on the App Engine environment and type of scaling that the version resource uses: serving_status (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.serving_status): For Version resources that use basic scaling, manual scaling, or run in the App Engine flexible environment. instance_class (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.instance_class): For Version resources that run in the App Engine standard environment. automatic_scaling.min_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine standard environment. automatic_scaling.max_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine standard environment.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="create">create(appsId, servicesId, body, x__xgafv=None)</code>
@@ -113,15 +113,15 @@
"configId": "A String", # Endpoints service configuration id as specified by the Service Management API. For example "2016-09-19r1"
"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"
},
- "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/v1beta/apps.services.versions#staticfileshandler) does not specify its own expiration time.Only returned in GET requests if view=FULL is set.
"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.
"idleTimeout": "A String", # Duration of time after the last request that an instance must wait before the instance is shut down.
"maxInstances": 42, # Maximum number of instances to create for this version.
},
+ "betaSettings": { # Metadata settings that are supplied to this version to enable beta runtime features.
+ "a_key": "A String",
+ },
"vm": True or False, # Whether to deploy this version in a container on a virtual machine.
- "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.
+ "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.
"errorHandlers": [ # Custom static error pages. Limited to 10KB per page.Only returned in GET requests if view=FULL is set.
{ # Custom static error page to be served when an error occurs.
"errorCode": "A String", # Error condition this handler applies to.
@@ -145,17 +145,7 @@
"login": "A String", # Level of login required to access this resource. Defaults to optional.
"script": "A String", # Path to the script from the application root directory.
},
- "network": { # Extra network settings. Only applicable for VM runtimes. # Extra network settings. Only applicable for VM runtimes.
- "instanceTag": "A String", # Tag to apply to the VM instance during creation.
- "forwardedPorts": [ # List of ports, or port pairs, to forward from the virtual machine to the application container.
- "A String",
- ],
- "name": "A String", # Google Cloud Platform 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 the VM instance is being created in is a Legacy network, then the IP address is allocated from the IPv4Range.
- # If the network the VM instance is being created in is an auto Subnet Mode Network, then only network name should be specified (not the subnetwork_name) and the IP address is created from the IPCidrRange of the subnetwork that exists in that zone for that network.
- # If the network the VM instance is being created in is a custom Subnet Mode Network, then the subnetwork_name must be specified and the IP address is created from the IPCidrRange of the subnetwork.If specified, the subnetwork must exist in the same region as the Flex app.
- },
+ "threadsafe": True or False, # Whether multiple requests can be dispatched to this version at once.
"healthCheck": { # Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances. Only applicable for instances in App Engine flexible environment. # Configures health checking for VM instances. Unhealthy instances are stopped and replaced with new instances. Only applicable for VM runtimes.Only returned in GET requests if view=FULL is set.
"restartThreshold": 42, # Number of consecutive failed health checks required before an instance is restarted.
"checkInterval": "A String", # Interval between health checks.
@@ -165,6 +155,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.
},
+ "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/v1beta/apps.services.versions#staticfileshandler) does not specify its own expiration time.Only returned in GET requests if view=FULL is set.
"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.
@@ -175,10 +166,7 @@
"env": "A String", # App Engine execution environment for this version.Defaults to standard.
"diskUsageBytes": "A String", # Total size in bytes of all the files that are included in this version and curerntly hosted on the App Engine disk.@OutputOnly
"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.
- "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.
- },
+ "minPendingLatency": "A String", # Minimum amount of time a request should wait in the pending queue before starting a new instance to handle it.
"networkUtilization": { # Target scaling by network usage. Only applicable for VM runtimes. # Target scaling by network usage.
"targetReceivedPacketsPerSecond": 42, # Target packets received per second.
"targetSentPacketsPerSecond": 42, # Target packets sent per second.
@@ -202,7 +190,10 @@
"maxTotalInstances": 42, # Maximum number of instances that should be started to handle requests.
"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.
"minTotalInstances": 42, # Minimum number of instances that should be maintained for this version.
- "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.
+ },
},
"envVariables": { # Environment variables available to the application.Only returned in GET requests if view=FULL is set.
"a_key": "A String",
@@ -225,15 +216,12 @@
"inboundServices": [ # Before an application can receive email or XMPP messages, the application must be configured to enable the service.
"A String",
],
- "betaSettings": { # Metadata settings that are supplied to this version to enable beta runtime features.
- "a_key": "A String",
- },
"createdBy": "A String", # Email address of the user who created this version.@OutputOnly
"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.
"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//'.
"sha1Sum": "A String", # The SHA1 hash of the file, in hex.
},
},
@@ -242,9 +230,19 @@
},
"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//'.
},
},
+ "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.
+ "createTime": "A String", # Time that this version was created.@OutputOnly
+ "network": { # Extra network settings. Only applicable for VM runtimes. # Extra network settings. Only applicable for VM runtimes.
+ "instanceTag": "A String", # Tag to apply to the VM instance during creation.
+ "forwardedPorts": [ # List of ports, or port pairs, to forward from the virtual machine to the application container.
+ "A String",
+ ],
+ "name": "A String", # Google Cloud Platform 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 the VM instance is being created in is a Legacy network, then the IP address is allocated from the IPv4Range. If the network the VM instance is being created in is an auto Subnet Mode Network, then only network name should be specified (not the subnetwork_name) and the IP address is created from the IPCidrRange of the subnetwork that exists in that zone for that network. If the network the VM instance is being created in is a custom Subnet Mode Network, then the subnetwork_name must be specified and the IP address is created from the IPCidrRange of the subnetwork.If specified, the subnetwork must exist in the same region as the Flex app.
+ },
"livenessCheck": { # Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances. # Configures liveness health checking for VM instances. Unhealthy instances are stopped and replaced with new instancesOnly returned in GET requests if view=FULL is set.
"checkInterval": "A String", # Interval between health checks.
"initialDelay": "A String", # The initial delay before starting to execute the checks.
@@ -254,9 +252,6 @@
"timeout": "A String", # Time before the check is considered failed.
"path": "A String", # The request path.
},
- "createTime": "A String", # Time that this version was created.@OutputOnly
- "threadsafe": True or False, # Whether multiple requests can be dispatched to this version at once.
- "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.
{ # 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.
@@ -268,20 +263,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.
+ "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.
"httpHeaders": { # HTTP headers to use for all responses from these URLs.
"a_key": "A String",
},
- "expiration": "A String", # Time a static file served by this handler should be cached by web proxies and browsers.
- "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.
- "uploadPathRegex": "A String", # Regular expression that matches the file paths for all files that should be referenced by this handler.
- "requireMatchingFile": True or False, # Whether this handler should match the request if the file referenced by the handler does not exist.
- "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.
},
"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.
+ "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.
@@ -289,22 +284,15 @@
}
x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
- "error": { # The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). The error model is designed to be: # The error result of the operation in case of failure or cancellation.
- # Simple to use and understand for most users
- # Flexible enough to meet unexpected needsOverviewThe Status message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers understand and resolve the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package google.rpc which can be used for common error conditions.Language mappingThe Status message is the logical representation of the error model, but it is not necessarily the actual wire format. When the Status message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C.Other usesThe error model and the Status message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments.Example uses of this error model include:
- # Partial errors. If a service needs to return partial errors to the client, it may embed the Status in the normal response to indicate the partial errors.
- # Workflow errors. A typical workflow has multiple steps. Each step may have a Status message for error reporting purpose.
- # Batch operations. If a client uses batch request and batch response, the Status message should be used directly inside batch response, one for each error sub-response.
- # Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the Status message.
- # Logging. If some API errors are stored in logs, the message Status could be used directly after any stripping needed for security/privacy reasons.
+ "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.
+ },
+ "error": { # The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). The error model is designed to be: Simple to use and understand for most users Flexible enough to meet unexpected needsOverviewThe Status message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers understand and resolve the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package google.rpc which can be used for common error conditions.Language mappingThe Status message is the logical representation of the error model, but it is not necessarily the actual wire format. When the Status message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C.Other usesThe error model and the Status message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments.Example uses of this error model include: Partial errors. If a service needs to return partial errors to the client, it may embed the Status in the normal response to indicate the partial errors. Workflow errors. A typical workflow has multiple steps. Each step may have a Status message for error reporting purpose. Batch operations. If a client uses batch request and batch response, the Status message should be used directly inside batch response, one for each error sub-response. Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the Status message. Logging. If some API errors are stored in logs, the message Status could be used directly after any stripping needed for security/privacy reasons. # The error result of the operation in case of failure 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.
"details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
@@ -314,9 +302,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 have the format of operations/some/unique/name.
"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.
@@ -333,22 +318,15 @@
servicesId: string, Part of `name`. See documentation of `appsId`. (required)
versionsId: string, Part of `name`. See documentation of `appsId`. (required)
x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
- "error": { # The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). The error model is designed to be: # The error result of the operation in case of failure or cancellation.
- # Simple to use and understand for most users
- # Flexible enough to meet unexpected needsOverviewThe Status message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers understand and resolve the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package google.rpc which can be used for common error conditions.Language mappingThe Status message is the logical representation of the error model, but it is not necessarily the actual wire format. When the Status message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C.Other usesThe error model and the Status message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments.Example uses of this error model include:
- # Partial errors. If a service needs to return partial errors to the client, it may embed the Status in the normal response to indicate the partial errors.
- # Workflow errors. A typical workflow has multiple steps. Each step may have a Status message for error reporting purpose.
- # Batch operations. If a client uses batch request and batch response, the Status message should be used directly inside batch response, one for each error sub-response.
- # Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the Status message.
- # Logging. If some API errors are stored in logs, the message Status could be used directly after any stripping needed for security/privacy reasons.
+ "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.
+ },
+ "error": { # The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). The error model is designed to be: Simple to use and understand for most users Flexible enough to meet unexpected needsOverviewThe Status message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers understand and resolve the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package google.rpc which can be used for common error conditions.Language mappingThe Status message is the logical representation of the error model, but it is not necessarily the actual wire format. When the Status message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C.Other usesThe error model and the Status message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments.Example uses of this error model include: Partial errors. If a service needs to return partial errors to the client, it may embed the Status in the normal response to indicate the partial errors. Workflow errors. A typical workflow has multiple steps. Each step may have a Status message for error reporting purpose. Batch operations. If a client uses batch request and batch response, the Status message should be used directly inside batch response, one for each error sub-response. Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the Status message. Logging. If some API errors are stored in logs, the message Status could be used directly after any stripping needed for security/privacy reasons. # The error result of the operation in case of failure 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.
"details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
@@ -358,9 +336,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 have the format of operations/some/unique/name.
"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.
@@ -377,9 +352,6 @@
servicesId: string, Part of `name`. See documentation of `appsId`. (required)
versionsId: string, Part of `name`. See documentation of `appsId`. (required)
x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
view: string, Controls the set of fields returned in the Get response.
Returns:
@@ -390,15 +362,15 @@
"configId": "A String", # Endpoints service configuration id as specified by the Service Management API. For example "2016-09-19r1"
"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"
},
- "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/v1beta/apps.services.versions#staticfileshandler) does not specify its own expiration time.Only returned in GET requests if view=FULL is set.
"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.
"idleTimeout": "A String", # Duration of time after the last request that an instance must wait before the instance is shut down.
"maxInstances": 42, # Maximum number of instances to create for this version.
},
+ "betaSettings": { # Metadata settings that are supplied to this version to enable beta runtime features.
+ "a_key": "A String",
+ },
"vm": True or False, # Whether to deploy this version in a container on a virtual machine.
- "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.
+ "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.
"errorHandlers": [ # Custom static error pages. Limited to 10KB per page.Only returned in GET requests if view=FULL is set.
{ # Custom static error page to be served when an error occurs.
"errorCode": "A String", # Error condition this handler applies to.
@@ -422,17 +394,7 @@
"login": "A String", # Level of login required to access this resource. Defaults to optional.
"script": "A String", # Path to the script from the application root directory.
},
- "network": { # Extra network settings. Only applicable for VM runtimes. # Extra network settings. Only applicable for VM runtimes.
- "instanceTag": "A String", # Tag to apply to the VM instance during creation.
- "forwardedPorts": [ # List of ports, or port pairs, to forward from the virtual machine to the application container.
- "A String",
- ],
- "name": "A String", # Google Cloud Platform 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 the VM instance is being created in is a Legacy network, then the IP address is allocated from the IPv4Range.
- # If the network the VM instance is being created in is an auto Subnet Mode Network, then only network name should be specified (not the subnetwork_name) and the IP address is created from the IPCidrRange of the subnetwork that exists in that zone for that network.
- # If the network the VM instance is being created in is a custom Subnet Mode Network, then the subnetwork_name must be specified and the IP address is created from the IPCidrRange of the subnetwork.If specified, the subnetwork must exist in the same region as the Flex app.
- },
+ "threadsafe": True or False, # Whether multiple requests can be dispatched to this version at once.
"healthCheck": { # Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances. Only applicable for instances in App Engine flexible environment. # Configures health checking for VM instances. Unhealthy instances are stopped and replaced with new instances. Only applicable for VM runtimes.Only returned in GET requests if view=FULL is set.
"restartThreshold": 42, # Number of consecutive failed health checks required before an instance is restarted.
"checkInterval": "A String", # Interval between health checks.
@@ -442,6 +404,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.
},
+ "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/v1beta/apps.services.versions#staticfileshandler) does not specify its own expiration time.Only returned in GET requests if view=FULL is set.
"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.
@@ -452,10 +415,7 @@
"env": "A String", # App Engine execution environment for this version.Defaults to standard.
"diskUsageBytes": "A String", # Total size in bytes of all the files that are included in this version and curerntly hosted on the App Engine disk.@OutputOnly
"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.
- "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.
- },
+ "minPendingLatency": "A String", # Minimum amount of time a request should wait in the pending queue before starting a new instance to handle it.
"networkUtilization": { # Target scaling by network usage. Only applicable for VM runtimes. # Target scaling by network usage.
"targetReceivedPacketsPerSecond": 42, # Target packets received per second.
"targetSentPacketsPerSecond": 42, # Target packets sent per second.
@@ -479,7 +439,10 @@
"maxTotalInstances": 42, # Maximum number of instances that should be started to handle requests.
"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.
"minTotalInstances": 42, # Minimum number of instances that should be maintained for this version.
- "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.
+ },
},
"envVariables": { # Environment variables available to the application.Only returned in GET requests if view=FULL is set.
"a_key": "A String",
@@ -502,15 +465,12 @@
"inboundServices": [ # Before an application can receive email or XMPP messages, the application must be configured to enable the service.
"A String",
],
- "betaSettings": { # Metadata settings that are supplied to this version to enable beta runtime features.
- "a_key": "A String",
- },
"createdBy": "A String", # Email address of the user who created this version.@OutputOnly
"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.
"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//'.
"sha1Sum": "A String", # The SHA1 hash of the file, in hex.
},
},
@@ -519,9 +479,19 @@
},
"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//'.
},
},
+ "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.
+ "createTime": "A String", # Time that this version was created.@OutputOnly
+ "network": { # Extra network settings. Only applicable for VM runtimes. # Extra network settings. Only applicable for VM runtimes.
+ "instanceTag": "A String", # Tag to apply to the VM instance during creation.
+ "forwardedPorts": [ # List of ports, or port pairs, to forward from the virtual machine to the application container.
+ "A String",
+ ],
+ "name": "A String", # Google Cloud Platform 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 the VM instance is being created in is a Legacy network, then the IP address is allocated from the IPv4Range. If the network the VM instance is being created in is an auto Subnet Mode Network, then only network name should be specified (not the subnetwork_name) and the IP address is created from the IPCidrRange of the subnetwork that exists in that zone for that network. If the network the VM instance is being created in is a custom Subnet Mode Network, then the subnetwork_name must be specified and the IP address is created from the IPCidrRange of the subnetwork.If specified, the subnetwork must exist in the same region as the Flex app.
+ },
"livenessCheck": { # Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances. # Configures liveness health checking for VM instances. Unhealthy instances are stopped and replaced with new instancesOnly returned in GET requests if view=FULL is set.
"checkInterval": "A String", # Interval between health checks.
"initialDelay": "A String", # The initial delay before starting to execute the checks.
@@ -531,9 +501,6 @@
"timeout": "A String", # Time before the check is considered failed.
"path": "A String", # The request path.
},
- "createTime": "A String", # Time that this version was created.@OutputOnly
- "threadsafe": True or False, # Whether multiple requests can be dispatched to this version at once.
- "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.
{ # 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.
@@ -545,20 +512,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.
+ "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.
"httpHeaders": { # HTTP headers to use for all responses from these URLs.
"a_key": "A String",
},
- "expiration": "A String", # Time a static file served by this handler should be cached by web proxies and browsers.
- "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.
- "uploadPathRegex": "A String", # Regular expression that matches the file paths for all files that should be referenced by this handler.
- "requireMatchingFile": True or False, # Whether this handler should match the request if the file referenced by the handler does not exist.
- "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.
},
"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.
+ "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.
@@ -567,18 +534,15 @@
</div>
<div class="method">
- <code class="details" id="list">list(appsId, servicesId, pageSize=None, pageToken=None, x__xgafv=None, view=None)</code>
+ <code class="details" id="list">list(appsId, servicesId, pageSize=None, x__xgafv=None, pageToken=None, view=None)</code>
<pre>Lists the versions of a service.
Args:
appsId: string, Part of `parent`. Name of the parent Service resource. Example: apps/myapp/services/default. (required)
servicesId: string, Part of `parent`. See documentation of `appsId`. (required)
pageSize: integer, Maximum results to return per page.
- pageToken: string, Continuation token for fetching the next page of results.
x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
+ pageToken: string, Continuation token for fetching the next page of results.
view: string, Controls the set of fields returned in the List response.
Returns:
@@ -592,15 +556,15 @@
"configId": "A String", # Endpoints service configuration id as specified by the Service Management API. For example "2016-09-19r1"
"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"
},
- "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/v1beta/apps.services.versions#staticfileshandler) does not specify its own expiration time.Only returned in GET requests if view=FULL is set.
"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.
"idleTimeout": "A String", # Duration of time after the last request that an instance must wait before the instance is shut down.
"maxInstances": 42, # Maximum number of instances to create for this version.
},
+ "betaSettings": { # Metadata settings that are supplied to this version to enable beta runtime features.
+ "a_key": "A String",
+ },
"vm": True or False, # Whether to deploy this version in a container on a virtual machine.
- "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.
+ "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.
"errorHandlers": [ # Custom static error pages. Limited to 10KB per page.Only returned in GET requests if view=FULL is set.
{ # Custom static error page to be served when an error occurs.
"errorCode": "A String", # Error condition this handler applies to.
@@ -624,17 +588,7 @@
"login": "A String", # Level of login required to access this resource. Defaults to optional.
"script": "A String", # Path to the script from the application root directory.
},
- "network": { # Extra network settings. Only applicable for VM runtimes. # Extra network settings. Only applicable for VM runtimes.
- "instanceTag": "A String", # Tag to apply to the VM instance during creation.
- "forwardedPorts": [ # List of ports, or port pairs, to forward from the virtual machine to the application container.
- "A String",
- ],
- "name": "A String", # Google Cloud Platform 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 the VM instance is being created in is a Legacy network, then the IP address is allocated from the IPv4Range.
- # If the network the VM instance is being created in is an auto Subnet Mode Network, then only network name should be specified (not the subnetwork_name) and the IP address is created from the IPCidrRange of the subnetwork that exists in that zone for that network.
- # If the network the VM instance is being created in is a custom Subnet Mode Network, then the subnetwork_name must be specified and the IP address is created from the IPCidrRange of the subnetwork.If specified, the subnetwork must exist in the same region as the Flex app.
- },
+ "threadsafe": True or False, # Whether multiple requests can be dispatched to this version at once.
"healthCheck": { # Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances. Only applicable for instances in App Engine flexible environment. # Configures health checking for VM instances. Unhealthy instances are stopped and replaced with new instances. Only applicable for VM runtimes.Only returned in GET requests if view=FULL is set.
"restartThreshold": 42, # Number of consecutive failed health checks required before an instance is restarted.
"checkInterval": "A String", # Interval between health checks.
@@ -644,6 +598,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.
},
+ "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/v1beta/apps.services.versions#staticfileshandler) does not specify its own expiration time.Only returned in GET requests if view=FULL is set.
"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.
@@ -654,10 +609,7 @@
"env": "A String", # App Engine execution environment for this version.Defaults to standard.
"diskUsageBytes": "A String", # Total size in bytes of all the files that are included in this version and curerntly hosted on the App Engine disk.@OutputOnly
"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.
- "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.
- },
+ "minPendingLatency": "A String", # Minimum amount of time a request should wait in the pending queue before starting a new instance to handle it.
"networkUtilization": { # Target scaling by network usage. Only applicable for VM runtimes. # Target scaling by network usage.
"targetReceivedPacketsPerSecond": 42, # Target packets received per second.
"targetSentPacketsPerSecond": 42, # Target packets sent per second.
@@ -681,7 +633,10 @@
"maxTotalInstances": 42, # Maximum number of instances that should be started to handle requests.
"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.
"minTotalInstances": 42, # Minimum number of instances that should be maintained for this version.
- "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.
+ },
},
"envVariables": { # Environment variables available to the application.Only returned in GET requests if view=FULL is set.
"a_key": "A String",
@@ -704,15 +659,12 @@
"inboundServices": [ # Before an application can receive email or XMPP messages, the application must be configured to enable the service.
"A String",
],
- "betaSettings": { # Metadata settings that are supplied to this version to enable beta runtime features.
- "a_key": "A String",
- },
"createdBy": "A String", # Email address of the user who created this version.@OutputOnly
"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.
"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//'.
"sha1Sum": "A String", # The SHA1 hash of the file, in hex.
},
},
@@ -721,9 +673,19 @@
},
"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//'.
},
},
+ "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.
+ "createTime": "A String", # Time that this version was created.@OutputOnly
+ "network": { # Extra network settings. Only applicable for VM runtimes. # Extra network settings. Only applicable for VM runtimes.
+ "instanceTag": "A String", # Tag to apply to the VM instance during creation.
+ "forwardedPorts": [ # List of ports, or port pairs, to forward from the virtual machine to the application container.
+ "A String",
+ ],
+ "name": "A String", # Google Cloud Platform 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 the VM instance is being created in is a Legacy network, then the IP address is allocated from the IPv4Range. If the network the VM instance is being created in is an auto Subnet Mode Network, then only network name should be specified (not the subnetwork_name) and the IP address is created from the IPCidrRange of the subnetwork that exists in that zone for that network. If the network the VM instance is being created in is a custom Subnet Mode Network, then the subnetwork_name must be specified and the IP address is created from the IPCidrRange of the subnetwork.If specified, the subnetwork must exist in the same region as the Flex app.
+ },
"livenessCheck": { # Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances. # Configures liveness health checking for VM instances. Unhealthy instances are stopped and replaced with new instancesOnly returned in GET requests if view=FULL is set.
"checkInterval": "A String", # Interval between health checks.
"initialDelay": "A String", # The initial delay before starting to execute the checks.
@@ -733,9 +695,6 @@
"timeout": "A String", # Time before the check is considered failed.
"path": "A String", # The request path.
},
- "createTime": "A String", # Time that this version was created.@OutputOnly
- "threadsafe": True or False, # Whether multiple requests can be dispatched to this version at once.
- "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.
{ # 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.
@@ -747,20 +706,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.
+ "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.
"httpHeaders": { # HTTP headers to use for all responses from these URLs.
"a_key": "A String",
},
- "expiration": "A String", # Time a static file served by this handler should be cached by web proxies and browsers.
- "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.
- "uploadPathRegex": "A String", # Regular expression that matches the file paths for all files that should be referenced by this handler.
- "requireMatchingFile": True or False, # Whether this handler should match the request if the file referenced by the handler does not exist.
- "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.
},
"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.
+ "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.
@@ -786,11 +745,7 @@
<div class="method">
<code class="details" id="patch">patch(appsId, servicesId, versionsId, body, 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:
-serving_status (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.serving_status): For Version resources that use basic scaling, manual scaling, or run in the App Engine flexible environment.
-instance_class (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.instance_class): For Version resources that run in the App Engine standard environment.
-automatic_scaling.min_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine standard environment.
-automatic_scaling.max_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine standard environment.
+ <pre>Updates the specified Version resource. You can specify the following fields depending on the App Engine environment and type of scaling that the version resource uses: serving_status (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.serving_status): For Version resources that use basic scaling, manual scaling, or run in the App Engine flexible environment. instance_class (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.instance_class): For Version resources that run in the App Engine standard environment. automatic_scaling.min_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine standard environment. automatic_scaling.max_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine standard environment.
Args:
appsId: string, Part of `name`. Name of the resource to update. Example: apps/myapp/services/default/versions/1. (required)
@@ -804,15 +759,15 @@
"configId": "A String", # Endpoints service configuration id as specified by the Service Management API. For example "2016-09-19r1"
"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"
},
- "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/v1beta/apps.services.versions#staticfileshandler) does not specify its own expiration time.Only returned in GET requests if view=FULL is set.
"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.
"idleTimeout": "A String", # Duration of time after the last request that an instance must wait before the instance is shut down.
"maxInstances": 42, # Maximum number of instances to create for this version.
},
+ "betaSettings": { # Metadata settings that are supplied to this version to enable beta runtime features.
+ "a_key": "A String",
+ },
"vm": True or False, # Whether to deploy this version in a container on a virtual machine.
- "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.
+ "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.
"errorHandlers": [ # Custom static error pages. Limited to 10KB per page.Only returned in GET requests if view=FULL is set.
{ # Custom static error page to be served when an error occurs.
"errorCode": "A String", # Error condition this handler applies to.
@@ -836,17 +791,7 @@
"login": "A String", # Level of login required to access this resource. Defaults to optional.
"script": "A String", # Path to the script from the application root directory.
},
- "network": { # Extra network settings. Only applicable for VM runtimes. # Extra network settings. Only applicable for VM runtimes.
- "instanceTag": "A String", # Tag to apply to the VM instance during creation.
- "forwardedPorts": [ # List of ports, or port pairs, to forward from the virtual machine to the application container.
- "A String",
- ],
- "name": "A String", # Google Cloud Platform 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 the VM instance is being created in is a Legacy network, then the IP address is allocated from the IPv4Range.
- # If the network the VM instance is being created in is an auto Subnet Mode Network, then only network name should be specified (not the subnetwork_name) and the IP address is created from the IPCidrRange of the subnetwork that exists in that zone for that network.
- # If the network the VM instance is being created in is a custom Subnet Mode Network, then the subnetwork_name must be specified and the IP address is created from the IPCidrRange of the subnetwork.If specified, the subnetwork must exist in the same region as the Flex app.
- },
+ "threadsafe": True or False, # Whether multiple requests can be dispatched to this version at once.
"healthCheck": { # Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances. Only applicable for instances in App Engine flexible environment. # Configures health checking for VM instances. Unhealthy instances are stopped and replaced with new instances. Only applicable for VM runtimes.Only returned in GET requests if view=FULL is set.
"restartThreshold": 42, # Number of consecutive failed health checks required before an instance is restarted.
"checkInterval": "A String", # Interval between health checks.
@@ -856,6 +801,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.
},
+ "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/v1beta/apps.services.versions#staticfileshandler) does not specify its own expiration time.Only returned in GET requests if view=FULL is set.
"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.
@@ -866,10 +812,7 @@
"env": "A String", # App Engine execution environment for this version.Defaults to standard.
"diskUsageBytes": "A String", # Total size in bytes of all the files that are included in this version and curerntly hosted on the App Engine disk.@OutputOnly
"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.
- "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.
- },
+ "minPendingLatency": "A String", # Minimum amount of time a request should wait in the pending queue before starting a new instance to handle it.
"networkUtilization": { # Target scaling by network usage. Only applicable for VM runtimes. # Target scaling by network usage.
"targetReceivedPacketsPerSecond": 42, # Target packets received per second.
"targetSentPacketsPerSecond": 42, # Target packets sent per second.
@@ -893,7 +836,10 @@
"maxTotalInstances": 42, # Maximum number of instances that should be started to handle requests.
"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.
"minTotalInstances": 42, # Minimum number of instances that should be maintained for this version.
- "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.
+ },
},
"envVariables": { # Environment variables available to the application.Only returned in GET requests if view=FULL is set.
"a_key": "A String",
@@ -916,15 +862,12 @@
"inboundServices": [ # Before an application can receive email or XMPP messages, the application must be configured to enable the service.
"A String",
],
- "betaSettings": { # Metadata settings that are supplied to this version to enable beta runtime features.
- "a_key": "A String",
- },
"createdBy": "A String", # Email address of the user who created this version.@OutputOnly
"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.
"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//'.
"sha1Sum": "A String", # The SHA1 hash of the file, in hex.
},
},
@@ -933,9 +876,19 @@
},
"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//'.
},
},
+ "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.
+ "createTime": "A String", # Time that this version was created.@OutputOnly
+ "network": { # Extra network settings. Only applicable for VM runtimes. # Extra network settings. Only applicable for VM runtimes.
+ "instanceTag": "A String", # Tag to apply to the VM instance during creation.
+ "forwardedPorts": [ # List of ports, or port pairs, to forward from the virtual machine to the application container.
+ "A String",
+ ],
+ "name": "A String", # Google Cloud Platform 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 the VM instance is being created in is a Legacy network, then the IP address is allocated from the IPv4Range. If the network the VM instance is being created in is an auto Subnet Mode Network, then only network name should be specified (not the subnetwork_name) and the IP address is created from the IPCidrRange of the subnetwork that exists in that zone for that network. If the network the VM instance is being created in is a custom Subnet Mode Network, then the subnetwork_name must be specified and the IP address is created from the IPCidrRange of the subnetwork.If specified, the subnetwork must exist in the same region as the Flex app.
+ },
"livenessCheck": { # Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances. # Configures liveness health checking for VM instances. Unhealthy instances are stopped and replaced with new instancesOnly returned in GET requests if view=FULL is set.
"checkInterval": "A String", # Interval between health checks.
"initialDelay": "A String", # The initial delay before starting to execute the checks.
@@ -945,9 +898,6 @@
"timeout": "A String", # Time before the check is considered failed.
"path": "A String", # The request path.
},
- "createTime": "A String", # Time that this version was created.@OutputOnly
- "threadsafe": True or False, # Whether multiple requests can be dispatched to this version at once.
- "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.
{ # 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.
@@ -959,20 +909,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.
+ "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.
"httpHeaders": { # HTTP headers to use for all responses from these URLs.
"a_key": "A String",
},
- "expiration": "A String", # Time a static file served by this handler should be cached by web proxies and browsers.
- "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.
- "uploadPathRegex": "A String", # Regular expression that matches the file paths for all files that should be referenced by this handler.
- "requireMatchingFile": True or False, # Whether this handler should match the request if the file referenced by the handler does not exist.
- "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.
},
"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.
+ "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.
@@ -981,22 +931,15 @@
updateMask: string, Standard field mask for the set of fields to be updated.
x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
- "error": { # The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). The error model is designed to be: # The error result of the operation in case of failure or cancellation.
- # Simple to use and understand for most users
- # Flexible enough to meet unexpected needsOverviewThe Status message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers understand and resolve the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package google.rpc which can be used for common error conditions.Language mappingThe Status message is the logical representation of the error model, but it is not necessarily the actual wire format. When the Status message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C.Other usesThe error model and the Status message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments.Example uses of this error model include:
- # Partial errors. If a service needs to return partial errors to the client, it may embed the Status in the normal response to indicate the partial errors.
- # Workflow errors. A typical workflow has multiple steps. Each step may have a Status message for error reporting purpose.
- # Batch operations. If a client uses batch request and batch response, the Status message should be used directly inside batch response, one for each error sub-response.
- # Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the Status message.
- # Logging. If some API errors are stored in logs, the message Status could be used directly after any stripping needed for security/privacy reasons.
+ "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.
+ },
+ "error": { # The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). The error model is designed to be: Simple to use and understand for most users Flexible enough to meet unexpected needsOverviewThe Status message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers understand and resolve the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package google.rpc which can be used for common error conditions.Language mappingThe Status message is the logical representation of the error model, but it is not necessarily the actual wire format. When the Status message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C.Other usesThe error model and the Status message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments.Example uses of this error model include: Partial errors. If a service needs to return partial errors to the client, it may embed the Status in the normal response to indicate the partial errors. Workflow errors. A typical workflow has multiple steps. Each step may have a Status message for error reporting purpose. Batch operations. If a client uses batch request and batch response, the Status message should be used directly inside batch response, one for each error sub-response. Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the Status message. Logging. If some API errors are stored in logs, the message Status could be used directly after any stripping needed for security/privacy reasons. # The error result of the operation in case of failure 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.
"details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
@@ -1006,9 +949,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 have the format of operations/some/unique/name.
"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.