blob: bde8ae1ee160de18e2221ecfaae52537885a5ccc [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_alpha.html">Compute Engine API</a> . <a href="compute_alpha.healthChecks.html">healthChecks</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070078 <code><a href="#aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, returnPartialSuccess=None, filter=None, includeAllScopes=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">
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -040084 <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">
Dan O'Mearadd494642020-05-01 07:42:23 -070093 <code><a href="#list">list(project, orderBy=None, maxResults=None, pageToken=None, returnPartialSuccess=None, filter=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">
Dan O'Mearadd494642020-05-01 07:42:23 -0700109 <code class="details" id="aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, returnPartialSuccess=None, filter=None, includeAllScopes=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)
114 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
115
Dan O'Mearadd494642020-05-01 07:42:23 -0700116You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700117
Dan O'Mearadd494642020-05-01 07:42:23 -0700118Currently, only sorting by `name` or `creationTimestamp desc` is supported.
119 maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)
120 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.
121 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false and the logic is the same as today.
122 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 -0700123
Dan O'Mearadd494642020-05-01 07:42:23 -0700124For 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 -0700125
Dan O'Mearadd494642020-05-01 07:42:23 -0700126You 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 -0700127
Dan O'Mearadd494642020-05-01 07:42:23 -0700128To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ```
129 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 Kim715bd7f2019-06-14 16:50:42 -0700130
131Returns:
132 An object of the form:
133
134 {
135 "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
136 "kind": "compute#healthChecksAggregatedList", # Type of resource.
137 "items": { # A list of HealthChecksScopedList resources.
138 "a_key": { # Name of the scope containing this set of HealthChecks.
139 "healthChecks": [ # A list of HealthChecks contained in this scope.
Dan O'Mearadd494642020-05-01 07:42:23 -0700140 { # Represents a Health Check resource.
141 #
142 # Google Compute Engine has two Health Check resources:
143 #
144 # * [Global](/compute/docs/reference/rest/{$api_version}/healthChecks) * [Regional](/compute/docs/reference/rest/{$api_version}/regionHealthChecks)
145 #
146 # 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.
147 #
148 # To perform health checks on network load balancers, you must use either httpHealthChecks or httpsHealthChecks.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700149 "kind": "compute#healthCheck", # Type of the resource.
150 "udpHealthCheck": {
151 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
152 "request": "A String", # Raw data of request to send in payload of UDP packet. It is an error if this is empty. The request data can only be ASCII.
153 "port": 42, # The UDP port number for the health check request. Valid values are 1 through 65535.
154 "response": "A String", # The bytes to match against the beginning of the response data. It is an error if this is empty. The response data can only be ASCII.
155 },
156 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
157 "timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec.
Dan O'Mearadd494642020-05-01 07:42:23 -0700158 "grpcHealthCheck": {
159 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. The port_name should conform to RFC1035.
160 "grpcServiceName": "A String", # The gRPC service name for the health check. This field is optional. The value of grpc_service_name has the following meanings by convention:
161 # - Empty service_name means the overall status of all services at the backend.
162 # - Non-empty service_name means the health of that gRPC service, as defined by the owner of the service.
163 # The grpc_service_name can only be ASCII.
164 "port": 42, # The port number for the health check request. Must be specified if port_name and port_specification are not set or if port_specification is USE_FIXED_PORT. Valid values are 1 through 65535.
165 "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values:
166 # USE_FIXED_PORT: The port number in port is used for health checking.
167 # USE_NAMED_PORT: The portName is used for health checking.
168 # 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.
169 #
170 #
171 # If not specified, gRPC health check follows behavior specified in port and portName fields.
172 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700173 "checkIntervalSec": 42, # How often (in seconds) to send a health check. The default value is 5 seconds.
174 "tcpHealthCheck": {
175 "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
176 "request": "A String", # The application data to send once the TCP connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.
177 "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values:
Dan O'Mearadd494642020-05-01 07:42:23 -0700178 # USE_FIXED_PORT: The port number in port is used for health checking.
179 # USE_NAMED_PORT: The portName is used for health checking.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700180 # 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.
181 #
182 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700183 # If not specified, TCP health check follows behavior specified in port and portName fields.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700184 "port": 42, # The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535.
185 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
186 "response": "A String", # The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.
187 },
188 "httpHealthCheck": {
189 "requestPath": "A String", # The request path of the HTTP health check request. The default value is /.
190 "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
191 "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values:
Dan O'Mearadd494642020-05-01 07:42:23 -0700192 # USE_FIXED_PORT: The port number in port is used for health checking.
193 # USE_NAMED_PORT: The portName is used for health checking.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700194 # 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.
195 #
196 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700197 # If not specified, HTTP health check follows behavior specified in port and portName fields.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700198 "response": "A String", # The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII.
199 "host": "A String", # The value of the host header in the HTTP health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.
200 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
201 "port": 42, # The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535.
202 },
203 "logConfig": { # Configuration of logging on a health check. If logging is enabled, logs will be exported to Stackdriver. # Configure logging on this health check.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700204 "enable": True or False, # Indicates whether or not to export logs. This is false by default, which means no health check logging will be done.
205 },
206 "httpsHealthCheck": {
207 "requestPath": "A String", # The request path of the HTTPS health check request. The default value is /.
208 "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
209 "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values:
Dan O'Mearadd494642020-05-01 07:42:23 -0700210 # USE_FIXED_PORT: The port number in port is used for health checking.
211 # USE_NAMED_PORT: The portName is used for health checking.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700212 # 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.
213 #
214 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700215 # If not specified, HTTPS health check follows behavior specified in port and portName fields.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700216 "response": "A String", # The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII.
217 "host": "A String", # The value of the host header in the HTTPS health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.
218 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
219 "port": 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.
220 },
221 "healthyThreshold": 42, # A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.
222 "sslHealthCheck": {
223 "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
224 "request": "A String", # The application data to send once the SSL connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.
225 "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values:
Dan O'Mearadd494642020-05-01 07:42:23 -0700226 # USE_FIXED_PORT: The port number in port is used for health checking.
227 # USE_NAMED_PORT: The portName is used for health checking.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700228 # 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.
229 #
230 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700231 # If not specified, SSL health check follows behavior specified in port and portName fields.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700232 "port": 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.
233 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
234 "response": "A String", # The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.
235 },
236 "http2HealthCheck": {
237 "requestPath": "A String", # The request path of the HTTP/2 health check request. The default value is /.
238 "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
239 "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values:
Dan O'Mearadd494642020-05-01 07:42:23 -0700240 # USE_FIXED_PORT: The port number in port is used for health checking.
241 # USE_NAMED_PORT: The portName is used for health checking.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700242 # 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.
243 #
244 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700245 # If not specified, HTTP2 health check follows behavior specified in port and portName fields.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700246 "response": "A String", # The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII.
247 "host": "A String", # The value of the host header in the HTTP/2 health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.
248 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
249 "port": 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.
250 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700251 "type": "A String", # Specifies the type of the healthCheck, either TCP, SSL, HTTP, HTTPS or HTTP2. If not specified, the default is TCP. Exactly one of the protocol-specific health check field must be specified, which must match type field.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700252 "region": "A String", # [Output Only] Region where the health check resides. Not applicable to global health checks.
253 "unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
254 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
255 "creationTimestamp": "A String", # [Output Only] Creation timestamp in 3339 text format.
256 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
257 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
258 "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
259 },
260 ],
261 "warning": { # Informational warning which replaces the list of backend services when the list is empty.
262 "message": "A String", # [Output Only] A human-readable description of the warning code.
263 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
264 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
265 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
266 {
267 "value": "A String", # [Output Only] A warning data value corresponding to the key.
268 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
269 },
270 ],
271 },
272 },
273 },
274 "warning": { # [Output Only] Informational warning message.
275 "message": "A String", # [Output Only] A human-readable description of the warning code.
276 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
277 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
278 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
279 {
280 "value": "A String", # [Output Only] A warning data value corresponding to the key.
281 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
282 },
283 ],
284 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700285 "unreachables": [ # [Output Only] Unreachable resources.
286 "A String",
287 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700288 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
289 "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
290 }</pre>
291</div>
292
293<div class="method">
294 <code class="details" id="aggregatedList_next">aggregatedList_next(previous_request, previous_response)</code>
295 <pre>Retrieves the next page of results.
296
297Args:
298 previous_request: The request for the previous page. (required)
299 previous_response: The response from the request for the previous page. (required)
300
301Returns:
302 A request object that you can call 'execute()' on to request the next
303 page. Returns None if there are no more items in the collection.
304 </pre>
305</div>
306
307<div class="method">
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400308 <code class="details" id="delete">delete(project, healthCheck, requestId=None)</code>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700309 <pre>Deletes the specified HealthCheck resource.
310
311Args:
312 project: string, Project ID for this request. (required)
313 healthCheck: string, Name of the HealthCheck resource to delete. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700314 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.
315
316For 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.
317
318The 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 -0700319
320Returns:
321 An object of the form:
322
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700323 { # Represents an Operation resource.
324 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700325 # Google Compute Engine has three Operation resources:
326 #
327 # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
328 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700329 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
330 #
331 # Operations can be global, regional or zonal.
Dan O'Mearadd494642020-05-01 07:42:23 -0700332 # - For global operations, use the `globalOperations` resource.
333 # - For regional operations, use the `regionOperations` resource.
334 # - For zonal operations, use the `zonalOperations` resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700335 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700336 # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700337 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700338 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400339 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Dan O'Mearadd494642020-05-01 07:42:23 -0700340 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700341 "zone": "A String", # [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 -0700342 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
Dan O'Mearadd494642020-05-01 07:42:23 -0700343 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
344 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700345 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
Dan O'Mearadd494642020-05-01 07:42:23 -0700346 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700347 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Dan O'Mearadd494642020-05-01 07:42:23 -0700348 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700349 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
350 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
351 {
352 "message": "A String", # [Output Only] A human-readable description of the warning code.
353 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
354 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
355 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
356 {
357 "value": "A String", # [Output Only] A warning data value corresponding to the key.
358 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
359 },
360 ],
361 },
362 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700363 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
Dan O'Mearadd494642020-05-01 07:42:23 -0700364 "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700365 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
Dan O'Mearadd494642020-05-01 07:42:23 -0700366 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
367 "name": "A String", # [Output Only] Name of the operation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700368 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700369 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
370 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
371 {
372 "message": "A String", # [Output Only] An optional, human-readable error message.
373 "code": "A String", # [Output Only] The error type identifier for this error.
374 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
375 },
376 ],
377 },
378 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
379 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800380 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700381 }</pre>
382</div>
383
384<div class="method">
385 <code class="details" id="get">get(project, healthCheck)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700386 <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 -0700387
388Args:
389 project: string, Project ID for this request. (required)
390 healthCheck: string, Name of the HealthCheck resource to return. (required)
391
392Returns:
393 An object of the form:
394
Dan O'Mearadd494642020-05-01 07:42:23 -0700395 { # Represents a Health Check resource.
396 #
397 # Google Compute Engine has two Health Check resources:
398 #
399 # * [Global](/compute/docs/reference/rest/{$api_version}/healthChecks) * [Regional](/compute/docs/reference/rest/{$api_version}/regionHealthChecks)
400 #
401 # 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.
402 #
403 # To perform health checks on network load balancers, you must use either httpHealthChecks or httpsHealthChecks.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700404 "kind": "compute#healthCheck", # Type of the resource.
405 "udpHealthCheck": {
406 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
407 "request": "A String", # Raw data of request to send in payload of UDP packet. It is an error if this is empty. The request data can only be ASCII.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400408 "port": 42, # The UDP port number for the health check request. Valid values are 1 through 65535.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700409 "response": "A String", # The bytes to match against the beginning of the response data. It is an error if this is empty. The response data can only be ASCII.
410 },
411 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
412 "timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec.
Dan O'Mearadd494642020-05-01 07:42:23 -0700413 "grpcHealthCheck": {
414 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. The port_name should conform to RFC1035.
415 "grpcServiceName": "A String", # The gRPC service name for the health check. This field is optional. The value of grpc_service_name has the following meanings by convention:
416 # - Empty service_name means the overall status of all services at the backend.
417 # - Non-empty service_name means the health of that gRPC service, as defined by the owner of the service.
418 # The grpc_service_name can only be ASCII.
419 "port": 42, # The port number for the health check request. Must be specified if port_name and port_specification are not set or if port_specification is USE_FIXED_PORT. Valid values are 1 through 65535.
420 "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values:
421 # USE_FIXED_PORT: The port number in port is used for health checking.
422 # USE_NAMED_PORT: The portName is used for health checking.
423 # 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.
424 #
425 #
426 # If not specified, gRPC health check follows behavior specified in port and portName fields.
427 },
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700428 "checkIntervalSec": 42, # How often (in seconds) to send a health check. The default value is 5 seconds.
429 "tcpHealthCheck": {
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700430 "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700431 "request": "A String", # The application data to send once the TCP connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.
432 "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values:
Dan O'Mearadd494642020-05-01 07:42:23 -0700433 # USE_FIXED_PORT: The port number in port is used for health checking.
434 # USE_NAMED_PORT: The portName is used for health checking.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700435 # 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.
436 #
437 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700438 # If not specified, TCP health check follows behavior specified in port and portName fields.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400439 "port": 42, # The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700440 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700441 "response": "A String", # The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.
442 },
443 "httpHealthCheck": {
444 "requestPath": "A String", # The request path of the HTTP health check request. The default value is /.
445 "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700446 "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values:
Dan O'Mearadd494642020-05-01 07:42:23 -0700447 # USE_FIXED_PORT: The port number in port is used for health checking.
448 # USE_NAMED_PORT: The portName is used for health checking.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700449 # 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.
450 #
451 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700452 # If not specified, HTTP health check follows behavior specified in port and portName fields.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700453 "response": "A String", # The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700454 "host": "A String", # The value of the host header in the HTTP health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.
455 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700456 "port": 42, # The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535.
457 },
458 "logConfig": { # Configuration of logging on a health check. If logging is enabled, logs will be exported to Stackdriver. # Configure logging on this health check.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700459 "enable": True or False, # Indicates whether or not to export logs. This is false by default, which means no health check logging will be done.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700460 },
461 "httpsHealthCheck": {
462 "requestPath": "A String", # The request path of the HTTPS health check request. The default value is /.
463 "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700464 "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values:
Dan O'Mearadd494642020-05-01 07:42:23 -0700465 # USE_FIXED_PORT: The port number in port is used for health checking.
466 # USE_NAMED_PORT: The portName is used for health checking.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700467 # 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.
468 #
469 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700470 # If not specified, HTTPS health check follows behavior specified in port and portName fields.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700471 "response": "A String", # The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700472 "host": "A String", # The value of the host header in the HTTPS health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.
473 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700474 "port": 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700475 },
476 "healthyThreshold": 42, # A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700477 "sslHealthCheck": {
478 "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
479 "request": "A String", # The application data to send once the SSL connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.
480 "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values:
Dan O'Mearadd494642020-05-01 07:42:23 -0700481 # USE_FIXED_PORT: The port number in port is used for health checking.
482 # USE_NAMED_PORT: The portName is used for health checking.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700483 # 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.
484 #
485 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700486 # If not specified, SSL health check follows behavior specified in port and portName fields.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700487 "port": 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.
488 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
489 "response": "A String", # The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.
490 },
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700491 "http2HealthCheck": {
492 "requestPath": "A String", # The request path of the HTTP/2 health check request. The default value is /.
493 "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700494 "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values:
Dan O'Mearadd494642020-05-01 07:42:23 -0700495 # USE_FIXED_PORT: The port number in port is used for health checking.
496 # USE_NAMED_PORT: The portName is used for health checking.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700497 # 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 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700500 # If not specified, HTTP2 health check follows behavior specified in port and portName fields.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700501 "response": "A String", # The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700502 "host": "A String", # The value of the host header in the HTTP/2 health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.
503 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400504 "port": 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700505 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700506 "type": "A String", # Specifies the type of the healthCheck, either TCP, SSL, HTTP, HTTPS or HTTP2. If not specified, the default is TCP. Exactly one of the protocol-specific health check field must be specified, which must match type field.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700507 "region": "A String", # [Output Only] Region where the health check resides. Not applicable to global health checks.
508 "unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
509 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700510 "creationTimestamp": "A String", # [Output Only] Creation timestamp in 3339 text format.
511 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
512 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700513 "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700514 }</pre>
515</div>
516
517<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700518 <code class="details" id="insert">insert(project, body=None, requestId=None)</code>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700519 <pre>Creates a HealthCheck resource in the specified project using the data included in the request.
520
521Args:
522 project: string, Project ID for this request. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700523 body: object, The request body.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700524 The object takes the form of:
525
Dan O'Mearadd494642020-05-01 07:42:23 -0700526{ # Represents a Health Check resource.
527 #
528 # Google Compute Engine has two Health Check resources:
529 #
530 # * [Global](/compute/docs/reference/rest/{$api_version}/healthChecks) * [Regional](/compute/docs/reference/rest/{$api_version}/regionHealthChecks)
531 #
532 # 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.
533 #
534 # To perform health checks on network load balancers, you must use either httpHealthChecks or httpsHealthChecks.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700535 "kind": "compute#healthCheck", # Type of the resource.
536 "udpHealthCheck": {
537 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
538 "request": "A String", # Raw data of request to send in payload of UDP packet. It is an error if this is empty. The request data can only be ASCII.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400539 "port": 42, # The UDP port number for the health check request. Valid values are 1 through 65535.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700540 "response": "A String", # The bytes to match against the beginning of the response data. It is an error if this is empty. The response data can only be ASCII.
541 },
542 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
543 "timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec.
Dan O'Mearadd494642020-05-01 07:42:23 -0700544 "grpcHealthCheck": {
545 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. The port_name should conform to RFC1035.
546 "grpcServiceName": "A String", # The gRPC service name for the health check. This field is optional. The value of grpc_service_name has the following meanings by convention:
547 # - Empty service_name means the overall status of all services at the backend.
548 # - Non-empty service_name means the health of that gRPC service, as defined by the owner of the service.
549 # The grpc_service_name can only be ASCII.
550 "port": 42, # The port number for the health check request. Must be specified if port_name and port_specification are not set or if port_specification is USE_FIXED_PORT. Valid values are 1 through 65535.
551 "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values:
552 # USE_FIXED_PORT: The port number in port is used for health checking.
553 # USE_NAMED_PORT: The portName is used for health checking.
554 # 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.
555 #
556 #
557 # If not specified, gRPC health check follows behavior specified in port and portName fields.
558 },
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700559 "checkIntervalSec": 42, # How often (in seconds) to send a health check. The default value is 5 seconds.
560 "tcpHealthCheck": {
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700561 "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700562 "request": "A String", # The application data to send once the TCP connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.
563 "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values:
Dan O'Mearadd494642020-05-01 07:42:23 -0700564 # USE_FIXED_PORT: The port number in port is used for health checking.
565 # USE_NAMED_PORT: The portName is used for health checking.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700566 # 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.
567 #
568 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700569 # If not specified, TCP health check follows behavior specified in port and portName fields.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400570 "port": 42, # The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700571 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700572 "response": "A String", # The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.
573 },
574 "httpHealthCheck": {
575 "requestPath": "A String", # The request path of the HTTP health check request. The default value is /.
576 "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700577 "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values:
Dan O'Mearadd494642020-05-01 07:42:23 -0700578 # USE_FIXED_PORT: The port number in port is used for health checking.
579 # USE_NAMED_PORT: The portName is used for health checking.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700580 # USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking.
581 #
582 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700583 # If not specified, HTTP health check follows behavior specified in port and portName fields.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700584 "response": "A String", # The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700585 "host": "A String", # The value of the host header in the HTTP health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.
586 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700587 "port": 42, # The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535.
588 },
589 "logConfig": { # Configuration of logging on a health check. If logging is enabled, logs will be exported to Stackdriver. # Configure logging on this health check.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700590 "enable": True or False, # Indicates whether or not to export logs. This is false by default, which means no health check logging will be done.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700591 },
592 "httpsHealthCheck": {
593 "requestPath": "A String", # The request path of the HTTPS health check request. The default value is /.
594 "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700595 "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values:
Dan O'Mearadd494642020-05-01 07:42:23 -0700596 # USE_FIXED_PORT: The port number in port is used for health checking.
597 # USE_NAMED_PORT: The portName is used for health checking.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700598 # 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.
599 #
600 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700601 # If not specified, HTTPS health check follows behavior specified in port and portName fields.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700602 "response": "A String", # The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700603 "host": "A String", # The value of the host header in the HTTPS health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.
604 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700605 "port": 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700606 },
607 "healthyThreshold": 42, # A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700608 "sslHealthCheck": {
609 "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
610 "request": "A String", # The application data to send once the SSL connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.
611 "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values:
Dan O'Mearadd494642020-05-01 07:42:23 -0700612 # USE_FIXED_PORT: The port number in port is used for health checking.
613 # USE_NAMED_PORT: The portName is used for health checking.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700614 # 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.
615 #
616 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700617 # If not specified, SSL health check follows behavior specified in port and portName fields.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700618 "port": 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.
619 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
620 "response": "A String", # The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.
621 },
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700622 "http2HealthCheck": {
623 "requestPath": "A String", # The request path of the HTTP/2 health check request. The default value is /.
624 "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700625 "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values:
Dan O'Mearadd494642020-05-01 07:42:23 -0700626 # USE_FIXED_PORT: The port number in port is used for health checking.
627 # USE_NAMED_PORT: The portName is used for health checking.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700628 # 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.
629 #
630 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700631 # If not specified, HTTP2 health check follows behavior specified in port and portName fields.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700632 "response": "A String", # The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700633 "host": "A String", # The value of the host header in the HTTP/2 health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.
634 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400635 "port": 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700636 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700637 "type": "A String", # Specifies the type of the healthCheck, either TCP, SSL, HTTP, HTTPS or HTTP2. If not specified, the default is TCP. Exactly one of the protocol-specific health check field must be specified, which must match type field.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700638 "region": "A String", # [Output Only] Region where the health check resides. Not applicable to global health checks.
639 "unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
640 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700641 "creationTimestamp": "A String", # [Output Only] Creation timestamp in 3339 text format.
642 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
643 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700644 "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700645 }
646
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700647 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.
648
649For 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.
650
651The 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 -0700652
653Returns:
654 An object of the form:
655
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700656 { # Represents an Operation resource.
657 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700658 # Google Compute Engine has three Operation resources:
659 #
660 # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
661 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700662 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
663 #
664 # Operations can be global, regional or zonal.
Dan O'Mearadd494642020-05-01 07:42:23 -0700665 # - For global operations, use the `globalOperations` resource.
666 # - For regional operations, use the `regionOperations` resource.
667 # - For zonal operations, use the `zonalOperations` resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700668 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700669 # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700670 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700671 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400672 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Dan O'Mearadd494642020-05-01 07:42:23 -0700673 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700674 "zone": "A String", # [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 -0700675 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
Dan O'Mearadd494642020-05-01 07:42:23 -0700676 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
677 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700678 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
Dan O'Mearadd494642020-05-01 07:42:23 -0700679 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700680 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Dan O'Mearadd494642020-05-01 07:42:23 -0700681 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700682 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
683 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
684 {
685 "message": "A String", # [Output Only] A human-readable description of the warning code.
686 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
687 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
688 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
689 {
690 "value": "A String", # [Output Only] A warning data value corresponding to the key.
691 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
692 },
693 ],
694 },
695 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700696 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
Dan O'Mearadd494642020-05-01 07:42:23 -0700697 "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700698 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
Dan O'Mearadd494642020-05-01 07:42:23 -0700699 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
700 "name": "A String", # [Output Only] Name of the operation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700701 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700702 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
703 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
704 {
705 "message": "A String", # [Output Only] An optional, human-readable error message.
706 "code": "A String", # [Output Only] The error type identifier for this error.
707 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
708 },
709 ],
710 },
711 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
712 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800713 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700714 }</pre>
715</div>
716
717<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700718 <code class="details" id="list">list(project, orderBy=None, maxResults=None, pageToken=None, returnPartialSuccess=None, filter=None)</code>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700719 <pre>Retrieves the list of HealthCheck resources available to the specified project.
720
721Args:
722 project: string, Project ID for this request. (required)
723 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
724
Dan O'Mearadd494642020-05-01 07:42:23 -0700725You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700726
Dan O'Mearadd494642020-05-01 07:42:23 -0700727Currently, only sorting by `name` or `creationTimestamp desc` is supported.
728 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`)
729 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.
730 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false and the logic is the same as today.
731 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 -0700732
Dan O'Mearadd494642020-05-01 07:42:23 -0700733For 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 -0700734
Dan O'Mearadd494642020-05-01 07:42:23 -0700735You 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 -0700736
Dan O'Mearadd494642020-05-01 07:42:23 -0700737To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ```
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700738
739Returns:
740 An object of the form:
741
742 { # Contains a list of HealthCheck resources.
743 "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700744 "kind": "compute#healthCheckList", # Type of resource.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700745 "items": [ # A list of HealthCheck resources.
Dan O'Mearadd494642020-05-01 07:42:23 -0700746 { # Represents a Health Check resource.
747 #
748 # Google Compute Engine has two Health Check resources:
749 #
750 # * [Global](/compute/docs/reference/rest/{$api_version}/healthChecks) * [Regional](/compute/docs/reference/rest/{$api_version}/regionHealthChecks)
751 #
752 # 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.
753 #
754 # To perform health checks on network load balancers, you must use either httpHealthChecks or httpsHealthChecks.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700755 "kind": "compute#healthCheck", # Type of the resource.
756 "udpHealthCheck": {
757 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
758 "request": "A String", # Raw data of request to send in payload of UDP packet. It is an error if this is empty. The request data can only be ASCII.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400759 "port": 42, # The UDP port number for the health check request. Valid values are 1 through 65535.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700760 "response": "A String", # The bytes to match against the beginning of the response data. It is an error if this is empty. The response data can only be ASCII.
761 },
762 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
763 "timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec.
Dan O'Mearadd494642020-05-01 07:42:23 -0700764 "grpcHealthCheck": {
765 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. The port_name should conform to RFC1035.
766 "grpcServiceName": "A String", # The gRPC service name for the health check. This field is optional. The value of grpc_service_name has the following meanings by convention:
767 # - Empty service_name means the overall status of all services at the backend.
768 # - Non-empty service_name means the health of that gRPC service, as defined by the owner of the service.
769 # The grpc_service_name can only be ASCII.
770 "port": 42, # The port number for the health check request. Must be specified if port_name and port_specification are not set or if port_specification is USE_FIXED_PORT. Valid values are 1 through 65535.
771 "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values:
772 # USE_FIXED_PORT: The port number in port is used for health checking.
773 # USE_NAMED_PORT: The portName is used for health checking.
774 # 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.
775 #
776 #
777 # If not specified, gRPC health check follows behavior specified in port and portName fields.
778 },
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700779 "checkIntervalSec": 42, # How often (in seconds) to send a health check. The default value is 5 seconds.
780 "tcpHealthCheck": {
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700781 "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700782 "request": "A String", # The application data to send once the TCP connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.
783 "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values:
Dan O'Mearadd494642020-05-01 07:42:23 -0700784 # USE_FIXED_PORT: The port number in port is used for health checking.
785 # USE_NAMED_PORT: The portName is used for health checking.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700786 # 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.
787 #
788 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700789 # If not specified, TCP health check follows behavior specified in port and portName fields.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400790 "port": 42, # The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700791 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700792 "response": "A String", # The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.
793 },
794 "httpHealthCheck": {
795 "requestPath": "A String", # The request path of the HTTP health check request. The default value is /.
796 "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700797 "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values:
Dan O'Mearadd494642020-05-01 07:42:23 -0700798 # USE_FIXED_PORT: The port number in port is used for health checking.
799 # USE_NAMED_PORT: The portName is used for health checking.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700800 # 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.
801 #
802 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700803 # If not specified, HTTP health check follows behavior specified in port and portName fields.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700804 "response": "A String", # The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700805 "host": "A String", # The value of the host header in the HTTP health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.
806 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700807 "port": 42, # The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535.
808 },
809 "logConfig": { # Configuration of logging on a health check. If logging is enabled, logs will be exported to Stackdriver. # Configure logging on this health check.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700810 "enable": True or False, # Indicates whether or not to export logs. This is false by default, which means no health check logging will be done.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700811 },
812 "httpsHealthCheck": {
813 "requestPath": "A String", # The request path of the HTTPS health check request. The default value is /.
814 "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700815 "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values:
Dan O'Mearadd494642020-05-01 07:42:23 -0700816 # USE_FIXED_PORT: The port number in port is used for health checking.
817 # USE_NAMED_PORT: The portName is used for health checking.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700818 # 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.
819 #
820 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700821 # If not specified, HTTPS health check follows behavior specified in port and portName fields.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700822 "response": "A String", # The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700823 "host": "A String", # The value of the host header in the HTTPS health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.
824 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700825 "port": 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700826 },
827 "healthyThreshold": 42, # A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700828 "sslHealthCheck": {
829 "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
830 "request": "A String", # The application data to send once the 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.
831 "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values:
Dan O'Mearadd494642020-05-01 07:42:23 -0700832 # USE_FIXED_PORT: The port number in port is used for health checking.
833 # USE_NAMED_PORT: The portName is used for health checking.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700834 # USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking.
835 #
836 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700837 # If not specified, SSL health check follows behavior specified in port and portName fields.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700838 "port": 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.
839 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
840 "response": "A String", # The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.
841 },
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700842 "http2HealthCheck": {
843 "requestPath": "A String", # The request path of the HTTP/2 health check request. The default value is /.
844 "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700845 "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values:
Dan O'Mearadd494642020-05-01 07:42:23 -0700846 # USE_FIXED_PORT: The port number in port is used for health checking.
847 # USE_NAMED_PORT: The portName is used for health checking.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700848 # USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking.
849 #
850 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700851 # If not specified, HTTP2 health check follows behavior specified in port and portName fields.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700852 "response": "A String", # The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700853 "host": "A String", # The value of the host header in the HTTP/2 health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.
854 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400855 "port": 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700856 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700857 "type": "A String", # Specifies the type of the healthCheck, either TCP, SSL, HTTP, HTTPS or HTTP2. If not specified, the default is TCP. Exactly one of the protocol-specific health check field must be specified, which must match type field.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700858 "region": "A String", # [Output Only] Region where the health check resides. Not applicable to global health checks.
859 "unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
860 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700861 "creationTimestamp": "A String", # [Output Only] Creation timestamp in 3339 text format.
862 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
863 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700864 "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700865 },
866 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700867 "warning": { # [Output Only] Informational warning message.
868 "message": "A String", # [Output Only] A human-readable description of the warning code.
869 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
870 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
871 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
872 {
873 "value": "A String", # [Output Only] A warning data value corresponding to the key.
874 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
875 },
876 ],
877 },
878 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700879 "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
880 }</pre>
881</div>
882
883<div class="method">
884 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
885 <pre>Retrieves the next page of results.
886
887Args:
888 previous_request: The request for the previous page. (required)
889 previous_response: The response from the request for the previous page. (required)
890
891Returns:
892 A request object that you can call 'execute()' on to request the next
893 page. Returns None if there are no more items in the collection.
894 </pre>
895</div>
896
897<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700898 <code class="details" id="patch">patch(project, healthCheck, body=None, requestId=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700899 <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 -0700900
901Args:
902 project: string, Project ID for this request. (required)
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400903 healthCheck: string, Name of the HealthCheck resource to patch. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700904 body: object, The request body.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700905 The object takes the form of:
906
Dan O'Mearadd494642020-05-01 07:42:23 -0700907{ # Represents a Health Check resource.
908 #
909 # Google Compute Engine has two Health Check resources:
910 #
911 # * [Global](/compute/docs/reference/rest/{$api_version}/healthChecks) * [Regional](/compute/docs/reference/rest/{$api_version}/regionHealthChecks)
912 #
913 # 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.
914 #
915 # To perform health checks on network load balancers, you must use either httpHealthChecks or httpsHealthChecks.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700916 "kind": "compute#healthCheck", # Type of the resource.
917 "udpHealthCheck": {
918 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
919 "request": "A String", # Raw data of request to send in payload of UDP packet. It is an error if this is empty. The request data can only be ASCII.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400920 "port": 42, # The UDP port number for the health check request. Valid values are 1 through 65535.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700921 "response": "A String", # The bytes to match against the beginning of the response data. It is an error if this is empty. The response data can only be ASCII.
922 },
923 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
924 "timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec.
Dan O'Mearadd494642020-05-01 07:42:23 -0700925 "grpcHealthCheck": {
926 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. The port_name should conform to RFC1035.
927 "grpcServiceName": "A String", # The gRPC service name for the health check. This field is optional. The value of grpc_service_name has the following meanings by convention:
928 # - Empty service_name means the overall status of all services at the backend.
929 # - Non-empty service_name means the health of that gRPC service, as defined by the owner of the service.
930 # The grpc_service_name can only be ASCII.
931 "port": 42, # The port number for the health check request. Must be specified if port_name and port_specification are not set or if port_specification is USE_FIXED_PORT. Valid values are 1 through 65535.
932 "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values:
933 # USE_FIXED_PORT: The port number in port is used for health checking.
934 # USE_NAMED_PORT: The portName is used for health checking.
935 # 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.
936 #
937 #
938 # If not specified, gRPC health check follows behavior specified in port and portName fields.
939 },
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700940 "checkIntervalSec": 42, # How often (in seconds) to send a health check. The default value is 5 seconds.
941 "tcpHealthCheck": {
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700942 "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700943 "request": "A String", # The application data to send once the TCP connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.
944 "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values:
Dan O'Mearadd494642020-05-01 07:42:23 -0700945 # USE_FIXED_PORT: The port number in port is used for health checking.
946 # USE_NAMED_PORT: The portName is used for health checking.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700947 # 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.
948 #
949 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700950 # If not specified, TCP health check follows behavior specified in port and portName fields.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400951 "port": 42, # The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700952 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700953 "response": "A String", # The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.
954 },
955 "httpHealthCheck": {
956 "requestPath": "A String", # The request path of the HTTP health check request. The default value is /.
957 "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700958 "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values:
Dan O'Mearadd494642020-05-01 07:42:23 -0700959 # USE_FIXED_PORT: The port number in port is used for health checking.
960 # USE_NAMED_PORT: The portName is used for health checking.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700961 # 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.
962 #
963 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700964 # If not specified, HTTP health check follows behavior specified in port and portName fields.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700965 "response": "A String", # The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700966 "host": "A String", # The value of the host header in the HTTP health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.
967 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700968 "port": 42, # The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535.
969 },
970 "logConfig": { # Configuration of logging on a health check. If logging is enabled, logs will be exported to Stackdriver. # Configure logging on this health check.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700971 "enable": True or False, # Indicates whether or not to export logs. This is false by default, which means no health check logging will be done.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700972 },
973 "httpsHealthCheck": {
974 "requestPath": "A String", # The request path of the HTTPS health check request. The default value is /.
975 "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700976 "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values:
Dan O'Mearadd494642020-05-01 07:42:23 -0700977 # USE_FIXED_PORT: The port number in port is used for health checking.
978 # USE_NAMED_PORT: The portName is used for health checking.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700979 # 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.
980 #
981 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700982 # If not specified, HTTPS health check follows behavior specified in port and portName fields.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700983 "response": "A String", # The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700984 "host": "A String", # The value of the host header in the HTTPS health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.
985 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700986 "port": 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700987 },
988 "healthyThreshold": 42, # A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700989 "sslHealthCheck": {
990 "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
991 "request": "A String", # The application data to send once the SSL connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.
992 "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values:
Dan O'Mearadd494642020-05-01 07:42:23 -0700993 # USE_FIXED_PORT: The port number in port is used for health checking.
994 # USE_NAMED_PORT: The portName is used for health checking.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700995 # 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.
996 #
997 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700998 # If not specified, SSL health check follows behavior specified in port and portName fields.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700999 "port": 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.
1000 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
1001 "response": "A String", # The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.
1002 },
Sai Cheemalapatidf613972016-10-21 13:59:49 -07001003 "http2HealthCheck": {
1004 "requestPath": "A String", # The request path of the HTTP/2 health check request. The default value is /.
1005 "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001006 "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values:
Dan O'Mearadd494642020-05-01 07:42:23 -07001007 # USE_FIXED_PORT: The port number in port is used for health checking.
1008 # USE_NAMED_PORT: The portName is used for health checking.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001009 # 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.
1010 #
1011 #
Dan O'Mearadd494642020-05-01 07:42:23 -07001012 # If not specified, HTTP2 health check follows behavior specified in port and portName fields.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001013 "response": "A String", # The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII.
Sai Cheemalapatidf613972016-10-21 13:59:49 -07001014 "host": "A String", # The value of the host header in the HTTP/2 health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.
1015 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -04001016 "port": 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.
Sai Cheemalapatidf613972016-10-21 13:59:49 -07001017 },
Dan O'Mearadd494642020-05-01 07:42:23 -07001018 "type": "A String", # Specifies the type of the healthCheck, either TCP, SSL, HTTP, HTTPS or HTTP2. If not specified, the default is TCP. Exactly one of the protocol-specific health check field must be specified, which must match type field.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001019 "region": "A String", # [Output Only] Region where the health check resides. Not applicable to global health checks.
1020 "unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
1021 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
Sai Cheemalapatidf613972016-10-21 13:59:49 -07001022 "creationTimestamp": "A String", # [Output Only] Creation timestamp in 3339 text format.
1023 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
1024 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001025 "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
Sai Cheemalapatidf613972016-10-21 13:59:49 -07001026 }
1027
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001028 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.
1029
1030For 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.
1031
1032The 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 -07001033
1034Returns:
1035 An object of the form:
1036
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001037 { # Represents an Operation resource.
1038 #
Dan O'Mearadd494642020-05-01 07:42:23 -07001039 # Google Compute Engine has three Operation resources:
1040 #
1041 # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
1042 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001043 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
1044 #
1045 # Operations can be global, regional or zonal.
Dan O'Mearadd494642020-05-01 07:42:23 -07001046 # - For global operations, use the `globalOperations` resource.
1047 # - For regional operations, use the `regionOperations` resource.
1048 # - For zonal operations, use the `zonalOperations` resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001049 #
Dan O'Mearadd494642020-05-01 07:42:23 -07001050 # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
Sai Cheemalapatidf613972016-10-21 13:59:49 -07001051 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001052 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -04001053 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Dan O'Mearadd494642020-05-01 07:42:23 -07001054 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001055 "zone": "A String", # [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 -07001056 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
Dan O'Mearadd494642020-05-01 07:42:23 -07001057 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
1058 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
Sai Cheemalapatidf613972016-10-21 13:59:49 -07001059 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
Dan O'Mearadd494642020-05-01 07:42:23 -07001060 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.
Sai Cheemalapatidf613972016-10-21 13:59:49 -07001061 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Dan O'Mearadd494642020-05-01 07:42:23 -07001062 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
Sai Cheemalapatidf613972016-10-21 13:59:49 -07001063 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
1064 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
1065 {
1066 "message": "A String", # [Output Only] A human-readable description of the warning code.
1067 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
1068 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
1069 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
1070 {
1071 "value": "A String", # [Output Only] A warning data value corresponding to the key.
1072 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
1073 },
1074 ],
1075 },
1076 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001077 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
Dan O'Mearadd494642020-05-01 07:42:23 -07001078 "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
Sai Cheemalapatidf613972016-10-21 13:59:49 -07001079 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
Dan O'Mearadd494642020-05-01 07:42:23 -07001080 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
1081 "name": "A String", # [Output Only] Name of the operation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001082 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
Sai Cheemalapatidf613972016-10-21 13:59:49 -07001083 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
1084 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
1085 {
1086 "message": "A String", # [Output Only] An optional, human-readable error message.
1087 "code": "A String", # [Output Only] The error type identifier for this error.
1088 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
1089 },
1090 ],
1091 },
1092 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
1093 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -08001094 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
Sai Cheemalapatidf613972016-10-21 13:59:49 -07001095 }</pre>
1096</div>
1097
1098<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -07001099 <code class="details" id="testIamPermissions">testIamPermissions(project, resource, body=None)</code>
Sai Cheemalapatidf613972016-10-21 13:59:49 -07001100 <pre>Returns permissions that a caller has on the specified resource.
1101
1102Args:
1103 project: string, Project ID for this request. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001104 resource: string, Name or id of the resource for this request. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -07001105 body: object, The request body.
Sai Cheemalapatidf613972016-10-21 13:59:49 -07001106 The object takes the form of:
1107
1108{
1109 "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
1110 "A String",
1111 ],
1112 }
1113
1114
1115Returns:
1116 An object of the form:
1117
1118 {
1119 "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
1120 "A String",
1121 ],
1122 }</pre>
1123</div>
1124
1125<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -07001126 <code class="details" id="update">update(project, healthCheck, body=None, requestId=None)</code>
Sai Cheemalapatidf613972016-10-21 13:59:49 -07001127 <pre>Updates a HealthCheck resource in the specified project using the data included in the request.
1128
1129Args:
1130 project: string, Project ID for this request. (required)
1131 healthCheck: string, Name of the HealthCheck resource to update. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -07001132 body: object, The request body.
Sai Cheemalapatidf613972016-10-21 13:59:49 -07001133 The object takes the form of:
1134
Dan O'Mearadd494642020-05-01 07:42:23 -07001135{ # Represents a Health Check resource.
1136 #
1137 # Google Compute Engine has two Health Check resources:
1138 #
1139 # * [Global](/compute/docs/reference/rest/{$api_version}/healthChecks) * [Regional](/compute/docs/reference/rest/{$api_version}/regionHealthChecks)
1140 #
1141 # 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.
1142 #
1143 # To perform health checks on network load balancers, you must use either httpHealthChecks or httpsHealthChecks.
Sai Cheemalapatidf613972016-10-21 13:59:49 -07001144 "kind": "compute#healthCheck", # Type of the resource.
1145 "udpHealthCheck": {
1146 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
1147 "request": "A String", # Raw data of request to send in payload of UDP packet. It is an error if this is empty. The request data can only be ASCII.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -04001148 "port": 42, # The UDP port number for the health check request. Valid values are 1 through 65535.
Sai Cheemalapatidf613972016-10-21 13:59:49 -07001149 "response": "A String", # The bytes to match against the beginning of the response data. It is an error if this is empty. The response data can only be ASCII.
1150 },
1151 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
1152 "timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec.
Dan O'Mearadd494642020-05-01 07:42:23 -07001153 "grpcHealthCheck": {
1154 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. The port_name should conform to RFC1035.
1155 "grpcServiceName": "A String", # The gRPC service name for the health check. This field is optional. The value of grpc_service_name has the following meanings by convention:
1156 # - Empty service_name means the overall status of all services at the backend.
1157 # - Non-empty service_name means the health of that gRPC service, as defined by the owner of the service.
1158 # The grpc_service_name can only be ASCII.
1159 "port": 42, # The port number for the health check request. Must be specified if port_name and port_specification are not set or if port_specification is USE_FIXED_PORT. Valid values are 1 through 65535.
1160 "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values:
1161 # USE_FIXED_PORT: The port number in port is used for health checking.
1162 # USE_NAMED_PORT: The portName is used for health checking.
1163 # 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.
1164 #
1165 #
1166 # If not specified, gRPC health check follows behavior specified in port and portName fields.
1167 },
Sai Cheemalapatidf613972016-10-21 13:59:49 -07001168 "checkIntervalSec": 42, # How often (in seconds) to send a health check. The default value is 5 seconds.
1169 "tcpHealthCheck": {
Sai Cheemalapatidf613972016-10-21 13:59:49 -07001170 "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001171 "request": "A String", # The application data to send once the TCP connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.
1172 "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values:
Dan O'Mearadd494642020-05-01 07:42:23 -07001173 # USE_FIXED_PORT: The port number in port is used for health checking.
1174 # USE_NAMED_PORT: The portName is used for health checking.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001175 # 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.
1176 #
1177 #
Dan O'Mearadd494642020-05-01 07:42:23 -07001178 # If not specified, TCP health check follows behavior specified in port and portName fields.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -04001179 "port": 42, # The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001180 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
Sai Cheemalapatidf613972016-10-21 13:59:49 -07001181 "response": "A String", # The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.
1182 },
1183 "httpHealthCheck": {
1184 "requestPath": "A String", # The request path of the HTTP health check request. The default value is /.
1185 "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001186 "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values:
Dan O'Mearadd494642020-05-01 07:42:23 -07001187 # USE_FIXED_PORT: The port number in port is used for health checking.
1188 # USE_NAMED_PORT: The portName is used for health checking.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001189 # 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.
1190 #
1191 #
Dan O'Mearadd494642020-05-01 07:42:23 -07001192 # If not specified, HTTP health check follows behavior specified in port and portName fields.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001193 "response": "A String", # The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII.
Sai Cheemalapatidf613972016-10-21 13:59:49 -07001194 "host": "A String", # The value of the host header in the HTTP health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.
1195 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001196 "port": 42, # The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535.
1197 },
1198 "logConfig": { # Configuration of logging on a health check. If logging is enabled, logs will be exported to Stackdriver. # Configure logging on this health check.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001199 "enable": True or False, # Indicates whether or not to export logs. This is false by default, which means no health check logging will be done.
Sai Cheemalapatidf613972016-10-21 13:59:49 -07001200 },
1201 "httpsHealthCheck": {
1202 "requestPath": "A String", # The request path of the HTTPS health check request. The default value is /.
1203 "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001204 "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values:
Dan O'Mearadd494642020-05-01 07:42:23 -07001205 # USE_FIXED_PORT: The port number in port is used for health checking.
1206 # USE_NAMED_PORT: The portName is used for health checking.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001207 # 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.
1208 #
1209 #
Dan O'Mearadd494642020-05-01 07:42:23 -07001210 # If not specified, HTTPS health check follows behavior specified in port and portName fields.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001211 "response": "A String", # The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII.
Sai Cheemalapatidf613972016-10-21 13:59:49 -07001212 "host": "A String", # The value of the host header in the HTTPS health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.
1213 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001214 "port": 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.
Sai Cheemalapatidf613972016-10-21 13:59:49 -07001215 },
1216 "healthyThreshold": 42, # A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001217 "sslHealthCheck": {
1218 "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
1219 "request": "A String", # The application data to send once the SSL connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.
1220 "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values:
Dan O'Mearadd494642020-05-01 07:42:23 -07001221 # USE_FIXED_PORT: The port number in port is used for health checking.
1222 # USE_NAMED_PORT: The portName is used for health checking.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001223 # 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.
1224 #
1225 #
Dan O'Mearadd494642020-05-01 07:42:23 -07001226 # If not specified, SSL health check follows behavior specified in port and portName fields.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001227 "port": 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.
1228 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
1229 "response": "A String", # The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.
1230 },
Sai Cheemalapatidf613972016-10-21 13:59:49 -07001231 "http2HealthCheck": {
1232 "requestPath": "A String", # The request path of the HTTP/2 health check request. The default value is /.
1233 "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001234 "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values:
Dan O'Mearadd494642020-05-01 07:42:23 -07001235 # USE_FIXED_PORT: The port number in port is used for health checking.
1236 # USE_NAMED_PORT: The portName is used for health checking.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001237 # 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.
1238 #
1239 #
Dan O'Mearadd494642020-05-01 07:42:23 -07001240 # If not specified, HTTP2 health check follows behavior specified in port and portName fields.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001241 "response": "A String", # The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII.
Sai Cheemalapatidf613972016-10-21 13:59:49 -07001242 "host": "A String", # The value of the host header in the HTTP/2 health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.
1243 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -04001244 "port": 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.
Sai Cheemalapatidf613972016-10-21 13:59:49 -07001245 },
Dan O'Mearadd494642020-05-01 07:42:23 -07001246 "type": "A String", # Specifies the type of the healthCheck, either TCP, SSL, HTTP, HTTPS or HTTP2. If not specified, the default is TCP. Exactly one of the protocol-specific health check field must be specified, which must match type field.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001247 "region": "A String", # [Output Only] Region where the health check resides. Not applicable to global health checks.
1248 "unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
1249 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
Sai Cheemalapatidf613972016-10-21 13:59:49 -07001250 "creationTimestamp": "A String", # [Output Only] Creation timestamp in 3339 text format.
1251 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
1252 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001253 "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
Sai Cheemalapatidf613972016-10-21 13:59:49 -07001254 }
1255
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001256 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.
1257
1258For 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.
1259
1260The 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 -07001261
1262Returns:
1263 An object of the form:
1264
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001265 { # Represents an Operation resource.
1266 #
Dan O'Mearadd494642020-05-01 07:42:23 -07001267 # Google Compute Engine has three Operation resources:
1268 #
1269 # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
1270 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001271 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
1272 #
1273 # Operations can be global, regional or zonal.
Dan O'Mearadd494642020-05-01 07:42:23 -07001274 # - For global operations, use the `globalOperations` resource.
1275 # - For regional operations, use the `regionOperations` resource.
1276 # - For zonal operations, use the `zonalOperations` resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001277 #
Dan O'Mearadd494642020-05-01 07:42:23 -07001278 # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
Sai Cheemalapatidf613972016-10-21 13:59:49 -07001279 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001280 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -04001281 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Dan O'Mearadd494642020-05-01 07:42:23 -07001282 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001283 "zone": "A String", # [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 -07001284 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
Dan O'Mearadd494642020-05-01 07:42:23 -07001285 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
1286 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
Sai Cheemalapatidf613972016-10-21 13:59:49 -07001287 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
Dan O'Mearadd494642020-05-01 07:42:23 -07001288 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.
Sai Cheemalapatidf613972016-10-21 13:59:49 -07001289 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Dan O'Mearadd494642020-05-01 07:42:23 -07001290 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
Sai Cheemalapatidf613972016-10-21 13:59:49 -07001291 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
1292 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
1293 {
1294 "message": "A String", # [Output Only] A human-readable description of the warning code.
1295 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
1296 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
1297 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
1298 {
1299 "value": "A String", # [Output Only] A warning data value corresponding to the key.
1300 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
1301 },
1302 ],
1303 },
1304 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001305 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
Dan O'Mearadd494642020-05-01 07:42:23 -07001306 "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
Sai Cheemalapatidf613972016-10-21 13:59:49 -07001307 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
Dan O'Mearadd494642020-05-01 07:42:23 -07001308 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
1309 "name": "A String", # [Output Only] Name of the operation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001310 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
Sai Cheemalapatidf613972016-10-21 13:59:49 -07001311 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
1312 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
1313 {
1314 "message": "A String", # [Output Only] An optional, human-readable error message.
1315 "code": "A String", # [Output Only] The error type identifier for this error.
1316 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
1317 },
1318 ],
1319 },
1320 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
1321 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -08001322 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
Sai Cheemalapatidf613972016-10-21 13:59:49 -07001323 }</pre>
1324</div>
1325
1326</body></html>