blob: 245205f27c1d0c1cd21196ed63220c0763aa5877 [file] [log] [blame]
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -07001<html><body>
2<style>
3
4body, 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
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, 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.healthChecks.html">healthChecks</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Bu Sun Kim65020912020-05-20 12:08:20 -070078 <code><a href="#aggregatedList">aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None)</a></code></p>
Dan O'Mearadd494642020-05-01 07:42:23 -070079<p class="firstline">Retrieves the list of all HealthCheck resources, regional and global, available to the specified project.</p>
80<p class="toc_element">
81 <code><a href="#aggregatedList_next">aggregatedList_next(previous_request, previous_response)</a></code></p>
82<p class="firstline">Retrieves the next page of results.</p>
83<p class="toc_element">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070084 <code><a href="#delete">delete(project, healthCheck, requestId=None)</a></code></p>
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -070085<p class="firstline">Deletes the specified HealthCheck resource.</p>
86<p class="toc_element">
87 <code><a href="#get">get(project, healthCheck)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070088<p class="firstline">Returns the specified HealthCheck resource. Gets a list of available health checks by making a list() request.</p>
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -070089<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070090 <code><a href="#insert">insert(project, body=None, requestId=None)</a></code></p>
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -070091<p class="firstline">Creates a HealthCheck resource in the specified project using the data included in the request.</p>
92<p class="toc_element">
Bu Sun Kim65020912020-05-20 12:08:20 -070093 <code><a href="#list">list(project, filter=None, maxResults=None, orderBy=None, pageToken=None)</a></code></p>
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -070094<p class="firstline">Retrieves the list of HealthCheck resources available to the specified project.</p>
95<p class="toc_element">
96 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
97<p class="firstline">Retrieves the next page of results.</p>
98<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070099 <code><a href="#patch">patch(project, healthCheck, body=None, requestId=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700100<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>
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700101<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700102 <code><a href="#update">update(project, healthCheck, body=None, requestId=None)</a></code></p>
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700103<p class="firstline">Updates a HealthCheck resource in the specified project using the data included in the request.</p>
104<h3>Method Details</h3>
105<div class="method">
Bu Sun Kim65020912020-05-20 12:08:20 -0700106 <code class="details" id="aggregatedList">aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None)</code>
Dan O'Mearadd494642020-05-01 07:42:23 -0700107 <pre>Retrieves the list of all HealthCheck resources, regional and global, available to the specified project.
108
109Args:
110 project: string, Name of the project scoping this request. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700111 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 `=`, `!=`, `&gt;`, or `&lt;`.
112
113For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.
114
115You 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.
116
Bu Sun Kim65020912020-05-20 12:08:20 -0700117To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = &quot;Intel Skylake&quot;) ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = &quot;Intel Skylake&quot;) OR (cpuPlatform = &quot;Intel Broadwell&quot;) AND (scheduling.automaticRestart = true) ```
Dan O'Mearadd494642020-05-01 07:42:23 -0700118 includeAllScopes: boolean, Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.
Bu Sun Kim65020912020-05-20 12:08:20 -0700119 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`)
120 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
121
122You can also sort results in descending order based on the creation timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. 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.
123
124Currently, only sorting by `name` or `creationTimestamp desc` is supported.
125 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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700126
127Returns:
128 An object of the form:
129
130 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700131 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
132 &quot;items&quot;: { # A list of HealthChecksScopedList resources.
133 &quot;a_key&quot;: { # Name of the scope containing this set of HealthChecks.
134 &quot;healthChecks&quot;: [ # A list of HealthChecks contained in this scope.
Dan O'Mearadd494642020-05-01 07:42:23 -0700135 { # Represents a Health Check resource.
Bu Sun Kim65020912020-05-20 12:08:20 -0700136 #
137 # Google Compute Engine has two Health Check resources:
138 #
139 # * [Global](/compute/docs/reference/rest/{$api_version}/healthChecks) * [Regional](/compute/docs/reference/rest/{$api_version}/regionHealthChecks)
140 #
141 # 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.
142 #
143 # To perform health checks on network load balancers, you must use either httpHealthChecks or httpsHealthChecks.
144 &quot;checkIntervalSec&quot;: 42, # How often (in seconds) to send a health check. The default value is 5 seconds.
145 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Output Only] Creation timestamp in 3339 text format.
146 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you create the resource.
147 &quot;healthyThreshold&quot;: 42, # A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.
148 &quot;http2HealthCheck&quot;: {
149 &quot;host&quot;: &quot;A String&quot;, # 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.
150 &quot;port&quot;: 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.
151 &quot;portName&quot;: &quot;A String&quot;, # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
152 &quot;portSpecification&quot;: &quot;A String&quot;, # Specifies how port is selected for health checking, can be one of following values:
153 # USE_FIXED_PORT: The port number in port is used for health checking.
154 # USE_NAMED_PORT: The portName is used for health checking.
155 # 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.
156 #
157 #
158 # If not specified, HTTP2 health check follows behavior specified in port and portName fields.
159 &quot;proxyHeader&quot;: &quot;A String&quot;, # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
160 &quot;requestPath&quot;: &quot;A String&quot;, # The request path of the HTTP/2 health check request. The default value is /.
161 &quot;response&quot;: &quot;A String&quot;, # 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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700162 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700163 &quot;httpHealthCheck&quot;: {
164 &quot;host&quot;: &quot;A String&quot;, # 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.
165 &quot;port&quot;: 42, # The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535.
166 &quot;portName&quot;: &quot;A String&quot;, # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
167 &quot;portSpecification&quot;: &quot;A String&quot;, # Specifies how port is selected for health checking, can be one of following values:
168 # USE_FIXED_PORT: The port number in port is used for health checking.
169 # USE_NAMED_PORT: The portName is used for health checking.
170 # 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.
171 #
172 #
173 # If not specified, HTTP health check follows behavior specified in port and portName fields.
174 &quot;proxyHeader&quot;: &quot;A String&quot;, # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
175 &quot;requestPath&quot;: &quot;A String&quot;, # The request path of the HTTP health check request. The default value is /.
176 &quot;response&quot;: &quot;A String&quot;, # 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.
177 },
178 &quot;httpsHealthCheck&quot;: {
179 &quot;host&quot;: &quot;A String&quot;, # 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.
180 &quot;port&quot;: 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.
181 &quot;portName&quot;: &quot;A String&quot;, # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
182 &quot;portSpecification&quot;: &quot;A String&quot;, # Specifies how port is selected for health checking, can be one of following values:
183 # USE_FIXED_PORT: The port number in port is used for health checking.
184 # USE_NAMED_PORT: The portName is used for health checking.
185 # 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.
186 #
187 #
188 # If not specified, HTTPS health check follows behavior specified in port and portName fields.
189 &quot;proxyHeader&quot;: &quot;A String&quot;, # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
190 &quot;requestPath&quot;: &quot;A String&quot;, # The request path of the HTTPS health check request. The default value is /.
191 &quot;response&quot;: &quot;A String&quot;, # 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.
192 },
193 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
194 &quot;kind&quot;: &quot;compute#healthCheck&quot;, # Type of the resource.
195 &quot;name&quot;: &quot;A String&quot;, # 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.
196 &quot;region&quot;: &quot;A String&quot;, # [Output Only] Region where the health check resides. Not applicable to global health checks.
197 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
198 &quot;sslHealthCheck&quot;: {
199 &quot;port&quot;: 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.
200 &quot;portName&quot;: &quot;A String&quot;, # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
201 &quot;portSpecification&quot;: &quot;A String&quot;, # Specifies how port is selected for health checking, can be one of following values:
202 # USE_FIXED_PORT: The port number in port is used for health checking.
203 # USE_NAMED_PORT: The portName is used for health checking.
204 # 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.
205 #
206 #
207 # If not specified, SSL health check follows behavior specified in port and portName fields.
208 &quot;proxyHeader&quot;: &quot;A String&quot;, # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
209 &quot;request&quot;: &quot;A String&quot;, # 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.
210 &quot;response&quot;: &quot;A String&quot;, # 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.
211 },
212 &quot;tcpHealthCheck&quot;: {
213 &quot;port&quot;: 42, # The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535.
214 &quot;portName&quot;: &quot;A String&quot;, # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
215 &quot;portSpecification&quot;: &quot;A String&quot;, # Specifies how port is selected for health checking, can be one of following values:
216 # USE_FIXED_PORT: The port number in port is used for health checking.
217 # USE_NAMED_PORT: The portName is used for health checking.
218 # 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.
219 #
220 #
221 # If not specified, TCP health check follows behavior specified in port and portName fields.
222 &quot;proxyHeader&quot;: &quot;A String&quot;, # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
223 &quot;request&quot;: &quot;A String&quot;, # 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.
224 &quot;response&quot;: &quot;A String&quot;, # 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.
225 },
226 &quot;timeoutSec&quot;: 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.
227 &quot;type&quot;: &quot;A String&quot;, # 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.
228 &quot;unhealthyThreshold&quot;: 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
229 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700230 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700231 &quot;warning&quot;: { # Informational warning which replaces the list of backend services when the list is empty.
232 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
233 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example:
234 # &quot;data&quot;: [ { &quot;key&quot;: &quot;scope&quot;, &quot;value&quot;: &quot;zones/us-east1-d&quot; }
Dan O'Mearadd494642020-05-01 07:42:23 -0700235 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700236 &quot;key&quot;: &quot;A String&quot;, # [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).
237 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
Dan O'Mearadd494642020-05-01 07:42:23 -0700238 },
239 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700240 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
Dan O'Mearadd494642020-05-01 07:42:23 -0700241 },
242 },
243 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700244 &quot;kind&quot;: &quot;compute#healthChecksAggregatedList&quot;, # Type of resource.
245 &quot;nextPageToken&quot;: &quot;A String&quot;, # [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.
246 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for this resource.
247 &quot;warning&quot;: { # [Output Only] Informational warning message.
248 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
249 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example:
250 # &quot;data&quot;: [ { &quot;key&quot;: &quot;scope&quot;, &quot;value&quot;: &quot;zones/us-east1-d&quot; }
Dan O'Mearadd494642020-05-01 07:42:23 -0700251 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700252 &quot;key&quot;: &quot;A String&quot;, # [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).
253 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
Dan O'Mearadd494642020-05-01 07:42:23 -0700254 },
255 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700256 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
Dan O'Mearadd494642020-05-01 07:42:23 -0700257 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700258 }</pre>
259</div>
260
261<div class="method">
262 <code class="details" id="aggregatedList_next">aggregatedList_next(previous_request, previous_response)</code>
263 <pre>Retrieves the next page of results.
264
265Args:
266 previous_request: The request for the previous page. (required)
267 previous_response: The response from the request for the previous page. (required)
268
269Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700270 A request object that you can call &#x27;execute()&#x27; on to request the next
Dan O'Mearadd494642020-05-01 07:42:23 -0700271 page. Returns None if there are no more items in the collection.
272 </pre>
273</div>
274
275<div class="method">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700276 <code class="details" id="delete">delete(project, healthCheck, requestId=None)</code>
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700277 <pre>Deletes the specified HealthCheck resource.
278
279Args:
280 project: string, Project ID for this request. (required)
281 healthCheck: string, Name of the HealthCheck resource to delete. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700282 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.
283
284For 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.
285
286The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700287
288Returns:
289 An object of the form:
290
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700291 { # Represents an Operation resource.
292 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700293 # Google Compute Engine has three Operation resources:
294 #
295 # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
296 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700297 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
298 #
299 # Operations can be global, regional or zonal.
Dan O'Mearadd494642020-05-01 07:42:23 -0700300 # - For global operations, use the `globalOperations` resource.
301 # - For regional operations, use the `regionOperations` resource.
302 # - For zonal operations, use the `zonalOperations` resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700303 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700304 # 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 Kim65020912020-05-20 12:08:20 -0700305 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
306 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
307 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is set when the operation is created.
308 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
309 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
310 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this operation.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700311 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700312 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
313 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error. This property is optional.
314 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700315 },
316 ],
317 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700318 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
319 &quot;httpErrorStatusCode&quot;: 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.
320 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
321 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
322 &quot;kind&quot;: &quot;compute#operation&quot;, # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
323 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
324 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
325 &quot;progress&quot;: 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.
326 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
327 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
328 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
329 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
330 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the operation.
331 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
332 &quot;targetLink&quot;: &quot;A String&quot;, # [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.
333 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example: `user@example.com`.
334 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
335 {
336 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
337 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example:
338 # &quot;data&quot;: [ { &quot;key&quot;: &quot;scope&quot;, &quot;value&quot;: &quot;zones/us-east1-d&quot; }
339 {
340 &quot;key&quot;: &quot;A String&quot;, # [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).
341 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
342 },
343 ],
344 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
345 },
346 ],
347 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700348 }</pre>
349</div>
350
351<div class="method">
352 <code class="details" id="get">get(project, healthCheck)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700353 <pre>Returns the specified HealthCheck resource. Gets a list of available health checks by making a list() request.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700354
355Args:
356 project: string, Project ID for this request. (required)
357 healthCheck: string, Name of the HealthCheck resource to return. (required)
358
359Returns:
360 An object of the form:
361
Dan O'Mearadd494642020-05-01 07:42:23 -0700362 { # Represents a Health Check resource.
Bu Sun Kim65020912020-05-20 12:08:20 -0700363 #
364 # Google Compute Engine has two Health Check resources:
365 #
366 # * [Global](/compute/docs/reference/rest/{$api_version}/healthChecks) * [Regional](/compute/docs/reference/rest/{$api_version}/regionHealthChecks)
367 #
368 # 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.
369 #
370 # To perform health checks on network load balancers, you must use either httpHealthChecks or httpsHealthChecks.
371 &quot;checkIntervalSec&quot;: 42, # How often (in seconds) to send a health check. The default value is 5 seconds.
372 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Output Only] Creation timestamp in 3339 text format.
373 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you create the resource.
374 &quot;healthyThreshold&quot;: 42, # A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.
375 &quot;http2HealthCheck&quot;: {
376 &quot;host&quot;: &quot;A String&quot;, # 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.
377 &quot;port&quot;: 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.
378 &quot;portName&quot;: &quot;A String&quot;, # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
379 &quot;portSpecification&quot;: &quot;A String&quot;, # Specifies how port is selected for health checking, can be one of following values:
380 # USE_FIXED_PORT: The port number in port is used for health checking.
381 # USE_NAMED_PORT: The portName is used for health checking.
382 # 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.
383 #
384 #
385 # If not specified, HTTP2 health check follows behavior specified in port and portName fields.
386 &quot;proxyHeader&quot;: &quot;A String&quot;, # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
387 &quot;requestPath&quot;: &quot;A String&quot;, # The request path of the HTTP/2 health check request. The default value is /.
388 &quot;response&quot;: &quot;A String&quot;, # 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.
389 },
390 &quot;httpHealthCheck&quot;: {
391 &quot;host&quot;: &quot;A String&quot;, # 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.
392 &quot;port&quot;: 42, # The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535.
393 &quot;portName&quot;: &quot;A String&quot;, # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
394 &quot;portSpecification&quot;: &quot;A String&quot;, # Specifies how port is selected for health checking, can be one of following values:
395 # USE_FIXED_PORT: The port number in port is used for health checking.
396 # USE_NAMED_PORT: The portName is used for health checking.
397 # 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.
398 #
399 #
400 # If not specified, HTTP health check follows behavior specified in port and portName fields.
401 &quot;proxyHeader&quot;: &quot;A String&quot;, # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
402 &quot;requestPath&quot;: &quot;A String&quot;, # The request path of the HTTP health check request. The default value is /.
403 &quot;response&quot;: &quot;A String&quot;, # 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.
404 },
405 &quot;httpsHealthCheck&quot;: {
406 &quot;host&quot;: &quot;A String&quot;, # 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.
407 &quot;port&quot;: 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.
408 &quot;portName&quot;: &quot;A String&quot;, # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
409 &quot;portSpecification&quot;: &quot;A String&quot;, # Specifies how port is selected for health checking, can be one of following values:
410 # USE_FIXED_PORT: The port number in port is used for health checking.
411 # USE_NAMED_PORT: The portName is used for health checking.
412 # 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.
413 #
414 #
415 # If not specified, HTTPS health check follows behavior specified in port and portName fields.
416 &quot;proxyHeader&quot;: &quot;A String&quot;, # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
417 &quot;requestPath&quot;: &quot;A String&quot;, # The request path of the HTTPS health check request. The default value is /.
418 &quot;response&quot;: &quot;A String&quot;, # 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.
419 },
420 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
421 &quot;kind&quot;: &quot;compute#healthCheck&quot;, # Type of the resource.
422 &quot;name&quot;: &quot;A String&quot;, # 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.
423 &quot;region&quot;: &quot;A String&quot;, # [Output Only] Region where the health check resides. Not applicable to global health checks.
424 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
425 &quot;sslHealthCheck&quot;: {
426 &quot;port&quot;: 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.
427 &quot;portName&quot;: &quot;A String&quot;, # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
428 &quot;portSpecification&quot;: &quot;A String&quot;, # Specifies how port is selected for health checking, can be one of following values:
429 # USE_FIXED_PORT: The port number in port is used for health checking.
430 # USE_NAMED_PORT: The portName is used for health checking.
431 # 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.
432 #
433 #
434 # If not specified, SSL health check follows behavior specified in port and portName fields.
435 &quot;proxyHeader&quot;: &quot;A String&quot;, # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
436 &quot;request&quot;: &quot;A String&quot;, # 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.
437 &quot;response&quot;: &quot;A String&quot;, # 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.
438 },
439 &quot;tcpHealthCheck&quot;: {
440 &quot;port&quot;: 42, # The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535.
441 &quot;portName&quot;: &quot;A String&quot;, # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
442 &quot;portSpecification&quot;: &quot;A String&quot;, # Specifies how port is selected for health checking, can be one of following values:
443 # USE_FIXED_PORT: The port number in port is used for health checking.
444 # USE_NAMED_PORT: The portName is used for health checking.
445 # 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.
446 #
447 #
448 # If not specified, TCP health check follows behavior specified in port and portName fields.
449 &quot;proxyHeader&quot;: &quot;A String&quot;, # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
450 &quot;request&quot;: &quot;A String&quot;, # 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.
451 &quot;response&quot;: &quot;A String&quot;, # 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.
452 },
453 &quot;timeoutSec&quot;: 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.
454 &quot;type&quot;: &quot;A String&quot;, # 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.
455 &quot;unhealthyThreshold&quot;: 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
456 }</pre>
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700457</div>
458
459<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700460 <code class="details" id="insert">insert(project, body=None, requestId=None)</code>
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700461 <pre>Creates a HealthCheck resource in the specified project using the data included in the request.
462
463Args:
464 project: string, Project ID for this request. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700465 body: object, The request body.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700466 The object takes the form of:
467
Dan O'Mearadd494642020-05-01 07:42:23 -0700468{ # Represents a Health Check resource.
Bu Sun Kim65020912020-05-20 12:08:20 -0700469 #
470 # Google Compute Engine has two Health Check resources:
471 #
472 # * [Global](/compute/docs/reference/rest/{$api_version}/healthChecks) * [Regional](/compute/docs/reference/rest/{$api_version}/regionHealthChecks)
473 #
474 # 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.
475 #
476 # To perform health checks on network load balancers, you must use either httpHealthChecks or httpsHealthChecks.
477 &quot;checkIntervalSec&quot;: 42, # How often (in seconds) to send a health check. The default value is 5 seconds.
478 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Output Only] Creation timestamp in 3339 text format.
479 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you create the resource.
480 &quot;healthyThreshold&quot;: 42, # A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.
481 &quot;http2HealthCheck&quot;: {
482 &quot;host&quot;: &quot;A String&quot;, # 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.
483 &quot;port&quot;: 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.
484 &quot;portName&quot;: &quot;A String&quot;, # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
485 &quot;portSpecification&quot;: &quot;A String&quot;, # Specifies how port is selected for health checking, can be one of following values:
486 # USE_FIXED_PORT: The port number in port is used for health checking.
487 # USE_NAMED_PORT: The portName is used for health checking.
488 # 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.
489 #
490 #
491 # If not specified, HTTP2 health check follows behavior specified in port and portName fields.
492 &quot;proxyHeader&quot;: &quot;A String&quot;, # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
493 &quot;requestPath&quot;: &quot;A String&quot;, # The request path of the HTTP/2 health check request. The default value is /.
494 &quot;response&quot;: &quot;A String&quot;, # 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.
495 },
496 &quot;httpHealthCheck&quot;: {
497 &quot;host&quot;: &quot;A String&quot;, # 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.
498 &quot;port&quot;: 42, # The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535.
499 &quot;portName&quot;: &quot;A String&quot;, # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
500 &quot;portSpecification&quot;: &quot;A String&quot;, # Specifies how port is selected for health checking, can be one of following values:
501 # USE_FIXED_PORT: The port number in port is used for health checking.
502 # USE_NAMED_PORT: The portName is used for health checking.
503 # 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.
504 #
505 #
506 # If not specified, HTTP health check follows behavior specified in port and portName fields.
507 &quot;proxyHeader&quot;: &quot;A String&quot;, # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
508 &quot;requestPath&quot;: &quot;A String&quot;, # The request path of the HTTP health check request. The default value is /.
509 &quot;response&quot;: &quot;A String&quot;, # 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.
510 },
511 &quot;httpsHealthCheck&quot;: {
512 &quot;host&quot;: &quot;A String&quot;, # 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.
513 &quot;port&quot;: 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.
514 &quot;portName&quot;: &quot;A String&quot;, # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
515 &quot;portSpecification&quot;: &quot;A String&quot;, # Specifies how port is selected for health checking, can be one of following values:
516 # USE_FIXED_PORT: The port number in port is used for health checking.
517 # USE_NAMED_PORT: The portName is used for health checking.
518 # 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.
519 #
520 #
521 # If not specified, HTTPS health check follows behavior specified in port and portName fields.
522 &quot;proxyHeader&quot;: &quot;A String&quot;, # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
523 &quot;requestPath&quot;: &quot;A String&quot;, # The request path of the HTTPS health check request. The default value is /.
524 &quot;response&quot;: &quot;A String&quot;, # 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.
525 },
526 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
527 &quot;kind&quot;: &quot;compute#healthCheck&quot;, # Type of the resource.
528 &quot;name&quot;: &quot;A String&quot;, # 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.
529 &quot;region&quot;: &quot;A String&quot;, # [Output Only] Region where the health check resides. Not applicable to global health checks.
530 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
531 &quot;sslHealthCheck&quot;: {
532 &quot;port&quot;: 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.
533 &quot;portName&quot;: &quot;A String&quot;, # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
534 &quot;portSpecification&quot;: &quot;A String&quot;, # Specifies how port is selected for health checking, can be one of following values:
535 # USE_FIXED_PORT: The port number in port is used for health checking.
536 # USE_NAMED_PORT: The portName is used for health checking.
537 # 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.
538 #
539 #
540 # If not specified, SSL health check follows behavior specified in port and portName fields.
541 &quot;proxyHeader&quot;: &quot;A String&quot;, # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
542 &quot;request&quot;: &quot;A String&quot;, # 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.
543 &quot;response&quot;: &quot;A String&quot;, # 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.
544 },
545 &quot;tcpHealthCheck&quot;: {
546 &quot;port&quot;: 42, # The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535.
547 &quot;portName&quot;: &quot;A String&quot;, # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
548 &quot;portSpecification&quot;: &quot;A String&quot;, # Specifies how port is selected for health checking, can be one of following values:
549 # USE_FIXED_PORT: The port number in port is used for health checking.
550 # USE_NAMED_PORT: The portName is used for health checking.
551 # 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.
552 #
553 #
554 # If not specified, TCP health check follows behavior specified in port and portName fields.
555 &quot;proxyHeader&quot;: &quot;A String&quot;, # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
556 &quot;request&quot;: &quot;A String&quot;, # 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.
557 &quot;response&quot;: &quot;A String&quot;, # 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.
558 },
559 &quot;timeoutSec&quot;: 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.
560 &quot;type&quot;: &quot;A String&quot;, # 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.
561 &quot;unhealthyThreshold&quot;: 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
562}
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700563
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700564 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.
565
566For 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.
567
568The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700569
570Returns:
571 An object of the form:
572
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700573 { # Represents an Operation resource.
574 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700575 # Google Compute Engine has three Operation resources:
576 #
577 # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
578 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700579 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
580 #
581 # Operations can be global, regional or zonal.
Dan O'Mearadd494642020-05-01 07:42:23 -0700582 # - For global operations, use the `globalOperations` resource.
583 # - For regional operations, use the `regionOperations` resource.
584 # - For zonal operations, use the `zonalOperations` resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700585 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700586 # 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 Kim65020912020-05-20 12:08:20 -0700587 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
588 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
589 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is set when the operation is created.
590 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
591 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
592 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this operation.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700593 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700594 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
595 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error. This property is optional.
596 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700597 },
598 ],
599 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700600 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
601 &quot;httpErrorStatusCode&quot;: 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.
602 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
603 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
604 &quot;kind&quot;: &quot;compute#operation&quot;, # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
605 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
606 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
607 &quot;progress&quot;: 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.
608 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
609 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
610 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
611 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
612 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the operation.
613 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
614 &quot;targetLink&quot;: &quot;A String&quot;, # [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.
615 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example: `user@example.com`.
616 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
617 {
618 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
619 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example:
620 # &quot;data&quot;: [ { &quot;key&quot;: &quot;scope&quot;, &quot;value&quot;: &quot;zones/us-east1-d&quot; }
621 {
622 &quot;key&quot;: &quot;A String&quot;, # [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).
623 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
624 },
625 ],
626 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
627 },
628 ],
629 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700630 }</pre>
631</div>
632
633<div class="method">
Bu Sun Kim65020912020-05-20 12:08:20 -0700634 <code class="details" id="list">list(project, filter=None, maxResults=None, orderBy=None, pageToken=None)</code>
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700635 <pre>Retrieves the list of HealthCheck resources available to the specified project.
636
637Args:
638 project: string, Project ID for this request. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700639 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 `=`, `!=`, `&gt;`, or `&lt;`.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700640
Dan O'Mearadd494642020-05-01 07:42:23 -0700641For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700642
Dan O'Mearadd494642020-05-01 07:42:23 -0700643You 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.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700644
Bu Sun Kim65020912020-05-20 12:08:20 -0700645To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = &quot;Intel Skylake&quot;) ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = &quot;Intel Skylake&quot;) OR (cpuPlatform = &quot;Intel Broadwell&quot;) AND (scheduling.automaticRestart = true) ```
646 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`)
647 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
648
649You can also sort results in descending order based on the creation timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. 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.
650
651Currently, only sorting by `name` or `creationTimestamp desc` is supported.
652 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.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700653
654Returns:
655 An object of the form:
656
657 { # Contains a list of HealthCheck resources.
Bu Sun Kim65020912020-05-20 12:08:20 -0700658 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
659 &quot;items&quot;: [ # A list of HealthCheck resources.
Dan O'Mearadd494642020-05-01 07:42:23 -0700660 { # Represents a Health Check resource.
Bu Sun Kim65020912020-05-20 12:08:20 -0700661 #
662 # Google Compute Engine has two Health Check resources:
663 #
664 # * [Global](/compute/docs/reference/rest/{$api_version}/healthChecks) * [Regional](/compute/docs/reference/rest/{$api_version}/regionHealthChecks)
665 #
666 # 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.
667 #
668 # To perform health checks on network load balancers, you must use either httpHealthChecks or httpsHealthChecks.
669 &quot;checkIntervalSec&quot;: 42, # How often (in seconds) to send a health check. The default value is 5 seconds.
670 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Output Only] Creation timestamp in 3339 text format.
671 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you create the resource.
672 &quot;healthyThreshold&quot;: 42, # A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.
673 &quot;http2HealthCheck&quot;: {
674 &quot;host&quot;: &quot;A String&quot;, # 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.
675 &quot;port&quot;: 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.
676 &quot;portName&quot;: &quot;A String&quot;, # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
677 &quot;portSpecification&quot;: &quot;A String&quot;, # Specifies how port is selected for health checking, can be one of following values:
678 # USE_FIXED_PORT: The port number in port is used for health checking.
679 # USE_NAMED_PORT: The portName is used for health checking.
680 # 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.
681 #
682 #
683 # If not specified, HTTP2 health check follows behavior specified in port and portName fields.
684 &quot;proxyHeader&quot;: &quot;A String&quot;, # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
685 &quot;requestPath&quot;: &quot;A String&quot;, # The request path of the HTTP/2 health check request. The default value is /.
686 &quot;response&quot;: &quot;A String&quot;, # 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.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700687 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700688 &quot;httpHealthCheck&quot;: {
689 &quot;host&quot;: &quot;A String&quot;, # 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.
690 &quot;port&quot;: 42, # The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535.
691 &quot;portName&quot;: &quot;A String&quot;, # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
692 &quot;portSpecification&quot;: &quot;A String&quot;, # Specifies how port is selected for health checking, can be one of following values:
693 # USE_FIXED_PORT: The port number in port is used for health checking.
694 # USE_NAMED_PORT: The portName is used for health checking.
695 # 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.
696 #
697 #
698 # If not specified, HTTP health check follows behavior specified in port and portName fields.
699 &quot;proxyHeader&quot;: &quot;A String&quot;, # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
700 &quot;requestPath&quot;: &quot;A String&quot;, # The request path of the HTTP health check request. The default value is /.
701 &quot;response&quot;: &quot;A String&quot;, # 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.
702 },
703 &quot;httpsHealthCheck&quot;: {
704 &quot;host&quot;: &quot;A String&quot;, # 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.
705 &quot;port&quot;: 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.
706 &quot;portName&quot;: &quot;A String&quot;, # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
707 &quot;portSpecification&quot;: &quot;A String&quot;, # Specifies how port is selected for health checking, can be one of following values:
708 # USE_FIXED_PORT: The port number in port is used for health checking.
709 # USE_NAMED_PORT: The portName is used for health checking.
710 # 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.
711 #
712 #
713 # If not specified, HTTPS health check follows behavior specified in port and portName fields.
714 &quot;proxyHeader&quot;: &quot;A String&quot;, # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
715 &quot;requestPath&quot;: &quot;A String&quot;, # The request path of the HTTPS health check request. The default value is /.
716 &quot;response&quot;: &quot;A String&quot;, # 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.
717 },
718 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
719 &quot;kind&quot;: &quot;compute#healthCheck&quot;, # Type of the resource.
720 &quot;name&quot;: &quot;A String&quot;, # 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.
721 &quot;region&quot;: &quot;A String&quot;, # [Output Only] Region where the health check resides. Not applicable to global health checks.
722 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
723 &quot;sslHealthCheck&quot;: {
724 &quot;port&quot;: 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.
725 &quot;portName&quot;: &quot;A String&quot;, # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
726 &quot;portSpecification&quot;: &quot;A String&quot;, # Specifies how port is selected for health checking, can be one of following values:
727 # USE_FIXED_PORT: The port number in port is used for health checking.
728 # USE_NAMED_PORT: The portName is used for health checking.
729 # 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.
730 #
731 #
732 # If not specified, SSL health check follows behavior specified in port and portName fields.
733 &quot;proxyHeader&quot;: &quot;A String&quot;, # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
734 &quot;request&quot;: &quot;A String&quot;, # 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.
735 &quot;response&quot;: &quot;A String&quot;, # 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.
736 },
737 &quot;tcpHealthCheck&quot;: {
738 &quot;port&quot;: 42, # The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535.
739 &quot;portName&quot;: &quot;A String&quot;, # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
740 &quot;portSpecification&quot;: &quot;A String&quot;, # Specifies how port is selected for health checking, can be one of following values:
741 # USE_FIXED_PORT: The port number in port is used for health checking.
742 # USE_NAMED_PORT: The portName is used for health checking.
743 # 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.
744 #
745 #
746 # If not specified, TCP health check follows behavior specified in port and portName fields.
747 &quot;proxyHeader&quot;: &quot;A String&quot;, # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
748 &quot;request&quot;: &quot;A String&quot;, # 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.
749 &quot;response&quot;: &quot;A String&quot;, # 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.
750 },
751 &quot;timeoutSec&quot;: 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.
752 &quot;type&quot;: &quot;A String&quot;, # 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.
753 &quot;unhealthyThreshold&quot;: 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
754 },
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700755 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700756 &quot;kind&quot;: &quot;compute#healthCheckList&quot;, # Type of resource.
757 &quot;nextPageToken&quot;: &quot;A String&quot;, # [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.
758 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for this resource.
759 &quot;warning&quot;: { # [Output Only] Informational warning message.
760 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
761 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example:
762 # &quot;data&quot;: [ { &quot;key&quot;: &quot;scope&quot;, &quot;value&quot;: &quot;zones/us-east1-d&quot; }
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700763 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700764 &quot;key&quot;: &quot;A String&quot;, # [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).
765 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700766 },
767 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700768 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700769 },
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700770 }</pre>
771</div>
772
773<div class="method">
774 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
775 <pre>Retrieves the next page of results.
776
777Args:
778 previous_request: The request for the previous page. (required)
779 previous_response: The response from the request for the previous page. (required)
780
781Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700782 A request object that you can call &#x27;execute()&#x27; on to request the next
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700783 page. Returns None if there are no more items in the collection.
784 </pre>
785</div>
786
787<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700788 <code class="details" id="patch">patch(project, healthCheck, body=None, requestId=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700789 <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.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700790
791Args:
792 project: string, Project ID for this request. (required)
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400793 healthCheck: string, Name of the HealthCheck resource to patch. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700794 body: object, The request body.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700795 The object takes the form of:
796
Dan O'Mearadd494642020-05-01 07:42:23 -0700797{ # Represents a Health Check resource.
Bu Sun Kim65020912020-05-20 12:08:20 -0700798 #
799 # Google Compute Engine has two Health Check resources:
800 #
801 # * [Global](/compute/docs/reference/rest/{$api_version}/healthChecks) * [Regional](/compute/docs/reference/rest/{$api_version}/regionHealthChecks)
802 #
803 # 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.
804 #
805 # To perform health checks on network load balancers, you must use either httpHealthChecks or httpsHealthChecks.
806 &quot;checkIntervalSec&quot;: 42, # How often (in seconds) to send a health check. The default value is 5 seconds.
807 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Output Only] Creation timestamp in 3339 text format.
808 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you create the resource.
809 &quot;healthyThreshold&quot;: 42, # A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.
810 &quot;http2HealthCheck&quot;: {
811 &quot;host&quot;: &quot;A String&quot;, # 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.
812 &quot;port&quot;: 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.
813 &quot;portName&quot;: &quot;A String&quot;, # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
814 &quot;portSpecification&quot;: &quot;A String&quot;, # Specifies how port is selected for health checking, can be one of following values:
815 # USE_FIXED_PORT: The port number in port is used for health checking.
816 # USE_NAMED_PORT: The portName is used for health checking.
817 # 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.
818 #
819 #
820 # If not specified, HTTP2 health check follows behavior specified in port and portName fields.
821 &quot;proxyHeader&quot;: &quot;A String&quot;, # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
822 &quot;requestPath&quot;: &quot;A String&quot;, # The request path of the HTTP/2 health check request. The default value is /.
823 &quot;response&quot;: &quot;A String&quot;, # 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.
824 },
825 &quot;httpHealthCheck&quot;: {
826 &quot;host&quot;: &quot;A String&quot;, # 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.
827 &quot;port&quot;: 42, # The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535.
828 &quot;portName&quot;: &quot;A String&quot;, # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
829 &quot;portSpecification&quot;: &quot;A String&quot;, # Specifies how port is selected for health checking, can be one of following values:
830 # USE_FIXED_PORT: The port number in port is used for health checking.
831 # USE_NAMED_PORT: The portName is used for health checking.
832 # 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.
833 #
834 #
835 # If not specified, HTTP health check follows behavior specified in port and portName fields.
836 &quot;proxyHeader&quot;: &quot;A String&quot;, # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
837 &quot;requestPath&quot;: &quot;A String&quot;, # The request path of the HTTP health check request. The default value is /.
838 &quot;response&quot;: &quot;A String&quot;, # 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.
839 },
840 &quot;httpsHealthCheck&quot;: {
841 &quot;host&quot;: &quot;A String&quot;, # 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.
842 &quot;port&quot;: 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.
843 &quot;portName&quot;: &quot;A String&quot;, # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
844 &quot;portSpecification&quot;: &quot;A String&quot;, # Specifies how port is selected for health checking, can be one of following values:
845 # USE_FIXED_PORT: The port number in port is used for health checking.
846 # USE_NAMED_PORT: The portName is used for health checking.
847 # 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.
848 #
849 #
850 # If not specified, HTTPS health check follows behavior specified in port and portName fields.
851 &quot;proxyHeader&quot;: &quot;A String&quot;, # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
852 &quot;requestPath&quot;: &quot;A String&quot;, # The request path of the HTTPS health check request. The default value is /.
853 &quot;response&quot;: &quot;A String&quot;, # 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.
854 },
855 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
856 &quot;kind&quot;: &quot;compute#healthCheck&quot;, # Type of the resource.
857 &quot;name&quot;: &quot;A String&quot;, # 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.
858 &quot;region&quot;: &quot;A String&quot;, # [Output Only] Region where the health check resides. Not applicable to global health checks.
859 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
860 &quot;sslHealthCheck&quot;: {
861 &quot;port&quot;: 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.
862 &quot;portName&quot;: &quot;A String&quot;, # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
863 &quot;portSpecification&quot;: &quot;A String&quot;, # Specifies how port is selected for health checking, can be one of following values:
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.
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 #
869 # If not specified, SSL health check follows behavior specified in port and portName fields.
870 &quot;proxyHeader&quot;: &quot;A String&quot;, # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
871 &quot;request&quot;: &quot;A String&quot;, # 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.
872 &quot;response&quot;: &quot;A String&quot;, # 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.
873 },
874 &quot;tcpHealthCheck&quot;: {
875 &quot;port&quot;: 42, # The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535.
876 &quot;portName&quot;: &quot;A String&quot;, # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
877 &quot;portSpecification&quot;: &quot;A String&quot;, # Specifies how port is selected for health checking, can be one of following values:
878 # USE_FIXED_PORT: The port number in port is used for health checking.
879 # USE_NAMED_PORT: The portName is used for health checking.
880 # 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.
881 #
882 #
883 # If not specified, TCP health check follows behavior specified in port and portName fields.
884 &quot;proxyHeader&quot;: &quot;A String&quot;, # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
885 &quot;request&quot;: &quot;A String&quot;, # 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.
886 &quot;response&quot;: &quot;A String&quot;, # 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.
887 },
888 &quot;timeoutSec&quot;: 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.
889 &quot;type&quot;: &quot;A String&quot;, # 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.
890 &quot;unhealthyThreshold&quot;: 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
891}
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700892
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700893 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.
894
895For 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.
896
897The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700898
899Returns:
900 An object of the form:
901
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700902 { # Represents an Operation resource.
903 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700904 # Google Compute Engine has three Operation resources:
905 #
906 # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
907 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700908 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
909 #
910 # Operations can be global, regional or zonal.
Dan O'Mearadd494642020-05-01 07:42:23 -0700911 # - For global operations, use the `globalOperations` resource.
912 # - For regional operations, use the `regionOperations` resource.
913 # - For zonal operations, use the `zonalOperations` resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700914 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700915 # 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 Kim65020912020-05-20 12:08:20 -0700916 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
917 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
918 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is set when the operation is created.
919 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
920 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
921 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this operation.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700922 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700923 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
924 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error. This property is optional.
925 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700926 },
927 ],
928 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700929 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
930 &quot;httpErrorStatusCode&quot;: 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.
931 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
932 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
933 &quot;kind&quot;: &quot;compute#operation&quot;, # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
934 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
935 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
936 &quot;progress&quot;: 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.
937 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
938 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
939 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
940 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
941 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the operation.
942 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
943 &quot;targetLink&quot;: &quot;A String&quot;, # [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.
944 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example: `user@example.com`.
945 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
946 {
947 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
948 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example:
949 # &quot;data&quot;: [ { &quot;key&quot;: &quot;scope&quot;, &quot;value&quot;: &quot;zones/us-east1-d&quot; }
950 {
951 &quot;key&quot;: &quot;A String&quot;, # [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).
952 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
953 },
954 ],
955 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
956 },
957 ],
958 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700959 }</pre>
960</div>
961
962<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700963 <code class="details" id="update">update(project, healthCheck, body=None, requestId=None)</code>
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700964 <pre>Updates a HealthCheck resource in the specified project using the data included in the request.
965
966Args:
967 project: string, Project ID for this request. (required)
968 healthCheck: string, Name of the HealthCheck resource to update. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700969 body: object, The request body.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700970 The object takes the form of:
971
Dan O'Mearadd494642020-05-01 07:42:23 -0700972{ # Represents a Health Check resource.
Bu Sun Kim65020912020-05-20 12:08:20 -0700973 #
974 # Google Compute Engine has two Health Check resources:
975 #
976 # * [Global](/compute/docs/reference/rest/{$api_version}/healthChecks) * [Regional](/compute/docs/reference/rest/{$api_version}/regionHealthChecks)
977 #
978 # 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.
979 #
980 # To perform health checks on network load balancers, you must use either httpHealthChecks or httpsHealthChecks.
981 &quot;checkIntervalSec&quot;: 42, # How often (in seconds) to send a health check. The default value is 5 seconds.
982 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Output Only] Creation timestamp in 3339 text format.
983 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you create the resource.
984 &quot;healthyThreshold&quot;: 42, # A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.
985 &quot;http2HealthCheck&quot;: {
986 &quot;host&quot;: &quot;A String&quot;, # 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.
987 &quot;port&quot;: 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.
988 &quot;portName&quot;: &quot;A String&quot;, # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
989 &quot;portSpecification&quot;: &quot;A String&quot;, # Specifies how port is selected for health checking, can be one of following values:
990 # USE_FIXED_PORT: The port number in port is used for health checking.
991 # USE_NAMED_PORT: The portName is used for health checking.
992 # 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.
993 #
994 #
995 # If not specified, HTTP2 health check follows behavior specified in port and portName fields.
996 &quot;proxyHeader&quot;: &quot;A String&quot;, # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
997 &quot;requestPath&quot;: &quot;A String&quot;, # The request path of the HTTP/2 health check request. The default value is /.
998 &quot;response&quot;: &quot;A String&quot;, # 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.
999 },
1000 &quot;httpHealthCheck&quot;: {
1001 &quot;host&quot;: &quot;A String&quot;, # 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.
1002 &quot;port&quot;: 42, # The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535.
1003 &quot;portName&quot;: &quot;A String&quot;, # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
1004 &quot;portSpecification&quot;: &quot;A String&quot;, # Specifies how port is selected for health checking, can be one of following values:
1005 # USE_FIXED_PORT: The port number in port is used for health checking.
1006 # USE_NAMED_PORT: The portName is used for health checking.
1007 # 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.
1008 #
1009 #
1010 # If not specified, HTTP health check follows behavior specified in port and portName fields.
1011 &quot;proxyHeader&quot;: &quot;A String&quot;, # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
1012 &quot;requestPath&quot;: &quot;A String&quot;, # The request path of the HTTP health check request. The default value is /.
1013 &quot;response&quot;: &quot;A String&quot;, # 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.
1014 },
1015 &quot;httpsHealthCheck&quot;: {
1016 &quot;host&quot;: &quot;A String&quot;, # 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.
1017 &quot;port&quot;: 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.
1018 &quot;portName&quot;: &quot;A String&quot;, # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
1019 &quot;portSpecification&quot;: &quot;A String&quot;, # Specifies how port is selected for health checking, can be one of following values:
1020 # USE_FIXED_PORT: The port number in port is used for health checking.
1021 # USE_NAMED_PORT: The portName is used for health checking.
1022 # 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.
1023 #
1024 #
1025 # If not specified, HTTPS health check follows behavior specified in port and portName fields.
1026 &quot;proxyHeader&quot;: &quot;A String&quot;, # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
1027 &quot;requestPath&quot;: &quot;A String&quot;, # The request path of the HTTPS health check request. The default value is /.
1028 &quot;response&quot;: &quot;A String&quot;, # 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.
1029 },
1030 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
1031 &quot;kind&quot;: &quot;compute#healthCheck&quot;, # Type of the resource.
1032 &quot;name&quot;: &quot;A String&quot;, # 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.
1033 &quot;region&quot;: &quot;A String&quot;, # [Output Only] Region where the health check resides. Not applicable to global health checks.
1034 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
1035 &quot;sslHealthCheck&quot;: {
1036 &quot;port&quot;: 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.
1037 &quot;portName&quot;: &quot;A String&quot;, # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
1038 &quot;portSpecification&quot;: &quot;A String&quot;, # Specifies how port is selected for health checking, can be one of following values:
1039 # USE_FIXED_PORT: The port number in port is used for health checking.
1040 # USE_NAMED_PORT: The portName is used for health checking.
1041 # 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.
1042 #
1043 #
1044 # If not specified, SSL health check follows behavior specified in port and portName fields.
1045 &quot;proxyHeader&quot;: &quot;A String&quot;, # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
1046 &quot;request&quot;: &quot;A String&quot;, # 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.
1047 &quot;response&quot;: &quot;A String&quot;, # 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.
1048 },
1049 &quot;tcpHealthCheck&quot;: {
1050 &quot;port&quot;: 42, # The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535.
1051 &quot;portName&quot;: &quot;A String&quot;, # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
1052 &quot;portSpecification&quot;: &quot;A String&quot;, # Specifies how port is selected for health checking, can be one of following values:
1053 # USE_FIXED_PORT: The port number in port is used for health checking.
1054 # USE_NAMED_PORT: The portName is used for health checking.
1055 # 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.
1056 #
1057 #
1058 # If not specified, TCP health check follows behavior specified in port and portName fields.
1059 &quot;proxyHeader&quot;: &quot;A String&quot;, # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
1060 &quot;request&quot;: &quot;A String&quot;, # 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.
1061 &quot;response&quot;: &quot;A String&quot;, # 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.
1062 },
1063 &quot;timeoutSec&quot;: 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.
1064 &quot;type&quot;: &quot;A String&quot;, # 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.
1065 &quot;unhealthyThreshold&quot;: 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
1066}
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -07001067
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001068 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.
1069
1070For 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.
1071
1072The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -07001073
1074Returns:
1075 An object of the form:
1076
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001077 { # Represents an Operation resource.
1078 #
Dan O'Mearadd494642020-05-01 07:42:23 -07001079 # Google Compute Engine has three Operation resources:
1080 #
1081 # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
1082 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001083 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
1084 #
1085 # Operations can be global, regional or zonal.
Dan O'Mearadd494642020-05-01 07:42:23 -07001086 # - For global operations, use the `globalOperations` resource.
1087 # - For regional operations, use the `regionOperations` resource.
1088 # - For zonal operations, use the `zonalOperations` resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001089 #
Dan O'Mearadd494642020-05-01 07:42:23 -07001090 # 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 Kim65020912020-05-20 12:08:20 -07001091 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
1092 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
1093 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is set when the operation is created.
1094 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
1095 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
1096 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this operation.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -07001097 {
Bu Sun Kim65020912020-05-20 12:08:20 -07001098 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
1099 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error. This property is optional.
1100 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -07001101 },
1102 ],
1103 },
Bu Sun Kim65020912020-05-20 12:08:20 -07001104 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
1105 &quot;httpErrorStatusCode&quot;: 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.
1106 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
1107 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
1108 &quot;kind&quot;: &quot;compute#operation&quot;, # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
1109 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
1110 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
1111 &quot;progress&quot;: 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.
1112 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
1113 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
1114 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
1115 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
1116 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the operation.
1117 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
1118 &quot;targetLink&quot;: &quot;A String&quot;, # [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.
1119 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example: `user@example.com`.
1120 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
1121 {
1122 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
1123 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example:
1124 # &quot;data&quot;: [ { &quot;key&quot;: &quot;scope&quot;, &quot;value&quot;: &quot;zones/us-east1-d&quot; }
1125 {
1126 &quot;key&quot;: &quot;A String&quot;, # [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).
1127 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
1128 },
1129 ],
1130 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
1131 },
1132 ],
1133 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -07001134 }</pre>
1135</div>
1136
1137</body></html>