Blame - docs/dyn/compute_beta.regionHealthChecks.html - platform/external/python/google-api-python-client

blob: 60b796aa273ac52ec916f76a661575d4ea0c9ac7 [file] [log] [blame]

Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	1	<html><body>
				2	<style>
				3
				4	body, h1, h2, h3, div, span, p, pre, a {
				5	margin: 0;
				6	padding: 0;
				7	border: 0;
				8	font-weight: inherit;
				9	font-style: inherit;
				10	font-size: 100%;
				11	font-family: inherit;
				12	vertical-align: baseline;
				13	}
				14
				15	body {
				16	font-size: 13px;
				17	padding: 1em;
				18	}
				19
				20	h1 {
				21	font-size: 26px;
				22	margin-bottom: 1em;
				23	}
				24
				25	h2 {
				26	font-size: 24px;
				27	margin-bottom: 1em;
				28	}
				29
				30	h3 {
				31	font-size: 20px;
				32	margin-bottom: 1em;
				33	margin-top: 1em;
				34	}
				35
				36	pre, code {
				37	line-height: 1.5;
				38	font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
				39	}
				40
				41	pre {
				42	margin-top: 0.5em;
				43	}
				44
				45	h1, h2, h3, p {
				46	font-family: Arial, sans serif;
				47	}
				48
				49	h1, h2, h3 {
				50	border-bottom: solid #CCC 1px;
				51	}
				52
				53	.toc_element {
				54	margin-top: 0.5em;
				55	}
				56
				57	.firstline {
				58	margin-left: 2 em;
				59	}
				60
				61	.method {
				62	margin-top: 1em;
				63	border: solid 1px #CCC;
				64	padding: 1em;
				65	background: #EEE;
				66	}
				67
				68	.details {
				69	font-weight: bold;
				70	font-size: 14px;
				71	}
				72
				73	</style>
				74
				75	<h1><a href="compute_beta.html">Compute Engine API</a> . <a href="compute_beta.regionHealthChecks.html">regionHealthChecks</a></h1>
				76	<h2>Instance Methods</h2>
				77	<p class="toc_element">
				78	<code><a href="#delete">delete(project, region, healthCheck, requestId=None)</a></code></p>
				79	<p class="firstline">Deletes the specified HealthCheck resource.</p>
				80	<p class="toc_element">
				81	<code><a href="#get">get(project, region, healthCheck)</a></code></p>
				82	<p class="firstline">Returns the specified HealthCheck resource. Gets a list of available health checks by making a list() request.</p>
				83	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	84	<code><a href="#insert">insert(project, region, body=None, requestId=None)</a></code></p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	85	<p class="firstline">Creates a HealthCheck resource in the specified project using the data included in the request.</p>
				86	<p class="toc_element">
				87	<code><a href="#list">list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
				88	<p class="firstline">Retrieves the list of HealthCheck resources available to the specified project.</p>
				89	<p class="toc_element">
				90	<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
				91	<p class="firstline">Retrieves the next page of results.</p>
				92	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	93	<code><a href="#patch">patch(project, region, healthCheck, body=None, requestId=None)</a></code></p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	94	<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>
				95	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	96	<code><a href="#update">update(project, region, healthCheck, body=None, requestId=None)</a></code></p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	97	<p class="firstline">Updates a HealthCheck resource in the specified project using the data included in the request.</p>
				98	<h3>Method Details</h3>
				99	<div class="method">
				100	<code class="details" id="delete">delete(project, region, healthCheck, requestId=None)</code>
				101	<pre>Deletes the specified HealthCheck resource.
				102
				103	Args:
				104	project: string, Project ID for this request. (required)
				105	region: string, Name of the region scoping this request. (required)
				106	healthCheck: string, Name of the HealthCheck resource to delete. (required)
				107	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.
				108
				109	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.
				110
				111	The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
				112
				113	Returns:
				114	An object of the form:
				115
				116	{ # Represents an Operation resource.
				117	#
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	118	# Google Compute Engine has three Operation resources:
				119	#
				120	# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
				121	#
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	122	# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
				123	#
				124	# Operations can be global, regional or zonal.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	125	# - For global operations, use the `globalOperations` resource.
				126	# - For regional operations, use the `regionOperations` resource.
				127	# - For zonal operations, use the `zonalOperations` resource.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	128	#
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	129	# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	130	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				131	"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
				132	"creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	133	"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	134	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
				135	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	136	"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
				137	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	138	"progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	139	"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	140	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	141	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	142	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
				143	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
				144	{
				145	"message": "A String", # [Output Only] A human-readable description of the warning code.
				146	"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.
				147	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				148	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
				149	{
				150	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				151	"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).
				152	},
				153	],
				154	},
				155	],
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	156	"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	157	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	158	"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
				159	"name": "A String", # [Output Only] Name of the operation.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	160	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
				161	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
				162	"errors": [ # [Output Only] The array of errors encountered while processing this operation.
				163	{
				164	"message": "A String", # [Output Only] An optional, human-readable error message.
				165	"code": "A String", # [Output Only] The error type identifier for this error.
				166	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
				167	},
				168	],
				169	},
				170	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
				171	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				172	"targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
				173	}</pre>
				174	</div>
				175
				176	<div class="method">
				177	<code class="details" id="get">get(project, region, healthCheck)</code>
				178	<pre>Returns the specified HealthCheck resource. Gets a list of available health checks by making a list() request.
				179
				180	Args:
				181	project: string, Project ID for this request. (required)
				182	region: string, Name of the region scoping this request. (required)
				183	healthCheck: string, Name of the HealthCheck resource to return. (required)
				184
				185	Returns:
				186	An object of the form:
				187
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	188	{ # Represents a Health Check resource.
				189	#
				190	# Google Compute Engine has two Health Check resources:
				191	#
				192	# * [Global](/compute/docs/reference/rest/{$api_version}/healthChecks) * [Regional](/compute/docs/reference/rest/{$api_version}/regionHealthChecks)
				193	#
				194	# Internal HTTP(S) load balancers use regional health checks. All other types of GCP load balancers and managed instance group auto-healing use global health checks. For more information, read Health Check Concepts.
				195	#
				196	# To perform health checks on network load balancers, you must use either httpHealthChecks or httpsHealthChecks.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	197	"kind": "compute#healthCheck", # Type of the resource.
				198	"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
				199	"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.
				200	"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.
				201	"checkIntervalSec": 42, # How often (in seconds) to send a health check. The default value is 5 seconds.
				202	"tcpHealthCheck": {
				203	"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.
				204	"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.
				205	"portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values:
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	206	# USE_FIXED_PORT: The port number in port is used for health checking.
				207	# USE_NAMED_PORT: The portName is used for health checking.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	208	# 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.
				209	#
				210	#
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	211	# If not specified, TCP health check follows behavior specified in port and portName fields.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	212	"port": 42, # The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535.
				213	"portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
				214	"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.
				215	},
				216	"httpHealthCheck": {
				217	"requestPath": "A String", # The request path of the HTTP health check request. The default value is /.
				218	"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.
				219	"portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values:
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	220	# USE_FIXED_PORT: The port number in port is used for health checking.
				221	# USE_NAMED_PORT: The portName is used for health checking.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	222	# 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.
				223	#
				224	#
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	225	# If not specified, HTTP health check follows behavior specified in port and portName fields.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	226	"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.
				227	"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.
				228	"portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
				229	"port": 42, # The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535.
				230	},
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	231	"logConfig": { # Configuration of logging on a health check. If logging is enabled, logs will be exported to Stackdriver. # Configure logging on this health check.
				232	"enable": True or False, # Indicates whether or not to export logs. This is false by default, which means no health check logging will be done.
				233	},
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	234	"httpsHealthCheck": {
				235	"requestPath": "A String", # The request path of the HTTPS health check request. The default value is /.
				236	"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.
				237	"portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values:
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	238	# USE_FIXED_PORT: The port number in port is used for health checking.
				239	# USE_NAMED_PORT: The portName is used for health checking.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	240	# 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.
				241	#
				242	#
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	243	# If not specified, HTTPS health check follows behavior specified in port and portName fields.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	244	"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.
				245	"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.
				246	"portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
				247	"port": 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.
				248	},
				249	"healthyThreshold": 42, # A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.
				250	"http2HealthCheck": {
				251	"requestPath": "A String", # The request path of the HTTP/2 health check request. The default value is /.
				252	"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.
				253	"portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values:
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	254	# USE_FIXED_PORT: The port number in port is used for health checking.
				255	# USE_NAMED_PORT: The portName is used for health checking.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	256	# 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.
				257	#
				258	#
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	259	# If not specified, HTTP2 health check follows behavior specified in port and portName fields.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	260	"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.
				261	"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.
				262	"portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
				263	"port": 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.
				264	},
				265	"region": "A String", # [Output Only] Region where the health check resides. Not applicable to global health checks.
				266	"unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
				267	"sslHealthCheck": {
				268	"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.
				269	"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.
				270	"portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values:
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	271	# USE_FIXED_PORT: The port number in port is used for health checking.
				272	# USE_NAMED_PORT: The portName is used for health checking.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	273	# 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.
				274	#
				275	#
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	276	# If not specified, SSL health check follows behavior specified in port and portName fields.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	277	"port": 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.
				278	"portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
				279	"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.
				280	},
				281	"creationTimestamp": "A String", # [Output Only] Creation timestamp in 3339 text format.
				282	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				283	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				284	"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.
				285	}</pre>
				286	</div>
				287
				288	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	289	<code class="details" id="insert">insert(project, region, body=None, requestId=None)</code>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	290	<pre>Creates a HealthCheck resource in the specified project using the data included in the request.
				291
				292	Args:
				293	project: string, Project ID for this request. (required)
				294	region: string, Name of the region scoping this request. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	295	body: object, The request body.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	296	The object takes the form of:
				297
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	298	{ # Represents a Health Check resource.
				299	#
				300	# Google Compute Engine has two Health Check resources:
				301	#
				302	# * [Global](/compute/docs/reference/rest/{$api_version}/healthChecks) * [Regional](/compute/docs/reference/rest/{$api_version}/regionHealthChecks)
				303	#
				304	# Internal HTTP(S) load balancers use regional health checks. All other types of GCP load balancers and managed instance group auto-healing use global health checks. For more information, read Health Check Concepts.
				305	#
				306	# To perform health checks on network load balancers, you must use either httpHealthChecks or httpsHealthChecks.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	307	"kind": "compute#healthCheck", # Type of the resource.
				308	"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
				309	"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.
				310	"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.
				311	"checkIntervalSec": 42, # How often (in seconds) to send a health check. The default value is 5 seconds.
				312	"tcpHealthCheck": {
				313	"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.
				314	"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.
				315	"portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values:
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	316	# USE_FIXED_PORT: The port number in port is used for health checking.
				317	# USE_NAMED_PORT: The portName is used for health checking.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	318	# 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.
				319	#
				320	#
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	321	# If not specified, TCP health check follows behavior specified in port and portName fields.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	322	"port": 42, # The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535.
				323	"portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
				324	"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.
				325	},
				326	"httpHealthCheck": {
				327	"requestPath": "A String", # The request path of the HTTP health check request. The default value is /.
				328	"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.
				329	"portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values:
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	330	# USE_FIXED_PORT: The port number in port is used for health checking.
				331	# USE_NAMED_PORT: The portName is used for health checking.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	332	# 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.
				333	#
				334	#
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	335	# If not specified, HTTP health check follows behavior specified in port and portName fields.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	336	"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.
				337	"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.
				338	"portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
				339	"port": 42, # The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535.
				340	},
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	341	"logConfig": { # Configuration of logging on a health check. If logging is enabled, logs will be exported to Stackdriver. # Configure logging on this health check.
				342	"enable": True or False, # Indicates whether or not to export logs. This is false by default, which means no health check logging will be done.
				343	},
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	344	"httpsHealthCheck": {
				345	"requestPath": "A String", # The request path of the HTTPS health check request. The default value is /.
				346	"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.
				347	"portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values:
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	348	# USE_FIXED_PORT: The port number in port is used for health checking.
				349	# USE_NAMED_PORT: The portName is used for health checking.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	350	# 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.
				351	#
				352	#
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	353	# If not specified, HTTPS health check follows behavior specified in port and portName fields.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	354	"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.
				355	"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.
				356	"portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
				357	"port": 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.
				358	},
				359	"healthyThreshold": 42, # A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.
				360	"http2HealthCheck": {
				361	"requestPath": "A String", # The request path of the HTTP/2 health check request. The default value is /.
				362	"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.
				363	"portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values:
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	364	# USE_FIXED_PORT: The port number in port is used for health checking.
				365	# USE_NAMED_PORT: The portName is used for health checking.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	366	# 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.
				367	#
				368	#
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	369	# If not specified, HTTP2 health check follows behavior specified in port and portName fields.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	370	"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.
				371	"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.
				372	"portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
				373	"port": 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.
				374	},
				375	"region": "A String", # [Output Only] Region where the health check resides. Not applicable to global health checks.
				376	"unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
				377	"sslHealthCheck": {
				378	"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.
				379	"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.
				380	"portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values:
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	381	# USE_FIXED_PORT: The port number in port is used for health checking.
				382	# USE_NAMED_PORT: The portName is used for health checking.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	383	# 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.
				384	#
				385	#
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	386	# If not specified, SSL health check follows behavior specified in port and portName fields.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	387	"port": 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.
				388	"portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
				389	"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.
				390	},
				391	"creationTimestamp": "A String", # [Output Only] Creation timestamp in 3339 text format.
				392	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				393	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				394	"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.
				395	}
				396
				397	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.
				398
				399	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.
				400
				401	The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
				402
				403	Returns:
				404	An object of the form:
				405
				406	{ # Represents an Operation resource.
				407	#
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	408	# Google Compute Engine has three Operation resources:
				409	#
				410	# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
				411	#
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	412	# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
				413	#
				414	# Operations can be global, regional or zonal.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	415	# - For global operations, use the `globalOperations` resource.
				416	# - For regional operations, use the `regionOperations` resource.
				417	# - For zonal operations, use the `zonalOperations` resource.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	418	#
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	419	# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	420	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				421	"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
				422	"creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	423	"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	424	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
				425	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	426	"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
				427	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	428	"progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	429	"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	430	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	431	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	432	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
				433	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
				434	{
				435	"message": "A String", # [Output Only] A human-readable description of the warning code.
				436	"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.
				437	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				438	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
				439	{
				440	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				441	"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).
				442	},
				443	],
				444	},
				445	],
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	446	"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	447	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	448	"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
				449	"name": "A String", # [Output Only] Name of the operation.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	450	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
				451	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
				452	"errors": [ # [Output Only] The array of errors encountered while processing this operation.
				453	{
				454	"message": "A String", # [Output Only] An optional, human-readable error message.
				455	"code": "A String", # [Output Only] The error type identifier for this error.
				456	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
				457	},
				458	],
				459	},
				460	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
				461	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				462	"targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
				463	}</pre>
				464	</div>
				465
				466	<div class="method">
				467	<code class="details" id="list">list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
				468	<pre>Retrieves the list of HealthCheck resources available to the specified project.
				469
				470	Args:
				471	project: string, Project ID for this request. (required)
				472	region: string, Name of the region scoping this request. (required)
				473	orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
				474
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	475	You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	476
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	477	Currently, only sorting by `name` or `creationTimestamp desc` is supported.
				478	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`)
				479	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.
				480	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 `<`.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	481
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	482	For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	483
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	484	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.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	485
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	486	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) ```
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	487
				488	Returns:
				489	An object of the form:
				490
				491	{ # Contains a list of HealthCheck resources.
				492	"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.
				493	"kind": "compute#healthCheckList", # Type of resource.
				494	"items": [ # A list of HealthCheck resources.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	495	{ # Represents a Health Check resource.
				496	#
				497	# Google Compute Engine has two Health Check resources:
				498	#
				499	# * [Global](/compute/docs/reference/rest/{$api_version}/healthChecks) * [Regional](/compute/docs/reference/rest/{$api_version}/regionHealthChecks)
				500	#
				501	# Internal HTTP(S) load balancers use regional health checks. All other types of GCP load balancers and managed instance group auto-healing use global health checks. For more information, read Health Check Concepts.
				502	#
				503	# To perform health checks on network load balancers, you must use either httpHealthChecks or httpsHealthChecks.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	504	"kind": "compute#healthCheck", # Type of the resource.
				505	"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
				506	"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.
				507	"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.
				508	"checkIntervalSec": 42, # How often (in seconds) to send a health check. The default value is 5 seconds.
				509	"tcpHealthCheck": {
				510	"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.
				511	"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.
				512	"portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values:
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	513	# USE_FIXED_PORT: The port number in port is used for health checking.
				514	# USE_NAMED_PORT: The portName is used for health checking.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	515	# 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.
				516	#
				517	#
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	518	# If not specified, TCP health check follows behavior specified in port and portName fields.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	519	"port": 42, # The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535.
				520	"portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
				521	"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.
				522	},
				523	"httpHealthCheck": {
				524	"requestPath": "A String", # The request path of the HTTP health check request. The default value is /.
				525	"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.
				526	"portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values:
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	527	# USE_FIXED_PORT: The port number in port is used for health checking.
				528	# USE_NAMED_PORT: The portName is used for health checking.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	529	# 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.
				530	#
				531	#
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	532	# If not specified, HTTP health check follows behavior specified in port and portName fields.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	533	"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.
				534	"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.
				535	"portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
				536	"port": 42, # The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535.
				537	},
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	538	"logConfig": { # Configuration of logging on a health check. If logging is enabled, logs will be exported to Stackdriver. # Configure logging on this health check.
				539	"enable": True or False, # Indicates whether or not to export logs. This is false by default, which means no health check logging will be done.
				540	},
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	541	"httpsHealthCheck": {
				542	"requestPath": "A String", # The request path of the HTTPS health check request. The default value is /.
				543	"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.
				544	"portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values:
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	545	# USE_FIXED_PORT: The port number in port is used for health checking.
				546	# USE_NAMED_PORT: The portName is used for health checking.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	547	# 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.
				548	#
				549	#
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	550	# If not specified, HTTPS health check follows behavior specified in port and portName fields.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	551	"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.
				552	"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.
				553	"portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
				554	"port": 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.
				555	},
				556	"healthyThreshold": 42, # A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.
				557	"http2HealthCheck": {
				558	"requestPath": "A String", # The request path of the HTTP/2 health check request. The default value is /.
				559	"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.
				560	"portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values:
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	561	# USE_FIXED_PORT: The port number in port is used for health checking.
				562	# USE_NAMED_PORT: The portName is used for health checking.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	563	# 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.
				564	#
				565	#
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	566	# If not specified, HTTP2 health check follows behavior specified in port and portName fields.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	567	"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.
				568	"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.
				569	"portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
				570	"port": 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.
				571	},
				572	"region": "A String", # [Output Only] Region where the health check resides. Not applicable to global health checks.
				573	"unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
				574	"sslHealthCheck": {
				575	"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.
				576	"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.
				577	"portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values:
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	578	# USE_FIXED_PORT: The port number in port is used for health checking.
				579	# USE_NAMED_PORT: The portName is used for health checking.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	580	# 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.
				581	#
				582	#
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	583	# If not specified, SSL health check follows behavior specified in port and portName fields.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	584	"port": 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.
				585	"portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
				586	"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.
				587	},
				588	"creationTimestamp": "A String", # [Output Only] Creation timestamp in 3339 text format.
				589	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				590	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				591	"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.
				592	},
				593	],
				594	"warning": { # [Output Only] Informational warning message.
				595	"message": "A String", # [Output Only] A human-readable description of the warning code.
				596	"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.
				597	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				598	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
				599	{
				600	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				601	"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).
				602	},
				603	],
				604	},
				605	"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
				606	"selfLink": "A String", # [Output Only] Server-defined URL for this resource.
				607	}</pre>
				608	</div>
				609
				610	<div class="method">
				611	<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
				612	<pre>Retrieves the next page of results.
				613
				614	Args:
				615	previous_request: The request for the previous page. (required)
				616	previous_response: The response from the request for the previous page. (required)
				617
				618	Returns:
				619	A request object that you can call 'execute()' on to request the next
				620	page. Returns None if there are no more items in the collection.
				621	</pre>
				622	</div>
				623
				624	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	625	<code class="details" id="patch">patch(project, region, healthCheck, body=None, requestId=None)</code>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	626	<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.
				627
				628	Args:
				629	project: string, Project ID for this request. (required)
				630	region: string, Name of the region scoping this request. (required)
				631	healthCheck: string, Name of the HealthCheck resource to patch. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	632	body: object, The request body.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	633	The object takes the form of:
				634
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	635	{ # Represents a Health Check resource.
				636	#
				637	# Google Compute Engine has two Health Check resources:
				638	#
				639	# * [Global](/compute/docs/reference/rest/{$api_version}/healthChecks) * [Regional](/compute/docs/reference/rest/{$api_version}/regionHealthChecks)
				640	#
				641	# Internal HTTP(S) load balancers use regional health checks. All other types of GCP load balancers and managed instance group auto-healing use global health checks. For more information, read Health Check Concepts.
				642	#
				643	# To perform health checks on network load balancers, you must use either httpHealthChecks or httpsHealthChecks.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	644	"kind": "compute#healthCheck", # Type of the resource.
				645	"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
				646	"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.
				647	"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.
				648	"checkIntervalSec": 42, # How often (in seconds) to send a health check. The default value is 5 seconds.
				649	"tcpHealthCheck": {
				650	"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.
				651	"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.
				652	"portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values:
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	653	# USE_FIXED_PORT: The port number in port is used for health checking.
				654	# USE_NAMED_PORT: The portName is used for health checking.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	655	# 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.
				656	#
				657	#
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	658	# If not specified, TCP health check follows behavior specified in port and portName fields.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	659	"port": 42, # The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535.
				660	"portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
				661	"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.
				662	},
				663	"httpHealthCheck": {
				664	"requestPath": "A String", # The request path of the HTTP health check request. The default value is /.
				665	"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.
				666	"portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values:
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	667	# USE_FIXED_PORT: The port number in port is used for health checking.
				668	# USE_NAMED_PORT: The portName is used for health checking.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	669	# 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.
				670	#
				671	#
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	672	# If not specified, HTTP health check follows behavior specified in port and portName fields.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	673	"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.
				674	"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.
				675	"portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
				676	"port": 42, # The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535.
				677	},
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	678	"logConfig": { # Configuration of logging on a health check. If logging is enabled, logs will be exported to Stackdriver. # Configure logging on this health check.
				679	"enable": True or False, # Indicates whether or not to export logs. This is false by default, which means no health check logging will be done.
				680	},
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	681	"httpsHealthCheck": {
				682	"requestPath": "A String", # The request path of the HTTPS health check request. The default value is /.
				683	"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.
				684	"portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values:
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	685	# USE_FIXED_PORT: The port number in port is used for health checking.
				686	# USE_NAMED_PORT: The portName is used for health checking.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	687	# 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.
				688	#
				689	#
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	690	# If not specified, HTTPS health check follows behavior specified in port and portName fields.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	691	"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.
				692	"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.
				693	"portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
				694	"port": 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.
				695	},
				696	"healthyThreshold": 42, # A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.
				697	"http2HealthCheck": {
				698	"requestPath": "A String", # The request path of the HTTP/2 health check request. The default value is /.
				699	"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.
				700	"portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values:
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	701	# USE_FIXED_PORT: The port number in port is used for health checking.
				702	# USE_NAMED_PORT: The portName is used for health checking.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	703	# 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.
				704	#
				705	#
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	706	# If not specified, HTTP2 health check follows behavior specified in port and portName fields.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	707	"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.
				708	"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.
				709	"portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
				710	"port": 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.
				711	},
				712	"region": "A String", # [Output Only] Region where the health check resides. Not applicable to global health checks.
				713	"unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
				714	"sslHealthCheck": {
				715	"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.
				716	"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.
				717	"portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values:
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	718	# USE_FIXED_PORT: The port number in port is used for health checking.
				719	# USE_NAMED_PORT: The portName is used for health checking.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	720	# 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.
				721	#
				722	#
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	723	# If not specified, SSL health check follows behavior specified in port and portName fields.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	724	"port": 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.
				725	"portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
				726	"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.
				727	},
				728	"creationTimestamp": "A String", # [Output Only] Creation timestamp in 3339 text format.
				729	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				730	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				731	"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.
				732	}
				733
				734	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.
				735
				736	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.
				737
				738	The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
				739
				740	Returns:
				741	An object of the form:
				742
				743	{ # Represents an Operation resource.
				744	#
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	745	# Google Compute Engine has three Operation resources:
				746	#
				747	# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
				748	#
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	749	# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
				750	#
				751	# Operations can be global, regional or zonal.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	752	# - For global operations, use the `globalOperations` resource.
				753	# - For regional operations, use the `regionOperations` resource.
				754	# - For zonal operations, use the `zonalOperations` resource.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	755	#
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	756	# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	757	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				758	"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
				759	"creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	760	"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	761	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
				762	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	763	"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
				764	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	765	"progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	766	"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	767	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	768	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	769	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
				770	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
				771	{
				772	"message": "A String", # [Output Only] A human-readable description of the warning code.
				773	"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.
				774	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				775	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
				776	{
				777	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				778	"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).
				779	},
				780	],
				781	},
				782	],
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	783	"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	784	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	785	"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
				786	"name": "A String", # [Output Only] Name of the operation.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	787	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
				788	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
				789	"errors": [ # [Output Only] The array of errors encountered while processing this operation.
				790	{
				791	"message": "A String", # [Output Only] An optional, human-readable error message.
				792	"code": "A String", # [Output Only] The error type identifier for this error.
				793	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
				794	},
				795	],
				796	},
				797	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
				798	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				799	"targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
				800	}</pre>
				801	</div>
				802
				803	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	804	<code class="details" id="update">update(project, region, healthCheck, body=None, requestId=None)</code>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	805	<pre>Updates a HealthCheck resource in the specified project using the data included in the request.
				806
				807	Args:
				808	project: string, Project ID for this request. (required)
				809	region: string, Name of the region scoping this request. (required)
				810	healthCheck: string, Name of the HealthCheck resource to update. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	811	body: object, The request body.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	812	The object takes the form of:
				813
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	814	{ # Represents a Health Check resource.
				815	#
				816	# Google Compute Engine has two Health Check resources:
				817	#
				818	# * [Global](/compute/docs/reference/rest/{$api_version}/healthChecks) * [Regional](/compute/docs/reference/rest/{$api_version}/regionHealthChecks)
				819	#
				820	# Internal HTTP(S) load balancers use regional health checks. All other types of GCP load balancers and managed instance group auto-healing use global health checks. For more information, read Health Check Concepts.
				821	#
				822	# To perform health checks on network load balancers, you must use either httpHealthChecks or httpsHealthChecks.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	823	"kind": "compute#healthCheck", # Type of the resource.
				824	"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
				825	"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.
				826	"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.
				827	"checkIntervalSec": 42, # How often (in seconds) to send a health check. The default value is 5 seconds.
				828	"tcpHealthCheck": {
				829	"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.
				830	"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.
				831	"portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values:
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	832	# USE_FIXED_PORT: The port number in port is used for health checking.
				833	# USE_NAMED_PORT: The portName is used for health checking.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	834	# 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.
				835	#
				836	#
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	837	# If not specified, TCP health check follows behavior specified in port and portName fields.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	838	"port": 42, # The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535.
				839	"portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
				840	"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.
				841	},
				842	"httpHealthCheck": {
				843	"requestPath": "A String", # The request path of the HTTP health check request. The default value is /.
				844	"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.
				845	"portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values:
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	846	# USE_FIXED_PORT: The port number in port is used for health checking.
				847	# USE_NAMED_PORT: The portName is used for health checking.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	848	# 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.
				849	#
				850	#
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	851	# If not specified, HTTP health check follows behavior specified in port and portName fields.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	852	"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.
				853	"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.
				854	"portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
				855	"port": 42, # The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535.
				856	},
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	857	"logConfig": { # Configuration of logging on a health check. If logging is enabled, logs will be exported to Stackdriver. # Configure logging on this health check.
				858	"enable": True or False, # Indicates whether or not to export logs. This is false by default, which means no health check logging will be done.
				859	},
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	860	"httpsHealthCheck": {
				861	"requestPath": "A String", # The request path of the HTTPS health check request. The default value is /.
				862	"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.
				863	"portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values:
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	864	# USE_FIXED_PORT: The port number in port is used for health checking.
				865	# USE_NAMED_PORT: The portName is used for health checking.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	866	# 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.
				867	#
				868	#
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	869	# If not specified, HTTPS health check follows behavior specified in port and portName fields.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	870	"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.
				871	"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.
				872	"portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
				873	"port": 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.
				874	},
				875	"healthyThreshold": 42, # A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.
				876	"http2HealthCheck": {
				877	"requestPath": "A String", # The request path of the HTTP/2 health check request. The default value is /.
				878	"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.
				879	"portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values:
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	880	# USE_FIXED_PORT: The port number in port is used for health checking.
				881	# USE_NAMED_PORT: The portName is used for health checking.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	882	# 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.
				883	#
				884	#
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	885	# If not specified, HTTP2 health check follows behavior specified in port and portName fields.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	886	"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.
				887	"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.
				888	"portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
				889	"port": 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.
				890	},
				891	"region": "A String", # [Output Only] Region where the health check resides. Not applicable to global health checks.
				892	"unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
				893	"sslHealthCheck": {
				894	"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.
				895	"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.
				896	"portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values:
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	897	# USE_FIXED_PORT: The port number in port is used for health checking.
				898	# USE_NAMED_PORT: The portName is used for health checking.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	899	# 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.
				900	#
				901	#
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	902	# If not specified, SSL health check follows behavior specified in port and portName fields.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	903	"port": 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.
				904	"portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
				905	"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.
				906	},
				907	"creationTimestamp": "A String", # [Output Only] Creation timestamp in 3339 text format.
				908	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				909	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				910	"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.
				911	}
				912
				913	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.
				914
				915	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.
				916
				917	The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
				918
				919	Returns:
				920	An object of the form:
				921
				922	{ # Represents an Operation resource.
				923	#
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	924	# Google Compute Engine has three Operation resources:
				925	#
				926	# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
				927	#
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	928	# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
				929	#
				930	# Operations can be global, regional or zonal.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	931	# - For global operations, use the `globalOperations` resource.
				932	# - For regional operations, use the `regionOperations` resource.
				933	# - For zonal operations, use the `zonalOperations` resource.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	934	#
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	935	# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	936	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				937	"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
				938	"creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	939	"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	940	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
				941	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	942	"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
				943	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	944	"progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	945	"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	946	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	947	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	948	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
				949	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
				950	{
				951	"message": "A String", # [Output Only] A human-readable description of the warning code.
				952	"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.
				953	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				954	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
				955	{
				956	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				957	"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).
				958	},
				959	],
				960	},
				961	],
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	962	"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	963	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame^]	964	"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
				965	"name": "A String", # [Output Only] Name of the operation.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	966	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
				967	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
				968	"errors": [ # [Output Only] The array of errors encountered while processing this operation.
				969	{
				970	"message": "A String", # [Output Only] An optional, human-readable error message.
				971	"code": "A String", # [Output Only] The error type identifier for this error.
				972	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
				973	},
				974	],
				975	},
				976	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
				977	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				978	"targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
				979	}</pre>
				980	</div>
				981
				982	</body></html>