Blame - docs/dyn/compute_v1.regionHealthCheckServices.html - platform/external/python/google-api-python-client

blob: a3c61e1c8c2388229bfda5ded11723a0c6e9d9bb [file] [log] [blame]

Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -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_v1.html">Compute Engine API</a> . <a href="compute_v1.regionHealthCheckServices.html">regionHealthCheckServices</a></h1>
				76	<h2>Instance Methods</h2>
				77	<p class="toc_element">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	78	<code><a href="#close">close()</a></code></p>
				79	<p class="firstline">Close httplib2 connections.</p>
				80	<p class="toc_element">
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	81	<code><a href="#delete">delete(project, region, healthCheckService, requestId=None)</a></code></p>
				82	<p class="firstline">Deletes the specified regional HealthCheckService.</p>
				83	<p class="toc_element">
				84	<code><a href="#get">get(project, region, healthCheckService)</a></code></p>
				85	<p class="firstline">Returns the specified regional HealthCheckService resource.</p>
				86	<p class="toc_element">
				87	<code><a href="#insert">insert(project, region, body=None, requestId=None)</a></code></p>
				88	<p class="firstline">Creates a regional HealthCheckService resource in the specified project and region using the data included in the request.</p>
				89	<p class="toc_element">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	90	<code><a href="#list">list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</a></code></p>
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	91	<p class="firstline">Lists all the HealthCheckService resources that have been configured for the specified project in the given region.</p>
				92	<p class="toc_element">
				93	<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
				94	<p class="firstline">Retrieves the next page of results.</p>
				95	<p class="toc_element">
				96	<code><a href="#patch">patch(project, region, healthCheckService, body=None, requestId=None)</a></code></p>
				97	<p class="firstline">Updates the specified regional HealthCheckService resource with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.</p>
				98	<h3>Method Details</h3>
				99	<div class="method">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	100	<code class="details" id="close">close()</code>
				101	<pre>Close httplib2 connections.</pre>
				102	</div>
				103
				104	<div class="method">
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	105	<code class="details" id="delete">delete(project, region, healthCheckService, requestId=None)</code>
				106	<pre>Deletes the specified regional HealthCheckService.
				107
				108	Args:
				109	project: string, Project ID for this request. (required)
				110	region: string, Name of the region scoping this request. (required)
				111	healthCheckService: string, Name of the HealthCheckService to delete. The name must be 1-63 characters long, and comply with RFC1035. (required)
				112	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.
				113
				114	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.
				115
				116	The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
				117
				118	Returns:
				119	An object of the form:
				120
				121	{ # Represents an Operation resource.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	122	#
				123	# Google Compute Engine has three Operation resources:
				124	#
				125	# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
				126	#
				127	# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
				128	#
				129	# Operations can be global, regional or zonal.
				130	# - For global operations, use the `globalOperations` resource.
				131	# - For regional operations, use the `regionOperations` resource.
				132	# - For zonal operations, use the `zonalOperations` resource.
				133	#
				134	# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
				135	"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
				136	"creationTimestamp": "A String", # [Deprecated] This field is deprecated.
				137	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
				138	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
				139	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
				140	"errors": [ # [Output Only] The array of errors encountered while processing this operation.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	141	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	142	"code": "A String", # [Output Only] The error type identifier for this error.
				143	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
				144	"message": "A String", # [Output Only] An optional, human-readable error message.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	145	},
				146	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	147	},
				148	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
				149	"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.
				150	"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
				151	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				152	"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
				153	"name": "A String", # [Output Only] Name of the operation.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	154	"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	155	"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
				156	"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.
				157	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
				158	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				159	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				160	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
				161	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
				162	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				163	"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.
				164	"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
				165	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
				166	{
				167	"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.
				168	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				169	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
				170	{
				171	"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).
				172	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				173	},
				174	],
				175	"message": "A String", # [Output Only] A human-readable description of the warning code.
				176	},
				177	],
				178	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
				179	}</pre>
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	180	</div>
				181
				182	<div class="method">
				183	<code class="details" id="get">get(project, region, healthCheckService)</code>
				184	<pre>Returns the specified regional HealthCheckService resource.
				185
				186	Args:
				187	project: string, Project ID for this request. (required)
				188	region: string, Name of the region scoping this request. (required)
				189	healthCheckService: string, Name of the HealthCheckService to update. The name must be 1-63 characters long, and comply with RFC1035. (required)
				190
				191	Returns:
				192	An object of the form:
				193
				194	{ # Represents a Health-Check as a Service resource.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	195	#
				196	# (== resource_for {$api_version}.regionHealthCheckServices ==)
				197	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
				198	"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
				199	"fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a HealthCheckService. An up-to-date fingerprint must be provided in order to patch/update the HealthCheckService; Otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the HealthCheckService.
yoshi-code-bot	c2cd326	2021-05-16 02:16:04 -0700	[diff] [blame]	200	"healthChecks": [ # List of URLs to the HealthCheck resources. Must have at least one HealthCheck, and not more than 10. HealthCheck resources must have portSpecification=USE_SERVING_PORT or portSpecification=USE_FIXED_PORT. For regional HealthCheckService, the HealthCheck must be regional and in the same region. For global HealthCheckService, HealthCheck must be global. Mix of regional and global HealthChecks is not supported. Multiple regional HealthChecks must belong to the same region. Regional HealthChecks must belong to the same region as zones of NEGs.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	201	"A String",
				202	],
				203	"healthStatusAggregationPolicy": "A String", # Optional. Policy for how the results from multiple health checks for the same endpoint are aggregated. Defaults to NO_AGGREGATION if unspecified.
				204	# - NO_AGGREGATION. An EndpointHealth message is returned for each backend in the health check service.
				205	# - AND. If any backend's health check reports UNHEALTHY, then UNHEALTHY is the HealthState of the entire health check service. If all backend's are healthy, the HealthState of the health check service is HEALTHY. .
				206	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				207	"kind": "compute#healthCheckService", # [Output only] Type of the resource. Always compute#healthCheckServicefor health check services.
				208	"name": "A String", # Name of the resource. 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.
				209	"networkEndpointGroups": [ # List of URLs to the NetworkEndpointGroup resources. Must not have more than 100. For regional HealthCheckService, NEGs must be in zones in the region of the HealthCheckService.
				210	"A String",
				211	],
				212	"notificationEndpoints": [ # List of URLs to the NotificationEndpoint resources. Must not have more than 10. A list of endpoints for receiving notifications of change in health status. For regional HealthCheckService, NotificationEndpoint must be regional and in the same region. For global HealthCheckService, NotificationEndpoint must be global.
				213	"A String",
				214	],
				215	"region": "A String", # [Output Only] URL of the region where the health check service resides. This field is not applicable to global health check services. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
				216	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				217	}</pre>
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	218	</div>
				219
				220	<div class="method">
				221	<code class="details" id="insert">insert(project, region, body=None, requestId=None)</code>
				222	<pre>Creates a regional HealthCheckService resource in the specified project and region using the data included in the request.
				223
				224	Args:
				225	project: string, Project ID for this request. (required)
				226	region: string, Name of the region scoping this request. (required)
				227	body: object, The request body.
				228	The object takes the form of:
				229
				230	{ # Represents a Health-Check as a Service resource.
				231	#
				232	# (== resource_for {$api_version}.regionHealthCheckServices ==)
				233	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
				234	"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
				235	"fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a HealthCheckService. An up-to-date fingerprint must be provided in order to patch/update the HealthCheckService; Otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the HealthCheckService.
yoshi-code-bot	c2cd326	2021-05-16 02:16:04 -0700	[diff] [blame]	236	"healthChecks": [ # List of URLs to the HealthCheck resources. Must have at least one HealthCheck, and not more than 10. HealthCheck resources must have portSpecification=USE_SERVING_PORT or portSpecification=USE_FIXED_PORT. For regional HealthCheckService, the HealthCheck must be regional and in the same region. For global HealthCheckService, HealthCheck must be global. Mix of regional and global HealthChecks is not supported. Multiple regional HealthChecks must belong to the same region. Regional HealthChecks must belong to the same region as zones of NEGs.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	237	"A String",
				238	],
				239	"healthStatusAggregationPolicy": "A String", # Optional. Policy for how the results from multiple health checks for the same endpoint are aggregated. Defaults to NO_AGGREGATION if unspecified.
				240	# - NO_AGGREGATION. An EndpointHealth message is returned for each backend in the health check service.
				241	# - AND. If any backend's health check reports UNHEALTHY, then UNHEALTHY is the HealthState of the entire health check service. If all backend's are healthy, the HealthState of the health check service is HEALTHY. .
				242	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				243	"kind": "compute#healthCheckService", # [Output only] Type of the resource. Always compute#healthCheckServicefor health check services.
				244	"name": "A String", # Name of the resource. 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.
				245	"networkEndpointGroups": [ # List of URLs to the NetworkEndpointGroup resources. Must not have more than 100. For regional HealthCheckService, NEGs must be in zones in the region of the HealthCheckService.
				246	"A String",
				247	],
				248	"notificationEndpoints": [ # List of URLs to the NotificationEndpoint resources. Must not have more than 10. A list of endpoints for receiving notifications of change in health status. For regional HealthCheckService, NotificationEndpoint must be regional and in the same region. For global HealthCheckService, NotificationEndpoint must be global.
				249	"A String",
				250	],
				251	"region": "A String", # [Output Only] URL of the region where the health check service resides. This field is not applicable to global health check services. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
				252	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				253	}
				254
				255	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.
				256
				257	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.
				258
				259	The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
				260
				261	Returns:
				262	An object of the form:
				263
				264	{ # Represents an Operation resource.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	265	#
				266	# Google Compute Engine has three Operation resources:
				267	#
				268	# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
				269	#
				270	# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
				271	#
				272	# Operations can be global, regional or zonal.
				273	# - For global operations, use the `globalOperations` resource.
				274	# - For regional operations, use the `regionOperations` resource.
				275	# - For zonal operations, use the `zonalOperations` resource.
				276	#
				277	# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
				278	"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
				279	"creationTimestamp": "A String", # [Deprecated] This field is deprecated.
				280	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
				281	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
				282	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
				283	"errors": [ # [Output Only] The array of errors encountered while processing this operation.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	284	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	285	"code": "A String", # [Output Only] The error type identifier for this error.
				286	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
				287	"message": "A String", # [Output Only] An optional, human-readable error message.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	288	},
				289	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	290	},
				291	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
				292	"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.
				293	"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
				294	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				295	"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
				296	"name": "A String", # [Output Only] Name of the operation.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	297	"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	298	"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
				299	"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.
				300	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
				301	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				302	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				303	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
				304	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
				305	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				306	"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.
				307	"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
				308	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
				309	{
				310	"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.
				311	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				312	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
				313	{
				314	"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).
				315	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				316	},
				317	],
				318	"message": "A String", # [Output Only] A human-readable description of the warning code.
				319	},
				320	],
				321	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
				322	}</pre>
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	323	</div>
				324
				325	<div class="method">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	326	<code class="details" id="list">list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</code>
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	327	<pre>Lists all the HealthCheckService resources that have been configured for the specified project in the given region.
				328
				329	Args:
				330	project: string, Project ID for this request. (required)
				331	region: string, Name of the region scoping this request. (required)
				332	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 `<`.
				333
				334	For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.
				335
				336	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.
				337
				338	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) ```
				339	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`)
				340	orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
				341
				342	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.
				343
				344	Currently, only sorting by `name` or `creationTimestamp desc` is supported.
				345	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.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	346	returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	347
				348	Returns:
				349	An object of the form:
				350
				351	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	352	"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
				353	"items": [ # A list of HealthCheckService resources.
				354	{ # Represents a Health-Check as a Service resource.
				355	#
				356	# (== resource_for {$api_version}.regionHealthCheckServices ==)
				357	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
				358	"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
				359	"fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a HealthCheckService. An up-to-date fingerprint must be provided in order to patch/update the HealthCheckService; Otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the HealthCheckService.
yoshi-code-bot	c2cd326	2021-05-16 02:16:04 -0700	[diff] [blame]	360	"healthChecks": [ # List of URLs to the HealthCheck resources. Must have at least one HealthCheck, and not more than 10. HealthCheck resources must have portSpecification=USE_SERVING_PORT or portSpecification=USE_FIXED_PORT. For regional HealthCheckService, the HealthCheck must be regional and in the same region. For global HealthCheckService, HealthCheck must be global. Mix of regional and global HealthChecks is not supported. Multiple regional HealthChecks must belong to the same region. Regional HealthChecks must belong to the same region as zones of NEGs.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	361	"A String",
				362	],
				363	"healthStatusAggregationPolicy": "A String", # Optional. Policy for how the results from multiple health checks for the same endpoint are aggregated. Defaults to NO_AGGREGATION if unspecified.
				364	# - NO_AGGREGATION. An EndpointHealth message is returned for each backend in the health check service.
				365	# - AND. If any backend's health check reports UNHEALTHY, then UNHEALTHY is the HealthState of the entire health check service. If all backend's are healthy, the HealthState of the health check service is HEALTHY. .
				366	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				367	"kind": "compute#healthCheckService", # [Output only] Type of the resource. Always compute#healthCheckServicefor health check services.
				368	"name": "A String", # Name of the resource. 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.
				369	"networkEndpointGroups": [ # List of URLs to the NetworkEndpointGroup resources. Must not have more than 100. For regional HealthCheckService, NEGs must be in zones in the region of the HealthCheckService.
				370	"A String",
				371	],
				372	"notificationEndpoints": [ # List of URLs to the NotificationEndpoint resources. Must not have more than 10. A list of endpoints for receiving notifications of change in health status. For regional HealthCheckService, NotificationEndpoint must be regional and in the same region. For global HealthCheckService, NotificationEndpoint must be global.
				373	"A String",
				374	],
				375	"region": "A String", # [Output Only] URL of the region where the health check service resides. This field is not applicable to global health check services. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
				376	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				377	},
				378	],
				379	"kind": "compute#healthCheckServicesList", # [Output Only] Type of the resource. Always compute#healthCheckServicesList for lists of HealthCheckServices.
				380	"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.
				381	"selfLink": "A String", # [Output Only] Server-defined URL for this resource.
				382	"warning": { # [Output Only] Informational warning message.
				383	"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.
				384	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				385	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
				386	{
				387	"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).
				388	"value": "A String", # [Output Only] A warning data value corresponding to the key.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	389	},
				390	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	391	"message": "A String", # [Output Only] A human-readable description of the warning code.
				392	},
				393	}</pre>
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	394	</div>
				395
				396	<div class="method">
				397	<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
				398	<pre>Retrieves the next page of results.
				399
				400	Args:
				401	previous_request: The request for the previous page. (required)
				402	previous_response: The response from the request for the previous page. (required)
				403
				404	Returns:
				405	A request object that you can call 'execute()' on to request the next
				406	page. Returns None if there are no more items in the collection.
				407	</pre>
				408	</div>
				409
				410	<div class="method">
				411	<code class="details" id="patch">patch(project, region, healthCheckService, body=None, requestId=None)</code>
				412	<pre>Updates the specified regional HealthCheckService resource with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.
				413
				414	Args:
				415	project: string, Project ID for this request. (required)
				416	region: string, Name of the region scoping this request. (required)
				417	healthCheckService: string, Name of the HealthCheckService to update. The name must be 1-63 characters long, and comply with RFC1035. (required)
				418	body: object, The request body.
				419	The object takes the form of:
				420
				421	{ # Represents a Health-Check as a Service resource.
				422	#
				423	# (== resource_for {$api_version}.regionHealthCheckServices ==)
				424	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
				425	"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
				426	"fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a HealthCheckService. An up-to-date fingerprint must be provided in order to patch/update the HealthCheckService; Otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the HealthCheckService.
yoshi-code-bot	c2cd326	2021-05-16 02:16:04 -0700	[diff] [blame]	427	"healthChecks": [ # List of URLs to the HealthCheck resources. Must have at least one HealthCheck, and not more than 10. HealthCheck resources must have portSpecification=USE_SERVING_PORT or portSpecification=USE_FIXED_PORT. For regional HealthCheckService, the HealthCheck must be regional and in the same region. For global HealthCheckService, HealthCheck must be global. Mix of regional and global HealthChecks is not supported. Multiple regional HealthChecks must belong to the same region. Regional HealthChecks must belong to the same region as zones of NEGs.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	428	"A String",
				429	],
				430	"healthStatusAggregationPolicy": "A String", # Optional. Policy for how the results from multiple health checks for the same endpoint are aggregated. Defaults to NO_AGGREGATION if unspecified.
				431	# - NO_AGGREGATION. An EndpointHealth message is returned for each backend in the health check service.
				432	# - AND. If any backend's health check reports UNHEALTHY, then UNHEALTHY is the HealthState of the entire health check service. If all backend's are healthy, the HealthState of the health check service is HEALTHY. .
				433	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				434	"kind": "compute#healthCheckService", # [Output only] Type of the resource. Always compute#healthCheckServicefor health check services.
				435	"name": "A String", # Name of the resource. 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.
				436	"networkEndpointGroups": [ # List of URLs to the NetworkEndpointGroup resources. Must not have more than 100. For regional HealthCheckService, NEGs must be in zones in the region of the HealthCheckService.
				437	"A String",
				438	],
				439	"notificationEndpoints": [ # List of URLs to the NotificationEndpoint resources. Must not have more than 10. A list of endpoints for receiving notifications of change in health status. For regional HealthCheckService, NotificationEndpoint must be regional and in the same region. For global HealthCheckService, NotificationEndpoint must be global.
				440	"A String",
				441	],
				442	"region": "A String", # [Output Only] URL of the region where the health check service resides. This field is not applicable to global health check services. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
				443	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				444	}
				445
				446	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.
				447
				448	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.
				449
				450	The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
				451
				452	Returns:
				453	An object of the form:
				454
				455	{ # Represents an Operation resource.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	456	#
				457	# Google Compute Engine has three Operation resources:
				458	#
				459	# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
				460	#
				461	# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
				462	#
				463	# Operations can be global, regional or zonal.
				464	# - For global operations, use the `globalOperations` resource.
				465	# - For regional operations, use the `regionOperations` resource.
				466	# - For zonal operations, use the `zonalOperations` resource.
				467	#
				468	# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
				469	"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
				470	"creationTimestamp": "A String", # [Deprecated] This field is deprecated.
				471	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
				472	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
				473	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
				474	"errors": [ # [Output Only] The array of errors encountered while processing this operation.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	475	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	476	"code": "A String", # [Output Only] The error type identifier for this error.
				477	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
				478	"message": "A String", # [Output Only] An optional, human-readable error message.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	479	},
				480	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	481	},
				482	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
				483	"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.
				484	"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
				485	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				486	"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
				487	"name": "A String", # [Output Only] Name of the operation.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	488	"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	489	"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
				490	"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.
				491	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
				492	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				493	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				494	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
				495	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
				496	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				497	"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.
				498	"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
				499	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
				500	{
				501	"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.
				502	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				503	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
				504	{
				505	"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).
				506	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				507	},
				508	],
				509	"message": "A String", # [Output Only] A human-readable description of the warning code.
				510	},
				511	],
				512	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
				513	}</pre>
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	514	</div>
				515
				516	</body></html>