Regen all docs. (#700)
* Stop recursing if discovery == {}
* Generate docs with 'make docs'.
diff --git a/docs/dyn/compute_v1.healthChecks.html b/docs/dyn/compute_v1.healthChecks.html
index 80fe50d..ef0f28a 100644
--- a/docs/dyn/compute_v1.healthChecks.html
+++ b/docs/dyn/compute_v1.healthChecks.html
@@ -75,13 +75,13 @@
<h1><a href="compute_v1.html">Compute Engine API</a> . <a href="compute_v1.healthChecks.html">healthChecks</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
- <code><a href="#delete">delete(project, healthCheck)</a></code></p>
+ <code><a href="#delete">delete(project, healthCheck, requestId=None)</a></code></p>
<p class="firstline">Deletes the specified HealthCheck resource.</p>
<p class="toc_element">
<code><a href="#get">get(project, healthCheck)</a></code></p>
-<p class="firstline">Returns the specified HealthCheck resource. Get a list of available health checks by making a list() request.</p>
+<p class="firstline">Returns the specified HealthCheck resource. Gets a list of available health checks by making a list() request.</p>
<p class="toc_element">
- <code><a href="#insert">insert(project, body)</a></code></p>
+ <code><a href="#insert">insert(project, body, requestId=None)</a></code></p>
<p class="firstline">Creates a HealthCheck resource in the specified project using the data included in the request.</p>
<p class="toc_element">
<code><a href="#list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
@@ -90,29 +90,43 @@
<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(project, healthCheck, body)</a></code></p>
-<p class="firstline">Updates a HealthCheck resource in the specified project using the data included in the request. This method supports patch semantics.</p>
+ <code><a href="#patch">patch(project, healthCheck, body, requestId=None)</a></code></p>
+<p class="firstline">Updates a HealthCheck resource in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.</p>
<p class="toc_element">
- <code><a href="#update">update(project, healthCheck, body)</a></code></p>
+ <code><a href="#update">update(project, healthCheck, body, requestId=None)</a></code></p>
<p class="firstline">Updates a HealthCheck resource in the specified project using the data included in the request.</p>
<h3>Method Details</h3>
<div class="method">
- <code class="details" id="delete">delete(project, healthCheck)</code>
+ <code class="details" id="delete">delete(project, healthCheck, requestId=None)</code>
<pre>Deletes the specified HealthCheck resource.
Args:
project: string, Project ID for this request. (required)
healthCheck: string, Name of the HealthCheck resource to delete. (required)
+ requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.
+
+For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
+
+The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Returns:
An object of the form:
- { # An Operation resource, used to manage asynchronous API requests.
+ { # Represents an Operation resource.
+ #
+ # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
+ #
+ # Operations can be global, regional or zonal.
+ # - For global operations, use the globalOperations resource.
+ # - For regional operations, use the regionOperations resource.
+ # - For zonal operations, use the zonalOperations resource.
+ #
+ # For more information, read Global, Regional, and Zonal Resources. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==)
"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
- "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
"creationTimestamp": "A String", # [Deprecated] This field is deprecated.
"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
- "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
"operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
@@ -138,7 +152,7 @@
"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
"kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
"name": "A String", # [Output Only] Name of the resource.
- "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
"errors": [ # [Output Only] The array of errors encountered while processing this operation.
{
@@ -156,7 +170,7 @@
<div class="method">
<code class="details" id="get">get(project, healthCheck)</code>
- <pre>Returns the specified HealthCheck resource. Get a list of available health checks by making a list() request.
+ <pre>Returns the specified HealthCheck resource. Gets a list of available health checks by making a list() request.
Args:
project: string, Project ID for this request. (required)
@@ -169,47 +183,132 @@
"kind": "compute#healthCheck", # Type of the resource.
"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
"timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec.
- "type": "A String", # Specifies the type of the healthCheck, either TCP, SSL, HTTP or HTTPS. If not specified, the default is TCP. Exactly one of the protocol-specific health check field must be specified, which must match type field.
+ "type": "A String", # Specifies the type of the healthCheck, either TCP, SSL, HTTP, HTTPS or HTTP2. If not specified, the default is TCP. Exactly one of the protocol-specific health check field must be specified, which must match type field.
"checkIntervalSec": 42, # How often (in seconds) to send a health check. The default value is 5 seconds.
"tcpHealthCheck": {
- "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
- "request": "A String", # The application data to send once the TCP connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.
"proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
+ "request": "A String", # The application data to send once the TCP connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.
+ "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values:
+ # USE_FIXED_PORT: The port number in
+ # port
+ # is used for health checking.
+ # USE_NAMED_PORT: The
+ # portName
+ # is used for health checking.
+ # USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking.
+ #
+ #
+ # If not specified, TCP health check follows behavior specified in
+ # port
+ # and
+ # portName
+ # fields.
"port": 42, # The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535.
+ "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
"response": "A String", # The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.
},
"httpHealthCheck": {
- "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
- "host": "A String", # The value of the host header in the HTTP health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.
- "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
- "port": 42, # The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535.
"requestPath": "A String", # The request path of the HTTP health check request. The default value is /.
+ "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
+ "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values:
+ # USE_FIXED_PORT: The port number in
+ # port
+ # is used for health checking.
+ # USE_NAMED_PORT: The
+ # portName
+ # is used for health checking.
+ # USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking.
+ #
+ #
+ # If not specified, HTTP health check follows behavior specified in
+ # port
+ # and
+ # portName
+ # fields.
+ "response": "A String", # The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII.
+ "host": "A String", # The value of the host header in the HTTP health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.
+ "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
+ "port": 42, # The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535.
},
"httpsHealthCheck": {
- "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
- "host": "A String", # The value of the host header in the HTTPS health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.
- "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
- "port": 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.
"requestPath": "A String", # The request path of the HTTPS health check request. The default value is /.
+ "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
+ "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values:
+ # USE_FIXED_PORT: The port number in
+ # port
+ # is used for health checking.
+ # USE_NAMED_PORT: The
+ # portName
+ # is used for health checking.
+ # USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking.
+ #
+ #
+ # If not specified, HTTPS health check follows behavior specified in
+ # port
+ # and
+ # portName
+ # fields.
+ "response": "A String", # The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII.
+ "host": "A String", # The value of the host header in the HTTPS health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.
+ "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
+ "port": 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.
},
"healthyThreshold": 42, # A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.
+ "http2HealthCheck": {
+ "requestPath": "A String", # The request path of the HTTP/2 health check request. The default value is /.
+ "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
+ "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values:
+ # USE_FIXED_PORT: The port number in
+ # port
+ # is used for health checking.
+ # USE_NAMED_PORT: The
+ # portName
+ # is used for health checking.
+ # USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking.
+ #
+ #
+ # If not specified, HTTP2 health check follows behavior specified in
+ # port
+ # and
+ # portName
+ # fields.
+ "response": "A String", # The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII.
+ "host": "A String", # The value of the host header in the HTTP/2 health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.
+ "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
+ "port": 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.
+ },
"unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
"sslHealthCheck": {
- "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
- "request": "A String", # The application data to send once the SSL connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.
"proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
+ "request": "A String", # The application data to send once the SSL connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.
+ "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values:
+ # USE_FIXED_PORT: The port number in
+ # port
+ # is used for health checking.
+ # USE_NAMED_PORT: The
+ # portName
+ # is used for health checking.
+ # USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking.
+ #
+ #
+ # If not specified, SSL health check follows behavior specified in
+ # port
+ # and
+ # portName
+ # fields.
"port": 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.
+ "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
"response": "A String", # The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.
},
"creationTimestamp": "A String", # [Output Only] Creation timestamp in 3339 text format.
"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
}</pre>
</div>
<div class="method">
- <code class="details" id="insert">insert(project, body)</code>
+ <code class="details" id="insert">insert(project, body, requestId=None)</code>
<pre>Creates a HealthCheck resource in the specified project using the data included in the request.
Args:
@@ -221,54 +320,153 @@
"kind": "compute#healthCheck", # Type of the resource.
"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
"timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec.
- "type": "A String", # Specifies the type of the healthCheck, either TCP, SSL, HTTP or HTTPS. If not specified, the default is TCP. Exactly one of the protocol-specific health check field must be specified, which must match type field.
+ "type": "A String", # Specifies the type of the healthCheck, either TCP, SSL, HTTP, HTTPS or HTTP2. If not specified, the default is TCP. Exactly one of the protocol-specific health check field must be specified, which must match type field.
"checkIntervalSec": 42, # How often (in seconds) to send a health check. The default value is 5 seconds.
"tcpHealthCheck": {
- "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
- "request": "A String", # The application data to send once the TCP connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.
"proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
+ "request": "A String", # The application data to send once the TCP connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.
+ "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values:
+ # USE_FIXED_PORT: The port number in
+ # port
+ # is used for health checking.
+ # USE_NAMED_PORT: The
+ # portName
+ # is used for health checking.
+ # USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking.
+ #
+ #
+ # If not specified, TCP health check follows behavior specified in
+ # port
+ # and
+ # portName
+ # fields.
"port": 42, # The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535.
+ "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
"response": "A String", # The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.
},
"httpHealthCheck": {
- "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
- "host": "A String", # The value of the host header in the HTTP health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.
- "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
- "port": 42, # The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535.
"requestPath": "A String", # The request path of the HTTP health check request. The default value is /.
+ "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
+ "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values:
+ # USE_FIXED_PORT: The port number in
+ # port
+ # is used for health checking.
+ # USE_NAMED_PORT: The
+ # portName
+ # is used for health checking.
+ # USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking.
+ #
+ #
+ # If not specified, HTTP health check follows behavior specified in
+ # port
+ # and
+ # portName
+ # fields.
+ "response": "A String", # The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII.
+ "host": "A String", # The value of the host header in the HTTP health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.
+ "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
+ "port": 42, # The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535.
},
"httpsHealthCheck": {
- "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
- "host": "A String", # The value of the host header in the HTTPS health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.
- "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
- "port": 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.
"requestPath": "A String", # The request path of the HTTPS health check request. The default value is /.
+ "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
+ "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values:
+ # USE_FIXED_PORT: The port number in
+ # port
+ # is used for health checking.
+ # USE_NAMED_PORT: The
+ # portName
+ # is used for health checking.
+ # USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking.
+ #
+ #
+ # If not specified, HTTPS health check follows behavior specified in
+ # port
+ # and
+ # portName
+ # fields.
+ "response": "A String", # The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII.
+ "host": "A String", # The value of the host header in the HTTPS health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.
+ "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
+ "port": 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.
},
"healthyThreshold": 42, # A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.
+ "http2HealthCheck": {
+ "requestPath": "A String", # The request path of the HTTP/2 health check request. The default value is /.
+ "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
+ "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values:
+ # USE_FIXED_PORT: The port number in
+ # port
+ # is used for health checking.
+ # USE_NAMED_PORT: The
+ # portName
+ # is used for health checking.
+ # USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking.
+ #
+ #
+ # If not specified, HTTP2 health check follows behavior specified in
+ # port
+ # and
+ # portName
+ # fields.
+ "response": "A String", # The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII.
+ "host": "A String", # The value of the host header in the HTTP/2 health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.
+ "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
+ "port": 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.
+ },
"unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
"sslHealthCheck": {
- "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
- "request": "A String", # The application data to send once the SSL connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.
"proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
+ "request": "A String", # The application data to send once the SSL connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.
+ "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values:
+ # USE_FIXED_PORT: The port number in
+ # port
+ # is used for health checking.
+ # USE_NAMED_PORT: The
+ # portName
+ # is used for health checking.
+ # USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking.
+ #
+ #
+ # If not specified, SSL health check follows behavior specified in
+ # port
+ # and
+ # portName
+ # fields.
"port": 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.
+ "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
"response": "A String", # The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.
},
"creationTimestamp": "A String", # [Output Only] Creation timestamp in 3339 text format.
"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
}
+ requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.
+
+For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
+
+The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Returns:
An object of the form:
- { # An Operation resource, used to manage asynchronous API requests.
+ { # Represents an Operation resource.
+ #
+ # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
+ #
+ # Operations can be global, regional or zonal.
+ # - For global operations, use the globalOperations resource.
+ # - For regional operations, use the regionOperations resource.
+ # - For zonal operations, use the zonalOperations resource.
+ #
+ # For more information, read Global, Regional, and Zonal Resources. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==)
"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
- "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
"creationTimestamp": "A String", # [Deprecated] This field is deprecated.
"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
- "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
"operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
@@ -294,7 +492,7 @@
"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
"kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
"name": "A String", # [Output Only] Name of the resource.
- "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
"errors": [ # [Output Only] The array of errors encountered while processing this operation.
{
@@ -323,66 +521,160 @@
Currently, only sorting by name or creationTimestamp desc is supported.
maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)
pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
- filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
+ filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.
-The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
+For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.
-For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
+You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.
-You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
-
-To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
+To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true).
Returns:
An object of the form:
{ # Contains a list of HealthCheck resources.
"nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
+ "kind": "compute#healthCheckList", # Type of resource.
"items": [ # A list of HealthCheck resources.
{ # An HealthCheck resource. This resource defines a template for how individual virtual machines should be checked for health, via one of the supported protocols.
"kind": "compute#healthCheck", # Type of the resource.
"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
"timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec.
- "type": "A String", # Specifies the type of the healthCheck, either TCP, SSL, HTTP or HTTPS. If not specified, the default is TCP. Exactly one of the protocol-specific health check field must be specified, which must match type field.
+ "type": "A String", # Specifies the type of the healthCheck, either TCP, SSL, HTTP, HTTPS or HTTP2. If not specified, the default is TCP. Exactly one of the protocol-specific health check field must be specified, which must match type field.
"checkIntervalSec": 42, # How often (in seconds) to send a health check. The default value is 5 seconds.
"tcpHealthCheck": {
- "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
- "request": "A String", # The application data to send once the TCP connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.
"proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
+ "request": "A String", # The application data to send once the TCP connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.
+ "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values:
+ # USE_FIXED_PORT: The port number in
+ # port
+ # is used for health checking.
+ # USE_NAMED_PORT: The
+ # portName
+ # is used for health checking.
+ # USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking.
+ #
+ #
+ # If not specified, TCP health check follows behavior specified in
+ # port
+ # and
+ # portName
+ # fields.
"port": 42, # The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535.
+ "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
"response": "A String", # The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.
},
"httpHealthCheck": {
- "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
- "host": "A String", # The value of the host header in the HTTP health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.
- "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
- "port": 42, # The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535.
"requestPath": "A String", # The request path of the HTTP health check request. The default value is /.
+ "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
+ "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values:
+ # USE_FIXED_PORT: The port number in
+ # port
+ # is used for health checking.
+ # USE_NAMED_PORT: The
+ # portName
+ # is used for health checking.
+ # USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking.
+ #
+ #
+ # If not specified, HTTP health check follows behavior specified in
+ # port
+ # and
+ # portName
+ # fields.
+ "response": "A String", # The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII.
+ "host": "A String", # The value of the host header in the HTTP health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.
+ "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
+ "port": 42, # The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535.
},
"httpsHealthCheck": {
- "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
- "host": "A String", # The value of the host header in the HTTPS health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.
- "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
- "port": 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.
"requestPath": "A String", # The request path of the HTTPS health check request. The default value is /.
+ "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
+ "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values:
+ # USE_FIXED_PORT: The port number in
+ # port
+ # is used for health checking.
+ # USE_NAMED_PORT: The
+ # portName
+ # is used for health checking.
+ # USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking.
+ #
+ #
+ # If not specified, HTTPS health check follows behavior specified in
+ # port
+ # and
+ # portName
+ # fields.
+ "response": "A String", # The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII.
+ "host": "A String", # The value of the host header in the HTTPS health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.
+ "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
+ "port": 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.
},
"healthyThreshold": 42, # A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.
+ "http2HealthCheck": {
+ "requestPath": "A String", # The request path of the HTTP/2 health check request. The default value is /.
+ "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
+ "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values:
+ # USE_FIXED_PORT: The port number in
+ # port
+ # is used for health checking.
+ # USE_NAMED_PORT: The
+ # portName
+ # is used for health checking.
+ # USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking.
+ #
+ #
+ # If not specified, HTTP2 health check follows behavior specified in
+ # port
+ # and
+ # portName
+ # fields.
+ "response": "A String", # The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII.
+ "host": "A String", # The value of the host header in the HTTP/2 health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.
+ "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
+ "port": 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.
+ },
"unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
"sslHealthCheck": {
- "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
- "request": "A String", # The application data to send once the SSL connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.
"proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
+ "request": "A String", # The application data to send once the SSL connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.
+ "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values:
+ # USE_FIXED_PORT: The port number in
+ # port
+ # is used for health checking.
+ # USE_NAMED_PORT: The
+ # portName
+ # is used for health checking.
+ # USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking.
+ #
+ #
+ # If not specified, SSL health check follows behavior specified in
+ # port
+ # and
+ # portName
+ # fields.
"port": 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.
+ "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
"response": "A String", # The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.
},
"creationTimestamp": "A String", # [Output Only] Creation timestamp in 3339 text format.
"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
},
],
- "kind": "compute#healthCheckList", # Type of resource.
- "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "warning": { # [Output Only] Informational warning message.
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ },
+ "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
"selfLink": "A String", # [Output Only] Server-defined URL for this resource.
}</pre>
</div>
@@ -402,8 +694,8 @@
</div>
<div class="method">
- <code class="details" id="patch">patch(project, healthCheck, body)</code>
- <pre>Updates a HealthCheck resource in the specified project using the data included in the request. This method supports patch semantics.
+ <code class="details" id="patch">patch(project, healthCheck, body, requestId=None)</code>
+ <pre>Updates a HealthCheck resource in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.
Args:
project: string, Project ID for this request. (required)
@@ -415,54 +707,153 @@
"kind": "compute#healthCheck", # Type of the resource.
"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
"timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec.
- "type": "A String", # Specifies the type of the healthCheck, either TCP, SSL, HTTP or HTTPS. If not specified, the default is TCP. Exactly one of the protocol-specific health check field must be specified, which must match type field.
+ "type": "A String", # Specifies the type of the healthCheck, either TCP, SSL, HTTP, HTTPS or HTTP2. If not specified, the default is TCP. Exactly one of the protocol-specific health check field must be specified, which must match type field.
"checkIntervalSec": 42, # How often (in seconds) to send a health check. The default value is 5 seconds.
"tcpHealthCheck": {
- "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
- "request": "A String", # The application data to send once the TCP connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.
"proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
+ "request": "A String", # The application data to send once the TCP connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.
+ "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values:
+ # USE_FIXED_PORT: The port number in
+ # port
+ # is used for health checking.
+ # USE_NAMED_PORT: The
+ # portName
+ # is used for health checking.
+ # USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking.
+ #
+ #
+ # If not specified, TCP health check follows behavior specified in
+ # port
+ # and
+ # portName
+ # fields.
"port": 42, # The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535.
+ "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
"response": "A String", # The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.
},
"httpHealthCheck": {
- "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
- "host": "A String", # The value of the host header in the HTTP health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.
- "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
- "port": 42, # The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535.
"requestPath": "A String", # The request path of the HTTP health check request. The default value is /.
+ "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
+ "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values:
+ # USE_FIXED_PORT: The port number in
+ # port
+ # is used for health checking.
+ # USE_NAMED_PORT: The
+ # portName
+ # is used for health checking.
+ # USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking.
+ #
+ #
+ # If not specified, HTTP health check follows behavior specified in
+ # port
+ # and
+ # portName
+ # fields.
+ "response": "A String", # The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII.
+ "host": "A String", # The value of the host header in the HTTP health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.
+ "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
+ "port": 42, # The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535.
},
"httpsHealthCheck": {
- "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
- "host": "A String", # The value of the host header in the HTTPS health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.
- "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
- "port": 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.
"requestPath": "A String", # The request path of the HTTPS health check request. The default value is /.
+ "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
+ "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values:
+ # USE_FIXED_PORT: The port number in
+ # port
+ # is used for health checking.
+ # USE_NAMED_PORT: The
+ # portName
+ # is used for health checking.
+ # USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking.
+ #
+ #
+ # If not specified, HTTPS health check follows behavior specified in
+ # port
+ # and
+ # portName
+ # fields.
+ "response": "A String", # The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII.
+ "host": "A String", # The value of the host header in the HTTPS health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.
+ "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
+ "port": 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.
},
"healthyThreshold": 42, # A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.
+ "http2HealthCheck": {
+ "requestPath": "A String", # The request path of the HTTP/2 health check request. The default value is /.
+ "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
+ "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values:
+ # USE_FIXED_PORT: The port number in
+ # port
+ # is used for health checking.
+ # USE_NAMED_PORT: The
+ # portName
+ # is used for health checking.
+ # USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking.
+ #
+ #
+ # If not specified, HTTP2 health check follows behavior specified in
+ # port
+ # and
+ # portName
+ # fields.
+ "response": "A String", # The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII.
+ "host": "A String", # The value of the host header in the HTTP/2 health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.
+ "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
+ "port": 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.
+ },
"unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
"sslHealthCheck": {
- "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
- "request": "A String", # The application data to send once the SSL connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.
"proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
+ "request": "A String", # The application data to send once the SSL connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.
+ "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values:
+ # USE_FIXED_PORT: The port number in
+ # port
+ # is used for health checking.
+ # USE_NAMED_PORT: The
+ # portName
+ # is used for health checking.
+ # USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking.
+ #
+ #
+ # If not specified, SSL health check follows behavior specified in
+ # port
+ # and
+ # portName
+ # fields.
"port": 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.
+ "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
"response": "A String", # The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.
},
"creationTimestamp": "A String", # [Output Only] Creation timestamp in 3339 text format.
"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
}
+ requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.
+
+For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
+
+The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Returns:
An object of the form:
- { # An Operation resource, used to manage asynchronous API requests.
+ { # Represents an Operation resource.
+ #
+ # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
+ #
+ # Operations can be global, regional or zonal.
+ # - For global operations, use the globalOperations resource.
+ # - For regional operations, use the regionOperations resource.
+ # - For zonal operations, use the zonalOperations resource.
+ #
+ # For more information, read Global, Regional, and Zonal Resources. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==)
"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
- "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
"creationTimestamp": "A String", # [Deprecated] This field is deprecated.
"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
- "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
"operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
@@ -488,7 +879,7 @@
"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
"kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
"name": "A String", # [Output Only] Name of the resource.
- "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
"errors": [ # [Output Only] The array of errors encountered while processing this operation.
{
@@ -505,7 +896,7 @@
</div>
<div class="method">
- <code class="details" id="update">update(project, healthCheck, body)</code>
+ <code class="details" id="update">update(project, healthCheck, body, requestId=None)</code>
<pre>Updates a HealthCheck resource in the specified project using the data included in the request.
Args:
@@ -518,54 +909,153 @@
"kind": "compute#healthCheck", # Type of the resource.
"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
"timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec.
- "type": "A String", # Specifies the type of the healthCheck, either TCP, SSL, HTTP or HTTPS. If not specified, the default is TCP. Exactly one of the protocol-specific health check field must be specified, which must match type field.
+ "type": "A String", # Specifies the type of the healthCheck, either TCP, SSL, HTTP, HTTPS or HTTP2. If not specified, the default is TCP. Exactly one of the protocol-specific health check field must be specified, which must match type field.
"checkIntervalSec": 42, # How often (in seconds) to send a health check. The default value is 5 seconds.
"tcpHealthCheck": {
- "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
- "request": "A String", # The application data to send once the TCP connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.
"proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
+ "request": "A String", # The application data to send once the TCP connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.
+ "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values:
+ # USE_FIXED_PORT: The port number in
+ # port
+ # is used for health checking.
+ # USE_NAMED_PORT: The
+ # portName
+ # is used for health checking.
+ # USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking.
+ #
+ #
+ # If not specified, TCP health check follows behavior specified in
+ # port
+ # and
+ # portName
+ # fields.
"port": 42, # The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535.
+ "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
"response": "A String", # The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.
},
"httpHealthCheck": {
- "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
- "host": "A String", # The value of the host header in the HTTP health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.
- "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
- "port": 42, # The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535.
"requestPath": "A String", # The request path of the HTTP health check request. The default value is /.
+ "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
+ "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values:
+ # USE_FIXED_PORT: The port number in
+ # port
+ # is used for health checking.
+ # USE_NAMED_PORT: The
+ # portName
+ # is used for health checking.
+ # USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking.
+ #
+ #
+ # If not specified, HTTP health check follows behavior specified in
+ # port
+ # and
+ # portName
+ # fields.
+ "response": "A String", # The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII.
+ "host": "A String", # The value of the host header in the HTTP health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.
+ "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
+ "port": 42, # The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535.
},
"httpsHealthCheck": {
- "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
- "host": "A String", # The value of the host header in the HTTPS health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.
- "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
- "port": 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.
"requestPath": "A String", # The request path of the HTTPS health check request. The default value is /.
+ "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
+ "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values:
+ # USE_FIXED_PORT: The port number in
+ # port
+ # is used for health checking.
+ # USE_NAMED_PORT: The
+ # portName
+ # is used for health checking.
+ # USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking.
+ #
+ #
+ # If not specified, HTTPS health check follows behavior specified in
+ # port
+ # and
+ # portName
+ # fields.
+ "response": "A String", # The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII.
+ "host": "A String", # The value of the host header in the HTTPS health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.
+ "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
+ "port": 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.
},
"healthyThreshold": 42, # A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.
+ "http2HealthCheck": {
+ "requestPath": "A String", # The request path of the HTTP/2 health check request. The default value is /.
+ "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
+ "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values:
+ # USE_FIXED_PORT: The port number in
+ # port
+ # is used for health checking.
+ # USE_NAMED_PORT: The
+ # portName
+ # is used for health checking.
+ # USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking.
+ #
+ #
+ # If not specified, HTTP2 health check follows behavior specified in
+ # port
+ # and
+ # portName
+ # fields.
+ "response": "A String", # The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII.
+ "host": "A String", # The value of the host header in the HTTP/2 health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.
+ "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
+ "port": 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.
+ },
"unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
"sslHealthCheck": {
- "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
- "request": "A String", # The application data to send once the SSL connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.
"proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
+ "request": "A String", # The application data to send once the SSL connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.
+ "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values:
+ # USE_FIXED_PORT: The port number in
+ # port
+ # is used for health checking.
+ # USE_NAMED_PORT: The
+ # portName
+ # is used for health checking.
+ # USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking.
+ #
+ #
+ # If not specified, SSL health check follows behavior specified in
+ # port
+ # and
+ # portName
+ # fields.
"port": 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.
+ "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
"response": "A String", # The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.
},
"creationTimestamp": "A String", # [Output Only] Creation timestamp in 3339 text format.
"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
}
+ requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.
+
+For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
+
+The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Returns:
An object of the form:
- { # An Operation resource, used to manage asynchronous API requests.
+ { # Represents an Operation resource.
+ #
+ # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
+ #
+ # Operations can be global, regional or zonal.
+ # - For global operations, use the globalOperations resource.
+ # - For regional operations, use the regionOperations resource.
+ # - For zonal operations, use the zonalOperations resource.
+ #
+ # For more information, read Global, Regional, and Zonal Resources. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==)
"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
- "clientOperationId": "A String", # [Output Only] Reserved for future use.
+ "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
"creationTimestamp": "A String", # [Deprecated] This field is deprecated.
"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
- "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
"operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
@@ -591,7 +1081,7 @@
"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
"kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
"name": "A String", # [Output Only] Name of the resource.
- "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
"errors": [ # [Output Only] The array of errors encountered while processing this operation.
{