blob: b3cd78253ab3d968040109572a3e2e25ae184ed3 [file] [log] [blame]
Sai Cheemalapatidf613972016-10-21 13:59:49 -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_beta.html">Compute Engine API</a> . <a href="compute_beta.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>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -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">
84 <code><a href="#delete">delete(project, healthCheck, requestId=None)</a></code></p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -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 Cheemalapatidf613972016-10-21 13:59:49 -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 Cheemalapatidf613972016-10-21 13:59:49 -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 Cheemalapatidf613972016-10-21 13:59:49 -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 Cheemalapatidf613972016-10-21 13:59:49 -0700101<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700102 <code><a href="#testIamPermissions">testIamPermissions(project, resource, body=None)</a></code></p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700103<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
104<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700105 <code><a href="#update">update(project, healthCheck, body=None, requestId=None)</a></code></p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700106<p class="firstline">Updates a HealthCheck resource in the specified project using the data included in the request.</p>
107<h3>Method Details</h3>
108<div class="method">
Bu Sun Kim65020912020-05-20 12:08:20 -0700109 <code class="details" id="aggregatedList">aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700110 <pre>Retrieves the list of all HealthCheck resources, regional and global, available to the specified project.
111
112Args:
113 project: string, Name of the project scoping this request. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700114 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;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700115
Dan O'Mearadd494642020-05-01 07:42:23 -0700116For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700117
Dan O'Mearadd494642020-05-01 07:42:23 -0700118You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700119
Bu Sun Kim65020912020-05-20 12:08:20 -0700120To 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 -0700121 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 -0700122 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`)
123 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
124
125You 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.
126
127Currently, only sorting by `name` or `creationTimestamp desc` is supported.
128 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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700129
130Returns:
131 An object of the form:
132
133 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700134 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
135 &quot;items&quot;: { # A list of HealthChecksScopedList resources.
136 &quot;a_key&quot;: { # Name of the scope containing this set of HealthChecks.
137 &quot;healthChecks&quot;: [ # A list of HealthChecks contained in this scope.
Dan O'Mearadd494642020-05-01 07:42:23 -0700138 { # Represents a Health Check resource.
Bu Sun Kim65020912020-05-20 12:08:20 -0700139 #
140 # Google Compute Engine has two Health Check resources:
141 #
142 # * [Global](/compute/docs/reference/rest/{$api_version}/healthChecks) * [Regional](/compute/docs/reference/rest/{$api_version}/regionHealthChecks)
143 #
144 # 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.
145 #
146 # To perform health checks on network load balancers, you must use either httpHealthChecks or httpsHealthChecks.
147 &quot;checkIntervalSec&quot;: 42, # How often (in seconds) to send a health check. The default value is 5 seconds.
148 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Output Only] Creation timestamp in 3339 text format.
149 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you create the resource.
150 &quot;healthyThreshold&quot;: 42, # A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.
151 &quot;http2HealthCheck&quot;: {
152 &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.
153 &quot;port&quot;: 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.
154 &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.
155 &quot;portSpecification&quot;: &quot;A String&quot;, # Specifies how port is selected for health checking, can be one of following values:
156 # USE_FIXED_PORT: The port number in port is used for health checking.
157 # USE_NAMED_PORT: The portName is used for health checking.
158 # 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.
159 #
160 #
161 # If not specified, HTTP2 health check follows behavior specified in port and portName fields.
162 &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.
163 &quot;requestPath&quot;: &quot;A String&quot;, # The request path of the HTTP/2 health check request. The default value is /.
164 &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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700165 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700166 &quot;httpHealthCheck&quot;: {
167 &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.
168 &quot;port&quot;: 42, # The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535.
169 &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.
170 &quot;portSpecification&quot;: &quot;A String&quot;, # Specifies how port is selected for health checking, can be one of following values:
171 # USE_FIXED_PORT: The port number in port is used for health checking.
172 # USE_NAMED_PORT: The portName is used for health checking.
173 # 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.
174 #
175 #
176 # If not specified, HTTP health check follows behavior specified in port and portName fields.
177 &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.
178 &quot;requestPath&quot;: &quot;A String&quot;, # The request path of the HTTP health check request. The default value is /.
179 &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.
180 },
181 &quot;httpsHealthCheck&quot;: {
182 &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.
183 &quot;port&quot;: 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.
184 &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.
185 &quot;portSpecification&quot;: &quot;A String&quot;, # Specifies how port is selected for health checking, can be one of following values:
186 # USE_FIXED_PORT: The port number in port is used for health checking.
187 # USE_NAMED_PORT: The portName is used for health checking.
188 # 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.
189 #
190 #
191 # If not specified, HTTPS health check follows behavior specified in port and portName fields.
192 &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.
193 &quot;requestPath&quot;: &quot;A String&quot;, # The request path of the HTTPS health check request. The default value is /.
194 &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.
195 },
196 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
197 &quot;kind&quot;: &quot;compute#healthCheck&quot;, # Type of the resource.
198 &quot;logConfig&quot;: { # Configuration of logging on a health check. If logging is enabled, logs will be exported to Stackdriver. # Configure logging on this health check.
199 &quot;enable&quot;: True or False, # Indicates whether or not to export logs. This is false by default, which means no health check logging will be done.
200 },
201 &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.
202 &quot;region&quot;: &quot;A String&quot;, # [Output Only] Region where the health check resides. Not applicable to global health checks.
203 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
204 &quot;sslHealthCheck&quot;: {
205 &quot;port&quot;: 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.
206 &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.
207 &quot;portSpecification&quot;: &quot;A String&quot;, # Specifies how port is selected for health checking, can be one of following values:
208 # USE_FIXED_PORT: The port number in port is used for health checking.
209 # USE_NAMED_PORT: The portName is used for health checking.
210 # 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.
211 #
212 #
213 # If not specified, SSL health check follows behavior specified in port and portName fields.
214 &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.
215 &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.
216 &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.
217 },
218 &quot;tcpHealthCheck&quot;: {
219 &quot;port&quot;: 42, # The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535.
220 &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.
221 &quot;portSpecification&quot;: &quot;A String&quot;, # Specifies how port is selected for health checking, can be one of following values:
222 # USE_FIXED_PORT: The port number in port is used for health checking.
223 # USE_NAMED_PORT: The portName is used for health checking.
224 # 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.
225 #
226 #
227 # If not specified, TCP health check follows behavior specified in port and portName fields.
228 &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.
229 &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.
230 &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.
231 },
232 &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.
233 &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.
234 &quot;unhealthyThreshold&quot;: 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
235 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700236 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700237 &quot;warning&quot;: { # Informational warning which replaces the list of backend services when the list is empty.
238 &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.
239 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example:
240 # &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 -0700241 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700242 &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).
243 &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 -0700244 },
245 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700246 &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 -0700247 },
248 },
249 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700250 &quot;kind&quot;: &quot;compute#healthChecksAggregatedList&quot;, # Type of resource.
251 &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.
252 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for this resource.
253 &quot;warning&quot;: { # [Output Only] Informational warning message.
254 &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.
255 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example:
256 # &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 -0700257 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700258 &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).
259 &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 -0700260 },
261 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700262 &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 -0700263 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700264 }</pre>
265</div>
266
267<div class="method">
268 <code class="details" id="aggregatedList_next">aggregatedList_next(previous_request, previous_response)</code>
269 <pre>Retrieves the next page of results.
270
271Args:
272 previous_request: The request for the previous page. (required)
273 previous_response: The response from the request for the previous page. (required)
274
275Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700276 A request object that you can call &#x27;execute()&#x27; on to request the next
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700277 page. Returns None if there are no more items in the collection.
278 </pre>
279</div>
280
281<div class="method">
282 <code class="details" id="delete">delete(project, healthCheck, requestId=None)</code>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700283 <pre>Deletes the specified HealthCheck resource.
284
285Args:
286 project: string, Project ID for this request. (required)
287 healthCheck: string, Name of the HealthCheck resource to delete. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700288 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.
289
290For 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.
291
292The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700293
294Returns:
295 An object of the form:
296
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700297 { # Represents an Operation resource.
298 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700299 # Google Compute Engine has three Operation resources:
300 #
301 # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
302 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700303 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
304 #
305 # Operations can be global, regional or zonal.
Dan O'Mearadd494642020-05-01 07:42:23 -0700306 # - For global operations, use the `globalOperations` resource.
307 # - For regional operations, use the `regionOperations` resource.
308 # - For zonal operations, use the `zonalOperations` resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700309 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700310 # 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 -0700311 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
312 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
313 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is set when the operation is created.
314 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
315 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
316 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this operation.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700317 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700318 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
319 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error. This property is optional.
320 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700321 },
322 ],
323 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700324 &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`.
325 &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.
326 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
327 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
328 &quot;kind&quot;: &quot;compute#operation&quot;, # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
329 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
330 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
331 &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.
332 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
333 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
334 &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.
335 &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`.
336 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the operation.
337 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
338 &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.
339 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example: `user@example.com`.
340 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
341 {
342 &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.
343 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example:
344 # &quot;data&quot;: [ { &quot;key&quot;: &quot;scope&quot;, &quot;value&quot;: &quot;zones/us-east1-d&quot; }
345 {
346 &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).
347 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
348 },
349 ],
350 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
351 },
352 ],
353 &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 Cheemalapatidf613972016-10-21 13:59:49 -0700354 }</pre>
355</div>
356
357<div class="method">
358 <code class="details" id="get">get(project, healthCheck)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700359 <pre>Returns the specified HealthCheck resource. Gets a list of available health checks by making a list() request.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700360
361Args:
362 project: string, Project ID for this request. (required)
363 healthCheck: string, Name of the HealthCheck resource to return. (required)
364
365Returns:
366 An object of the form:
367
Dan O'Mearadd494642020-05-01 07:42:23 -0700368 { # Represents a Health Check resource.
Bu Sun Kim65020912020-05-20 12:08:20 -0700369 #
370 # Google Compute Engine has two Health Check resources:
371 #
372 # * [Global](/compute/docs/reference/rest/{$api_version}/healthChecks) * [Regional](/compute/docs/reference/rest/{$api_version}/regionHealthChecks)
373 #
374 # 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.
375 #
376 # To perform health checks on network load balancers, you must use either httpHealthChecks or httpsHealthChecks.
377 &quot;checkIntervalSec&quot;: 42, # How often (in seconds) to send a health check. The default value is 5 seconds.
378 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Output Only] Creation timestamp in 3339 text format.
379 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you create the resource.
380 &quot;healthyThreshold&quot;: 42, # A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.
381 &quot;http2HealthCheck&quot;: {
382 &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.
383 &quot;port&quot;: 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.
384 &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.
385 &quot;portSpecification&quot;: &quot;A String&quot;, # Specifies how port is selected for health checking, can be one of following values:
386 # USE_FIXED_PORT: The port number in port is used for health checking.
387 # USE_NAMED_PORT: The portName is used for health checking.
388 # 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.
389 #
390 #
391 # If not specified, HTTP2 health check follows behavior specified in port and portName fields.
392 &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.
393 &quot;requestPath&quot;: &quot;A String&quot;, # The request path of the HTTP/2 health check request. The default value is /.
394 &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.
395 },
396 &quot;httpHealthCheck&quot;: {
397 &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.
398 &quot;port&quot;: 42, # The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535.
399 &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.
400 &quot;portSpecification&quot;: &quot;A String&quot;, # Specifies how port is selected for health checking, can be one of following values:
401 # USE_FIXED_PORT: The port number in port is used for health checking.
402 # USE_NAMED_PORT: The portName is used for health checking.
403 # 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.
404 #
405 #
406 # If not specified, HTTP health check follows behavior specified in port and portName fields.
407 &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.
408 &quot;requestPath&quot;: &quot;A String&quot;, # The request path of the HTTP health check request. The default value is /.
409 &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.
410 },
411 &quot;httpsHealthCheck&quot;: {
412 &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.
413 &quot;port&quot;: 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.
414 &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.
415 &quot;portSpecification&quot;: &quot;A String&quot;, # Specifies how port is selected for health checking, can be one of following values:
416 # USE_FIXED_PORT: The port number in port is used for health checking.
417 # USE_NAMED_PORT: The portName is used for health checking.
418 # 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.
419 #
420 #
421 # If not specified, HTTPS health check follows behavior specified in port and portName fields.
422 &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.
423 &quot;requestPath&quot;: &quot;A String&quot;, # The request path of the HTTPS health check request. The default value is /.
424 &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.
425 },
426 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
427 &quot;kind&quot;: &quot;compute#healthCheck&quot;, # Type of the resource.
428 &quot;logConfig&quot;: { # Configuration of logging on a health check. If logging is enabled, logs will be exported to Stackdriver. # Configure logging on this health check.
429 &quot;enable&quot;: True or False, # Indicates whether or not to export logs. This is false by default, which means no health check logging will be done.
430 },
431 &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.
432 &quot;region&quot;: &quot;A String&quot;, # [Output Only] Region where the health check resides. Not applicable to global health checks.
433 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
434 &quot;sslHealthCheck&quot;: {
435 &quot;port&quot;: 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.
436 &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.
437 &quot;portSpecification&quot;: &quot;A String&quot;, # Specifies how port is selected for health checking, can be one of following values:
438 # USE_FIXED_PORT: The port number in port is used for health checking.
439 # USE_NAMED_PORT: The portName is used for health checking.
440 # 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.
441 #
442 #
443 # If not specified, SSL health check follows behavior specified in port and portName fields.
444 &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.
445 &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.
446 &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.
447 },
448 &quot;tcpHealthCheck&quot;: {
449 &quot;port&quot;: 42, # The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535.
450 &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.
451 &quot;portSpecification&quot;: &quot;A String&quot;, # Specifies how port is selected for health checking, can be one of following values:
452 # USE_FIXED_PORT: The port number in port is used for health checking.
453 # USE_NAMED_PORT: The portName is used for health checking.
454 # 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.
455 #
456 #
457 # If not specified, TCP health check follows behavior specified in port and portName fields.
458 &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.
459 &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.
460 &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.
461 },
462 &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.
463 &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.
464 &quot;unhealthyThreshold&quot;: 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
465 }</pre>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700466</div>
467
468<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700469 <code class="details" id="insert">insert(project, body=None, requestId=None)</code>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700470 <pre>Creates a HealthCheck resource in the specified project using the data included in the request.
471
472Args:
473 project: string, Project ID for this request. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700474 body: object, The request body.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700475 The object takes the form of:
476
Dan O'Mearadd494642020-05-01 07:42:23 -0700477{ # Represents a Health Check resource.
Bu Sun Kim65020912020-05-20 12:08:20 -0700478 #
479 # Google Compute Engine has two Health Check resources:
480 #
481 # * [Global](/compute/docs/reference/rest/{$api_version}/healthChecks) * [Regional](/compute/docs/reference/rest/{$api_version}/regionHealthChecks)
482 #
483 # 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.
484 #
485 # To perform health checks on network load balancers, you must use either httpHealthChecks or httpsHealthChecks.
486 &quot;checkIntervalSec&quot;: 42, # How often (in seconds) to send a health check. The default value is 5 seconds.
487 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Output Only] Creation timestamp in 3339 text format.
488 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you create the resource.
489 &quot;healthyThreshold&quot;: 42, # A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.
490 &quot;http2HealthCheck&quot;: {
491 &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.
492 &quot;port&quot;: 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.
493 &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.
494 &quot;portSpecification&quot;: &quot;A String&quot;, # Specifies how port is selected for health checking, can be one of following values:
495 # USE_FIXED_PORT: The port number in port is used for health checking.
496 # USE_NAMED_PORT: The portName is used for health checking.
497 # 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.
498 #
499 #
500 # If not specified, HTTP2 health check follows behavior specified in port and portName fields.
501 &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.
502 &quot;requestPath&quot;: &quot;A String&quot;, # The request path of the HTTP/2 health check request. The default value is /.
503 &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.
504 },
505 &quot;httpHealthCheck&quot;: {
506 &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.
507 &quot;port&quot;: 42, # The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535.
508 &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.
509 &quot;portSpecification&quot;: &quot;A String&quot;, # Specifies how port is selected for health checking, can be one of following values:
510 # USE_FIXED_PORT: The port number in port is used for health checking.
511 # USE_NAMED_PORT: The portName is used for health checking.
512 # 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.
513 #
514 #
515 # If not specified, HTTP health check follows behavior specified in port and portName fields.
516 &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.
517 &quot;requestPath&quot;: &quot;A String&quot;, # The request path of the HTTP health check request. The default value is /.
518 &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.
519 },
520 &quot;httpsHealthCheck&quot;: {
521 &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.
522 &quot;port&quot;: 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.
523 &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.
524 &quot;portSpecification&quot;: &quot;A String&quot;, # Specifies how port is selected for health checking, can be one of following values:
525 # USE_FIXED_PORT: The port number in port is used for health checking.
526 # USE_NAMED_PORT: The portName is used for health checking.
527 # 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.
528 #
529 #
530 # If not specified, HTTPS health check follows behavior specified in port and portName fields.
531 &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.
532 &quot;requestPath&quot;: &quot;A String&quot;, # The request path of the HTTPS health check request. The default value is /.
533 &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.
534 },
535 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
536 &quot;kind&quot;: &quot;compute#healthCheck&quot;, # Type of the resource.
537 &quot;logConfig&quot;: { # Configuration of logging on a health check. If logging is enabled, logs will be exported to Stackdriver. # Configure logging on this health check.
538 &quot;enable&quot;: True or False, # Indicates whether or not to export logs. This is false by default, which means no health check logging will be done.
539 },
540 &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.
541 &quot;region&quot;: &quot;A String&quot;, # [Output Only] Region where the health check resides. Not applicable to global health checks.
542 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
543 &quot;sslHealthCheck&quot;: {
544 &quot;port&quot;: 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.
545 &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.
546 &quot;portSpecification&quot;: &quot;A String&quot;, # Specifies how port is selected for health checking, can be one of following values:
547 # USE_FIXED_PORT: The port number in port is used for health checking.
548 # USE_NAMED_PORT: The portName is used for health checking.
549 # 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.
550 #
551 #
552 # If not specified, SSL health check follows behavior specified in port and portName fields.
553 &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.
554 &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.
555 &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.
556 },
557 &quot;tcpHealthCheck&quot;: {
558 &quot;port&quot;: 42, # The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535.
559 &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.
560 &quot;portSpecification&quot;: &quot;A String&quot;, # Specifies how port is selected for health checking, can be one of following values:
561 # USE_FIXED_PORT: The port number in port is used for health checking.
562 # USE_NAMED_PORT: The portName is used for health checking.
563 # USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking.
564 #
565 #
566 # If not specified, TCP health check follows behavior specified in port and portName fields.
567 &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.
568 &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.
569 &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.
570 },
571 &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.
572 &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.
573 &quot;unhealthyThreshold&quot;: 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
574}
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700575
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700576 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.
577
578For 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.
579
580The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700581
582Returns:
583 An object of the form:
584
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700585 { # Represents an Operation resource.
586 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700587 # Google Compute Engine has three Operation resources:
588 #
589 # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
590 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700591 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
592 #
593 # Operations can be global, regional or zonal.
Dan O'Mearadd494642020-05-01 07:42:23 -0700594 # - For global operations, use the `globalOperations` resource.
595 # - For regional operations, use the `regionOperations` resource.
596 # - For zonal operations, use the `zonalOperations` resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700597 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700598 # 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 -0700599 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
600 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
601 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is set when the operation is created.
602 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
603 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
604 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this operation.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700605 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700606 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
607 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error. This property is optional.
608 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700609 },
610 ],
611 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700612 &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`.
613 &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.
614 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
615 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
616 &quot;kind&quot;: &quot;compute#operation&quot;, # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
617 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
618 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
619 &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.
620 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
621 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
622 &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.
623 &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`.
624 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the operation.
625 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
626 &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.
627 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example: `user@example.com`.
628 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
629 {
630 &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.
631 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example:
632 # &quot;data&quot;: [ { &quot;key&quot;: &quot;scope&quot;, &quot;value&quot;: &quot;zones/us-east1-d&quot; }
633 {
634 &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).
635 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
636 },
637 ],
638 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
639 },
640 ],
641 &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 Cheemalapatidf613972016-10-21 13:59:49 -0700642 }</pre>
643</div>
644
645<div class="method">
Bu Sun Kim65020912020-05-20 12:08:20 -0700646 <code class="details" id="list">list(project, filter=None, maxResults=None, orderBy=None, pageToken=None)</code>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700647 <pre>Retrieves the list of HealthCheck resources available to the specified project.
648
649Args:
650 project: string, Project ID for this request. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700651 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 Cheemalapatidf613972016-10-21 13:59:49 -0700652
Dan O'Mearadd494642020-05-01 07:42:23 -0700653For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700654
Dan O'Mearadd494642020-05-01 07:42:23 -0700655You 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 Cheemalapatidf613972016-10-21 13:59:49 -0700656
Bu Sun Kim65020912020-05-20 12:08:20 -0700657To 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) ```
658 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`)
659 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
660
661You 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.
662
663Currently, only sorting by `name` or `creationTimestamp desc` is supported.
664 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 Cheemalapatidf613972016-10-21 13:59:49 -0700665
666Returns:
667 An object of the form:
668
669 { # Contains a list of HealthCheck resources.
Bu Sun Kim65020912020-05-20 12:08:20 -0700670 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
671 &quot;items&quot;: [ # A list of HealthCheck resources.
Dan O'Mearadd494642020-05-01 07:42:23 -0700672 { # Represents a Health Check resource.
Bu Sun Kim65020912020-05-20 12:08:20 -0700673 #
674 # Google Compute Engine has two Health Check resources:
675 #
676 # * [Global](/compute/docs/reference/rest/{$api_version}/healthChecks) * [Regional](/compute/docs/reference/rest/{$api_version}/regionHealthChecks)
677 #
678 # 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.
679 #
680 # To perform health checks on network load balancers, you must use either httpHealthChecks or httpsHealthChecks.
681 &quot;checkIntervalSec&quot;: 42, # How often (in seconds) to send a health check. The default value is 5 seconds.
682 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Output Only] Creation timestamp in 3339 text format.
683 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you create the resource.
684 &quot;healthyThreshold&quot;: 42, # A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.
685 &quot;http2HealthCheck&quot;: {
686 &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.
687 &quot;port&quot;: 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.
688 &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.
689 &quot;portSpecification&quot;: &quot;A String&quot;, # Specifies how port is selected for health checking, can be one of following values:
690 # USE_FIXED_PORT: The port number in port is used for health checking.
691 # USE_NAMED_PORT: The portName is used for health checking.
692 # 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.
693 #
694 #
695 # If not specified, HTTP2 health check follows behavior specified in port and portName fields.
696 &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.
697 &quot;requestPath&quot;: &quot;A String&quot;, # The request path of the HTTP/2 health check request. The default value is /.
698 &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 Cheemalapatidf613972016-10-21 13:59:49 -0700699 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700700 &quot;httpHealthCheck&quot;: {
701 &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.
702 &quot;port&quot;: 42, # The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535.
703 &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.
704 &quot;portSpecification&quot;: &quot;A String&quot;, # Specifies how port is selected for health checking, can be one of following values:
705 # USE_FIXED_PORT: The port number in port is used for health checking.
706 # USE_NAMED_PORT: The portName is used for health checking.
707 # 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.
708 #
709 #
710 # If not specified, HTTP health check follows behavior specified in port and portName fields.
711 &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.
712 &quot;requestPath&quot;: &quot;A String&quot;, # The request path of the HTTP health check request. The default value is /.
713 &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.
714 },
715 &quot;httpsHealthCheck&quot;: {
716 &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.
717 &quot;port&quot;: 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.
718 &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.
719 &quot;portSpecification&quot;: &quot;A String&quot;, # Specifies how port is selected for health checking, can be one of following values:
720 # USE_FIXED_PORT: The port number in port is used for health checking.
721 # USE_NAMED_PORT: The portName is used for health checking.
722 # 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.
723 #
724 #
725 # If not specified, HTTPS health check follows behavior specified in port and portName fields.
726 &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.
727 &quot;requestPath&quot;: &quot;A String&quot;, # The request path of the HTTPS health check request. The default value is /.
728 &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.
729 },
730 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
731 &quot;kind&quot;: &quot;compute#healthCheck&quot;, # Type of the resource.
732 &quot;logConfig&quot;: { # Configuration of logging on a health check. If logging is enabled, logs will be exported to Stackdriver. # Configure logging on this health check.
733 &quot;enable&quot;: True or False, # Indicates whether or not to export logs. This is false by default, which means no health check logging will be done.
734 },
735 &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.
736 &quot;region&quot;: &quot;A String&quot;, # [Output Only] Region where the health check resides. Not applicable to global health checks.
737 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
738 &quot;sslHealthCheck&quot;: {
739 &quot;port&quot;: 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.
740 &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.
741 &quot;portSpecification&quot;: &quot;A String&quot;, # Specifies how port is selected for health checking, can be one of following values:
742 # USE_FIXED_PORT: The port number in port is used for health checking.
743 # USE_NAMED_PORT: The portName is used for health checking.
744 # 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.
745 #
746 #
747 # If not specified, SSL health check follows behavior specified in port and portName fields.
748 &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.
749 &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.
750 &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.
751 },
752 &quot;tcpHealthCheck&quot;: {
753 &quot;port&quot;: 42, # The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535.
754 &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.
755 &quot;portSpecification&quot;: &quot;A String&quot;, # Specifies how port is selected for health checking, can be one of following values:
756 # USE_FIXED_PORT: The port number in port is used for health checking.
757 # USE_NAMED_PORT: The portName is used for health checking.
758 # 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.
759 #
760 #
761 # If not specified, TCP health check follows behavior specified in port and portName fields.
762 &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.
763 &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.
764 &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.
765 },
766 &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.
767 &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.
768 &quot;unhealthyThreshold&quot;: 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
769 },
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700770 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700771 &quot;kind&quot;: &quot;compute#healthCheckList&quot;, # Type of resource.
772 &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.
773 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for this resource.
774 &quot;warning&quot;: { # [Output Only] Informational warning message.
775 &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.
776 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example:
777 # &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 -0700778 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700779 &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).
780 &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 -0700781 },
782 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700783 &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 -0700784 },
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700785 }</pre>
786</div>
787
788<div class="method">
789 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
790 <pre>Retrieves the next page of results.
791
792Args:
793 previous_request: The request for the previous page. (required)
794 previous_response: The response from the request for the previous page. (required)
795
796Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700797 A request object that you can call &#x27;execute()&#x27; on to request the next
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700798 page. Returns None if there are no more items in the collection.
799 </pre>
800</div>
801
802<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700803 <code class="details" id="patch">patch(project, healthCheck, body=None, requestId=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700804 <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 Cheemalapatidf613972016-10-21 13:59:49 -0700805
806Args:
807 project: string, Project ID for this request. (required)
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400808 healthCheck: string, Name of the HealthCheck resource to patch. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700809 body: object, The request body.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700810 The object takes the form of:
811
Dan O'Mearadd494642020-05-01 07:42:23 -0700812{ # Represents a Health Check resource.
Bu Sun Kim65020912020-05-20 12:08:20 -0700813 #
814 # Google Compute Engine has two Health Check resources:
815 #
816 # * [Global](/compute/docs/reference/rest/{$api_version}/healthChecks) * [Regional](/compute/docs/reference/rest/{$api_version}/regionHealthChecks)
817 #
818 # 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.
819 #
820 # To perform health checks on network load balancers, you must use either httpHealthChecks or httpsHealthChecks.
821 &quot;checkIntervalSec&quot;: 42, # How often (in seconds) to send a health check. The default value is 5 seconds.
822 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Output Only] Creation timestamp in 3339 text format.
823 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you create the resource.
824 &quot;healthyThreshold&quot;: 42, # A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.
825 &quot;http2HealthCheck&quot;: {
826 &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.
827 &quot;port&quot;: 42, # The TCP port number for the health check request. The default value is 443. 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, HTTP2 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/2 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;httpHealthCheck&quot;: {
841 &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.
842 &quot;port&quot;: 42, # The TCP port number for the health check request. The default value is 80. 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, HTTP 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 HTTP 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;httpsHealthCheck&quot;: {
856 &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.
857 &quot;port&quot;: 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.
858 &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.
859 &quot;portSpecification&quot;: &quot;A String&quot;, # Specifies how port is selected for health checking, can be one of following values:
860 # USE_FIXED_PORT: The port number in port is used for health checking.
861 # USE_NAMED_PORT: The portName is used for health checking.
862 # 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.
863 #
864 #
865 # If not specified, HTTPS health check follows behavior specified in port and portName fields.
866 &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.
867 &quot;requestPath&quot;: &quot;A String&quot;, # The request path of the HTTPS health check request. The default value is /.
868 &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.
869 },
870 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
871 &quot;kind&quot;: &quot;compute#healthCheck&quot;, # Type of the resource.
872 &quot;logConfig&quot;: { # Configuration of logging on a health check. If logging is enabled, logs will be exported to Stackdriver. # Configure logging on this health check.
873 &quot;enable&quot;: True or False, # Indicates whether or not to export logs. This is false by default, which means no health check logging will be done.
874 },
875 &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.
876 &quot;region&quot;: &quot;A String&quot;, # [Output Only] Region where the health check resides. Not applicable to global health checks.
877 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
878 &quot;sslHealthCheck&quot;: {
879 &quot;port&quot;: 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.
880 &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.
881 &quot;portSpecification&quot;: &quot;A String&quot;, # Specifies how port is selected for health checking, can be one of following values:
882 # USE_FIXED_PORT: The port number in port is used for health checking.
883 # USE_NAMED_PORT: The portName is used for health checking.
884 # 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.
885 #
886 #
887 # If not specified, SSL health check follows behavior specified in port and portName fields.
888 &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.
889 &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.
890 &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.
891 },
892 &quot;tcpHealthCheck&quot;: {
893 &quot;port&quot;: 42, # The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535.
894 &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.
895 &quot;portSpecification&quot;: &quot;A String&quot;, # Specifies how port is selected for health checking, can be one of following values:
896 # USE_FIXED_PORT: The port number in port is used for health checking.
897 # USE_NAMED_PORT: The portName is used for health checking.
898 # 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.
899 #
900 #
901 # If not specified, TCP health check follows behavior specified in port and portName fields.
902 &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.
903 &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.
904 &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.
905 },
906 &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.
907 &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.
908 &quot;unhealthyThreshold&quot;: 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
909}
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700910
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700911 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.
912
913For 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.
914
915The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700916
917Returns:
918 An object of the form:
919
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700920 { # Represents an Operation resource.
921 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700922 # Google Compute Engine has three Operation resources:
923 #
924 # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
925 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700926 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
927 #
928 # Operations can be global, regional or zonal.
Dan O'Mearadd494642020-05-01 07:42:23 -0700929 # - For global operations, use the `globalOperations` resource.
930 # - For regional operations, use the `regionOperations` resource.
931 # - For zonal operations, use the `zonalOperations` resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700932 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700933 # 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 -0700934 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
935 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
936 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is set when the operation is created.
937 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
938 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
939 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this operation.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700940 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700941 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
942 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error. This property is optional.
943 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700944 },
945 ],
946 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700947 &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`.
948 &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.
949 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
950 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
951 &quot;kind&quot;: &quot;compute#operation&quot;, # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
952 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
953 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
954 &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.
955 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
956 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
957 &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.
958 &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`.
959 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the operation.
960 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
961 &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.
962 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example: `user@example.com`.
963 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
964 {
965 &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.
966 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example:
967 # &quot;data&quot;: [ { &quot;key&quot;: &quot;scope&quot;, &quot;value&quot;: &quot;zones/us-east1-d&quot; }
968 {
969 &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).
970 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
971 },
972 ],
973 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
974 },
975 ],
976 &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 Cheemalapatidf613972016-10-21 13:59:49 -0700977 }</pre>
978</div>
979
980<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700981 <code class="details" id="testIamPermissions">testIamPermissions(project, resource, body=None)</code>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700982 <pre>Returns permissions that a caller has on the specified resource.
983
984Args:
985 project: string, Project ID for this request. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700986 resource: string, Name or id of the resource for this request. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700987 body: object, The request body.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700988 The object takes the form of:
989
990{
Bu Sun Kim65020912020-05-20 12:08:20 -0700991 &quot;permissions&quot;: [ # The set of permissions to check for the &#x27;resource&#x27;. Permissions with wildcards (such as &#x27;*&#x27; or &#x27;storage.*&#x27;) are not allowed.
992 &quot;A String&quot;,
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700993 ],
994 }
995
996
997Returns:
998 An object of the form:
999
1000 {
Bu Sun Kim65020912020-05-20 12:08:20 -07001001 &quot;permissions&quot;: [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
1002 &quot;A String&quot;,
Sai Cheemalapatidf613972016-10-21 13:59:49 -07001003 ],
1004 }</pre>
1005</div>
1006
1007<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -07001008 <code class="details" id="update">update(project, healthCheck, body=None, requestId=None)</code>
Sai Cheemalapatidf613972016-10-21 13:59:49 -07001009 <pre>Updates a HealthCheck resource in the specified project using the data included in the request.
1010
1011Args:
1012 project: string, Project ID for this request. (required)
1013 healthCheck: string, Name of the HealthCheck resource to update. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -07001014 body: object, The request body.
Sai Cheemalapatidf613972016-10-21 13:59:49 -07001015 The object takes the form of:
1016
Dan O'Mearadd494642020-05-01 07:42:23 -07001017{ # Represents a Health Check resource.
Bu Sun Kim65020912020-05-20 12:08:20 -07001018 #
1019 # Google Compute Engine has two Health Check resources:
1020 #
1021 # * [Global](/compute/docs/reference/rest/{$api_version}/healthChecks) * [Regional](/compute/docs/reference/rest/{$api_version}/regionHealthChecks)
1022 #
1023 # 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.
1024 #
1025 # To perform health checks on network load balancers, you must use either httpHealthChecks or httpsHealthChecks.
1026 &quot;checkIntervalSec&quot;: 42, # How often (in seconds) to send a health check. The default value is 5 seconds.
1027 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Output Only] Creation timestamp in 3339 text format.
1028 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you create the resource.
1029 &quot;healthyThreshold&quot;: 42, # A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.
1030 &quot;http2HealthCheck&quot;: {
1031 &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.
1032 &quot;port&quot;: 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.
1033 &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.
1034 &quot;portSpecification&quot;: &quot;A String&quot;, # Specifies how port is selected for health checking, can be one of following values:
1035 # USE_FIXED_PORT: The port number in port is used for health checking.
1036 # USE_NAMED_PORT: The portName is used for health checking.
1037 # 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.
1038 #
1039 #
1040 # If not specified, HTTP2 health check follows behavior specified in port and portName fields.
1041 &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.
1042 &quot;requestPath&quot;: &quot;A String&quot;, # The request path of the HTTP/2 health check request. The default value is /.
1043 &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.
1044 },
1045 &quot;httpHealthCheck&quot;: {
1046 &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.
1047 &quot;port&quot;: 42, # The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535.
1048 &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.
1049 &quot;portSpecification&quot;: &quot;A String&quot;, # Specifies how port is selected for health checking, can be one of following values:
1050 # USE_FIXED_PORT: The port number in port is used for health checking.
1051 # USE_NAMED_PORT: The portName is used for health checking.
1052 # 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.
1053 #
1054 #
1055 # If not specified, HTTP health check follows behavior specified in port and portName fields.
1056 &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.
1057 &quot;requestPath&quot;: &quot;A String&quot;, # The request path of the HTTP health check request. The default value is /.
1058 &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.
1059 },
1060 &quot;httpsHealthCheck&quot;: {
1061 &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.
1062 &quot;port&quot;: 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.
1063 &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.
1064 &quot;portSpecification&quot;: &quot;A String&quot;, # Specifies how port is selected for health checking, can be one of following values:
1065 # USE_FIXED_PORT: The port number in port is used for health checking.
1066 # USE_NAMED_PORT: The portName is used for health checking.
1067 # 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.
1068 #
1069 #
1070 # If not specified, HTTPS health check follows behavior specified in port and portName fields.
1071 &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.
1072 &quot;requestPath&quot;: &quot;A String&quot;, # The request path of the HTTPS health check request. The default value is /.
1073 &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.
1074 },
1075 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
1076 &quot;kind&quot;: &quot;compute#healthCheck&quot;, # Type of the resource.
1077 &quot;logConfig&quot;: { # Configuration of logging on a health check. If logging is enabled, logs will be exported to Stackdriver. # Configure logging on this health check.
1078 &quot;enable&quot;: True or False, # Indicates whether or not to export logs. This is false by default, which means no health check logging will be done.
1079 },
1080 &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.
1081 &quot;region&quot;: &quot;A String&quot;, # [Output Only] Region where the health check resides. Not applicable to global health checks.
1082 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
1083 &quot;sslHealthCheck&quot;: {
1084 &quot;port&quot;: 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.
1085 &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.
1086 &quot;portSpecification&quot;: &quot;A String&quot;, # Specifies how port is selected for health checking, can be one of following values:
1087 # USE_FIXED_PORT: The port number in port is used for health checking.
1088 # USE_NAMED_PORT: The portName is used for health checking.
1089 # 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.
1090 #
1091 #
1092 # If not specified, SSL health check follows behavior specified in port and portName fields.
1093 &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.
1094 &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.
1095 &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.
1096 },
1097 &quot;tcpHealthCheck&quot;: {
1098 &quot;port&quot;: 42, # The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535.
1099 &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.
1100 &quot;portSpecification&quot;: &quot;A String&quot;, # Specifies how port is selected for health checking, can be one of following values:
1101 # USE_FIXED_PORT: The port number in port is used for health checking.
1102 # USE_NAMED_PORT: The portName is used for health checking.
1103 # 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.
1104 #
1105 #
1106 # If not specified, TCP health check follows behavior specified in port and portName fields.
1107 &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.
1108 &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.
1109 &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.
1110 },
1111 &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.
1112 &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.
1113 &quot;unhealthyThreshold&quot;: 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
1114}
Sai Cheemalapatidf613972016-10-21 13:59:49 -07001115
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001116 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.
1117
1118For 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.
1119
1120The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Sai Cheemalapatidf613972016-10-21 13:59:49 -07001121
1122Returns:
1123 An object of the form:
1124
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001125 { # Represents an Operation resource.
1126 #
Dan O'Mearadd494642020-05-01 07:42:23 -07001127 # Google Compute Engine has three Operation resources:
1128 #
1129 # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
1130 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001131 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
1132 #
1133 # Operations can be global, regional or zonal.
Dan O'Mearadd494642020-05-01 07:42:23 -07001134 # - For global operations, use the `globalOperations` resource.
1135 # - For regional operations, use the `regionOperations` resource.
1136 # - For zonal operations, use the `zonalOperations` resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001137 #
Dan O'Mearadd494642020-05-01 07:42:23 -07001138 # 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 -07001139 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
1140 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
1141 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is set when the operation is created.
1142 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
1143 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
1144 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this operation.
Sai Cheemalapatidf613972016-10-21 13:59:49 -07001145 {
Bu Sun Kim65020912020-05-20 12:08:20 -07001146 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
1147 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error. This property is optional.
1148 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
Sai Cheemalapatidf613972016-10-21 13:59:49 -07001149 },
1150 ],
1151 },
Bu Sun Kim65020912020-05-20 12:08:20 -07001152 &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`.
1153 &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.
1154 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
1155 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
1156 &quot;kind&quot;: &quot;compute#operation&quot;, # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
1157 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
1158 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
1159 &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.
1160 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
1161 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
1162 &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.
1163 &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`.
1164 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the operation.
1165 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
1166 &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.
1167 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example: `user@example.com`.
1168 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
1169 {
1170 &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.
1171 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example:
1172 # &quot;data&quot;: [ { &quot;key&quot;: &quot;scope&quot;, &quot;value&quot;: &quot;zones/us-east1-d&quot; }
1173 {
1174 &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).
1175 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
1176 },
1177 ],
1178 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
1179 },
1180 ],
1181 &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 Cheemalapatidf613972016-10-21 13:59:49 -07001182 }</pre>
1183</div>
1184
1185</body></html>