blob: d7c928ae31f4f3e31a922fdb6dca8c51c2a3c4bc [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -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.regionHealthChecks.html">regionHealthChecks</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#delete">delete(project, region, healthCheck, requestId=None)</a></code></p>
79<p class="firstline">Deletes the specified HealthCheck resource.</p>
80<p class="toc_element">
81 <code><a href="#get">get(project, region, healthCheck)</a></code></p>
82<p class="firstline">Returns the specified HealthCheck resource. Gets a list of available health checks by making a list() request.</p>
83<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070084 <code><a href="#insert">insert(project, region, body=None, requestId=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070085<p class="firstline">Creates a HealthCheck resource in the specified project using the data included in the request.</p>
86<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070087 <code><a href="#list">list(project, region, orderBy=None, maxResults=None, pageToken=None, returnPartialSuccess=None, filter=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070088<p class="firstline">Retrieves the list of HealthCheck resources available to the specified project.</p>
89<p class="toc_element">
90 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
91<p class="firstline">Retrieves the next page of results.</p>
92<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070093 <code><a href="#patch">patch(project, region, healthCheck, body=None, requestId=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070094<p class="firstline">Updates a HealthCheck resource in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.</p>
95<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070096 <code><a href="#testIamPermissions">testIamPermissions(project, region, resource, body=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070097<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
98<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070099 <code><a href="#update">update(project, region, 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.</p>
101<h3>Method Details</h3>
102<div class="method">
103 <code class="details" id="delete">delete(project, region, healthCheck, requestId=None)</code>
104 <pre>Deletes the specified HealthCheck resource.
105
106Args:
107 project: string, Project ID for this request. (required)
108 region: string, Name of the region scoping this request. (required)
109 healthCheck: string, Name of the HealthCheck resource to delete. (required)
110 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.
111
112For 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.
113
114The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
115
116Returns:
117 An object of the form:
118
119 { # Represents an Operation resource.
120 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700121 # Google Compute Engine has three Operation resources:
122 #
123 # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
124 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700125 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
126 #
127 # Operations can be global, regional or zonal.
Dan O'Mearadd494642020-05-01 07:42:23 -0700128 # - For global operations, use the `globalOperations` resource.
129 # - For regional operations, use the `regionOperations` resource.
130 # - For zonal operations, use the `zonalOperations` resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700131 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700132 # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700133 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
134 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
135 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Dan O'Mearadd494642020-05-01 07:42:23 -0700136 "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 -0700137 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
138 "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 -0700139 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
140 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700141 "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 -0700142 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700143 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Dan O'Mearadd494642020-05-01 07:42:23 -0700144 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700145 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
146 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
147 {
148 "message": "A String", # [Output Only] A human-readable description of the warning code.
149 "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.
150 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
151 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
152 {
153 "value": "A String", # [Output Only] A warning data value corresponding to the key.
154 "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).
155 },
156 ],
157 },
158 ],
159 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
Dan O'Mearadd494642020-05-01 07:42:23 -0700160 "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700161 "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 -0700162 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
163 "name": "A String", # [Output Only] Name of the operation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700164 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
165 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
166 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
167 {
168 "message": "A String", # [Output Only] An optional, human-readable error message.
169 "code": "A String", # [Output Only] The error type identifier for this error.
170 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
171 },
172 ],
173 },
174 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
175 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
176 "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.
177 }</pre>
178</div>
179
180<div class="method">
181 <code class="details" id="get">get(project, region, healthCheck)</code>
182 <pre>Returns the specified HealthCheck resource. Gets a list of available health checks by making a list() request.
183
184Args:
185 project: string, Project ID for this request. (required)
186 region: string, Name of the region scoping this request. (required)
187 healthCheck: string, Name of the HealthCheck resource to return. (required)
188
189Returns:
190 An object of the form:
191
Dan O'Mearadd494642020-05-01 07:42:23 -0700192 { # Represents a Health Check resource.
193 #
194 # Google Compute Engine has two Health Check resources:
195 #
196 # * [Global](/compute/docs/reference/rest/{$api_version}/healthChecks) * [Regional](/compute/docs/reference/rest/{$api_version}/regionHealthChecks)
197 #
198 # 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.
199 #
200 # To perform health checks on network load balancers, you must use either httpHealthChecks or httpsHealthChecks.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700201 "kind": "compute#healthCheck", # Type of the resource.
202 "udpHealthCheck": {
203 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
204 "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.
205 "port": 42, # The UDP port number for the health check request. Valid values are 1 through 65535.
206 "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.
207 },
208 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
209 "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 -0700210 "grpcHealthCheck": {
211 "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.
212 "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:
213 # - Empty service_name means the overall status of all services at the backend.
214 # - Non-empty service_name means the health of that gRPC service, as defined by the owner of the service.
215 # The grpc_service_name can only be ASCII.
216 "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.
217 "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values:
218 # USE_FIXED_PORT: The port number in port is used for health checking.
219 # USE_NAMED_PORT: The portName is used for health checking.
220 # 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.
221 #
222 #
223 # If not specified, gRPC health check follows behavior specified in port and portName fields.
224 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700225 "checkIntervalSec": 42, # How often (in seconds) to send a health check. The default value is 5 seconds.
226 "tcpHealthCheck": {
227 "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.
228 "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.
229 "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 -0700230 # USE_FIXED_PORT: The port number in port is used for health checking.
231 # USE_NAMED_PORT: The portName is used for health checking.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700232 # 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.
233 #
234 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700235 # If not specified, TCP health check follows behavior specified in port and portName fields.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700236 "port": 42, # The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535.
237 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
238 "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.
239 },
240 "httpHealthCheck": {
241 "requestPath": "A String", # The request path of the HTTP health check request. The default value is /.
242 "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.
243 "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 -0700244 # USE_FIXED_PORT: The port number in port is used for health checking.
245 # USE_NAMED_PORT: The portName is used for health checking.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700246 # 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.
247 #
248 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700249 # If not specified, HTTP health check follows behavior specified in port and portName fields.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700250 "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.
251 "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.
252 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
253 "port": 42, # The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535.
254 },
255 "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 -0700256 "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.
257 },
258 "httpsHealthCheck": {
259 "requestPath": "A String", # The request path of the HTTPS health check request. The default value is /.
260 "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.
261 "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 -0700262 # USE_FIXED_PORT: The port number in port is used for health checking.
263 # USE_NAMED_PORT: The portName is used for health checking.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700264 # 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.
265 #
266 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700267 # If not specified, HTTPS health check follows behavior specified in port and portName fields.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700268 "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.
269 "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.
270 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
271 "port": 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.
272 },
273 "healthyThreshold": 42, # A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.
274 "sslHealthCheck": {
275 "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.
276 "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.
277 "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 -0700278 # USE_FIXED_PORT: The port number in port is used for health checking.
279 # USE_NAMED_PORT: The portName is used for health checking.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700280 # 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.
281 #
282 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700283 # If not specified, SSL health check follows behavior specified in port and portName fields.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700284 "port": 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.
285 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
286 "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.
287 },
288 "http2HealthCheck": {
289 "requestPath": "A String", # The request path of the HTTP/2 health check request. The default value is /.
290 "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.
291 "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 -0700292 # USE_FIXED_PORT: The port number in port is used for health checking.
293 # USE_NAMED_PORT: The portName is used for health checking.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700294 # 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.
295 #
296 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700297 # If not specified, HTTP2 health check follows behavior specified in port and portName fields.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700298 "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.
299 "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.
300 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
301 "port": 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.
302 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700303 "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 -0700304 "region": "A String", # [Output Only] Region where the health check resides. Not applicable to global health checks.
305 "unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
306 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
307 "creationTimestamp": "A String", # [Output Only] Creation timestamp in 3339 text format.
308 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
309 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
310 "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.
311 }</pre>
312</div>
313
314<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700315 <code class="details" id="insert">insert(project, region, body=None, requestId=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700316 <pre>Creates a HealthCheck resource in the specified project using the data included in the request.
317
318Args:
319 project: string, Project ID for this request. (required)
320 region: string, Name of the region scoping this request. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700321 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700322 The object takes the form of:
323
Dan O'Mearadd494642020-05-01 07:42:23 -0700324{ # Represents a Health Check resource.
325 #
326 # Google Compute Engine has two Health Check resources:
327 #
328 # * [Global](/compute/docs/reference/rest/{$api_version}/healthChecks) * [Regional](/compute/docs/reference/rest/{$api_version}/regionHealthChecks)
329 #
330 # 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.
331 #
332 # To perform health checks on network load balancers, you must use either httpHealthChecks or httpsHealthChecks.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700333 "kind": "compute#healthCheck", # Type of the resource.
334 "udpHealthCheck": {
335 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
336 "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.
337 "port": 42, # The UDP port number for the health check request. Valid values are 1 through 65535.
338 "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.
339 },
340 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
341 "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 -0700342 "grpcHealthCheck": {
343 "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.
344 "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:
345 # - Empty service_name means the overall status of all services at the backend.
346 # - Non-empty service_name means the health of that gRPC service, as defined by the owner of the service.
347 # The grpc_service_name can only be ASCII.
348 "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.
349 "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values:
350 # USE_FIXED_PORT: The port number in port is used for health checking.
351 # USE_NAMED_PORT: The portName is used for health checking.
352 # 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.
353 #
354 #
355 # If not specified, gRPC health check follows behavior specified in port and portName fields.
356 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700357 "checkIntervalSec": 42, # How often (in seconds) to send a health check. The default value is 5 seconds.
358 "tcpHealthCheck": {
359 "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.
360 "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.
361 "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 -0700362 # USE_FIXED_PORT: The port number in port is used for health checking.
363 # USE_NAMED_PORT: The portName is used for health checking.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700364 # 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.
365 #
366 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700367 # If not specified, TCP health check follows behavior specified in port and portName fields.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700368 "port": 42, # The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535.
369 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
370 "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.
371 },
372 "httpHealthCheck": {
373 "requestPath": "A String", # The request path of the HTTP health check request. The default value is /.
374 "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.
375 "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 -0700376 # USE_FIXED_PORT: The port number in port is used for health checking.
377 # USE_NAMED_PORT: The portName is used for health checking.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700378 # 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.
379 #
380 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700381 # If not specified, HTTP health check follows behavior specified in port and portName fields.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700382 "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.
383 "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.
384 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
385 "port": 42, # The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535.
386 },
387 "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 -0700388 "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.
389 },
390 "httpsHealthCheck": {
391 "requestPath": "A String", # The request path of the HTTPS health check request. The default value is /.
392 "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.
393 "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 -0700394 # USE_FIXED_PORT: The port number in port is used for health checking.
395 # USE_NAMED_PORT: The portName is used for health checking.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700396 # 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.
397 #
398 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700399 # If not specified, HTTPS health check follows behavior specified in port and portName fields.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700400 "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.
401 "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.
402 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
403 "port": 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.
404 },
405 "healthyThreshold": 42, # A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.
406 "sslHealthCheck": {
407 "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.
408 "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.
409 "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 -0700410 # USE_FIXED_PORT: The port number in port is used for health checking.
411 # USE_NAMED_PORT: The portName is used for health checking.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700412 # USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking.
413 #
414 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700415 # If not specified, SSL health check follows behavior specified in port and portName fields.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700416 "port": 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.
417 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
418 "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.
419 },
420 "http2HealthCheck": {
421 "requestPath": "A String", # The request path of the HTTP/2 health check request. The default value is /.
422 "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.
423 "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 -0700424 # USE_FIXED_PORT: The port number in port is used for health checking.
425 # USE_NAMED_PORT: The portName is used for health checking.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700426 # 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.
427 #
428 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700429 # If not specified, HTTP2 health check follows behavior specified in port and portName fields.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700430 "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.
431 "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.
432 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
433 "port": 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.
434 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700435 "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 -0700436 "region": "A String", # [Output Only] Region where the health check resides. Not applicable to global health checks.
437 "unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
438 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
439 "creationTimestamp": "A String", # [Output Only] Creation timestamp in 3339 text format.
440 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
441 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
442 "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.
443 }
444
445 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.
446
447For 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.
448
449The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
450
451Returns:
452 An object of the form:
453
454 { # Represents an Operation resource.
455 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700456 # Google Compute Engine has three Operation resources:
457 #
458 # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
459 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700460 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
461 #
462 # Operations can be global, regional or zonal.
Dan O'Mearadd494642020-05-01 07:42:23 -0700463 # - For global operations, use the `globalOperations` resource.
464 # - For regional operations, use the `regionOperations` resource.
465 # - For zonal operations, use the `zonalOperations` resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700466 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700467 # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700468 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
469 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
470 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Dan O'Mearadd494642020-05-01 07:42:23 -0700471 "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 -0700472 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
473 "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 -0700474 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
475 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700476 "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 -0700477 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700478 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Dan O'Mearadd494642020-05-01 07:42:23 -0700479 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700480 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
481 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
482 {
483 "message": "A String", # [Output Only] A human-readable description of the warning code.
484 "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.
485 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
486 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
487 {
488 "value": "A String", # [Output Only] A warning data value corresponding to the key.
489 "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).
490 },
491 ],
492 },
493 ],
494 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
Dan O'Mearadd494642020-05-01 07:42:23 -0700495 "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700496 "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 -0700497 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
498 "name": "A String", # [Output Only] Name of the operation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700499 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
500 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
501 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
502 {
503 "message": "A String", # [Output Only] An optional, human-readable error message.
504 "code": "A String", # [Output Only] The error type identifier for this error.
505 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
506 },
507 ],
508 },
509 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
510 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
511 "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.
512 }</pre>
513</div>
514
515<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700516 <code class="details" id="list">list(project, region, orderBy=None, maxResults=None, pageToken=None, returnPartialSuccess=None, filter=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700517 <pre>Retrieves the list of HealthCheck resources available to the specified project.
518
519Args:
520 project: string, Project ID for this request. (required)
521 region: string, Name of the region scoping this request. (required)
522 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
523
Dan O'Mearadd494642020-05-01 07:42:23 -0700524You 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 -0700525
Dan O'Mearadd494642020-05-01 07:42:23 -0700526Currently, only sorting by `name` or `creationTimestamp desc` is supported.
527 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`)
528 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.
529 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.
530 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 -0700531
Dan O'Mearadd494642020-05-01 07:42:23 -0700532For 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 -0700533
Dan O'Mearadd494642020-05-01 07:42:23 -0700534You 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 -0700535
Dan O'Mearadd494642020-05-01 07:42:23 -0700536To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ```
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700537
538Returns:
539 An object of the form:
540
541 { # Contains a list of HealthCheck resources.
542 "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.
543 "kind": "compute#healthCheckList", # Type of resource.
544 "items": [ # A list of HealthCheck resources.
Dan O'Mearadd494642020-05-01 07:42:23 -0700545 { # Represents a Health Check resource.
546 #
547 # Google Compute Engine has two Health Check resources:
548 #
549 # * [Global](/compute/docs/reference/rest/{$api_version}/healthChecks) * [Regional](/compute/docs/reference/rest/{$api_version}/regionHealthChecks)
550 #
551 # 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.
552 #
553 # To perform health checks on network load balancers, you must use either httpHealthChecks or httpsHealthChecks.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700554 "kind": "compute#healthCheck", # Type of the resource.
555 "udpHealthCheck": {
556 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
557 "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.
558 "port": 42, # The UDP port number for the health check request. Valid values are 1 through 65535.
559 "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.
560 },
561 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
562 "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 -0700563 "grpcHealthCheck": {
564 "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.
565 "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:
566 # - Empty service_name means the overall status of all services at the backend.
567 # - Non-empty service_name means the health of that gRPC service, as defined by the owner of the service.
568 # The grpc_service_name can only be ASCII.
569 "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.
570 "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values:
571 # USE_FIXED_PORT: The port number in port is used for health checking.
572 # USE_NAMED_PORT: The portName is used for health checking.
573 # 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.
574 #
575 #
576 # If not specified, gRPC health check follows behavior specified in port and portName fields.
577 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700578 "checkIntervalSec": 42, # How often (in seconds) to send a health check. The default value is 5 seconds.
579 "tcpHealthCheck": {
580 "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.
581 "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.
582 "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 -0700583 # USE_FIXED_PORT: The port number in port is used for health checking.
584 # USE_NAMED_PORT: The portName is used for health checking.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700585 # 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.
586 #
587 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700588 # If not specified, TCP health check follows behavior specified in port and portName fields.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700589 "port": 42, # The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535.
590 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
591 "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.
592 },
593 "httpHealthCheck": {
594 "requestPath": "A String", # The request path of the HTTP health check request. The default value is /.
595 "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.
596 "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 -0700597 # USE_FIXED_PORT: The port number in port is used for health checking.
598 # USE_NAMED_PORT: The portName is used for health checking.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700599 # 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.
600 #
601 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700602 # If not specified, HTTP health check follows behavior specified in port and portName fields.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700603 "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.
604 "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.
605 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
606 "port": 42, # The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535.
607 },
608 "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 -0700609 "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.
610 },
611 "httpsHealthCheck": {
612 "requestPath": "A String", # The request path of the HTTPS health check request. The default value is /.
613 "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.
614 "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 -0700615 # USE_FIXED_PORT: The port number in port is used for health checking.
616 # USE_NAMED_PORT: The portName is used for health checking.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700617 # 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.
618 #
619 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700620 # If not specified, HTTPS health check follows behavior specified in port and portName fields.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700621 "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.
622 "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.
623 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
624 "port": 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.
625 },
626 "healthyThreshold": 42, # A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.
627 "sslHealthCheck": {
628 "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.
629 "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.
630 "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 -0700631 # USE_FIXED_PORT: The port number in port is used for health checking.
632 # USE_NAMED_PORT: The portName is used for health checking.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700633 # 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.
634 #
635 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700636 # If not specified, SSL health check follows behavior specified in port and portName fields.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700637 "port": 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.
638 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
639 "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.
640 },
641 "http2HealthCheck": {
642 "requestPath": "A String", # The request path of the HTTP/2 health check request. The default value is /.
643 "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.
644 "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 -0700645 # USE_FIXED_PORT: The port number in port is used for health checking.
646 # USE_NAMED_PORT: The portName is used for health checking.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700647 # 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.
648 #
649 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700650 # If not specified, HTTP2 health check follows behavior specified in port and portName fields.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700651 "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.
652 "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.
653 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
654 "port": 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.
655 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700656 "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 -0700657 "region": "A String", # [Output Only] Region where the health check resides. Not applicable to global health checks.
658 "unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
659 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
660 "creationTimestamp": "A String", # [Output Only] Creation timestamp in 3339 text format.
661 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
662 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
663 "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.
664 },
665 ],
666 "warning": { # [Output Only] Informational warning message.
667 "message": "A String", # [Output Only] A human-readable description of the warning code.
668 "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.
669 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
670 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
671 {
672 "value": "A String", # [Output Only] A warning data value corresponding to the key.
673 "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).
674 },
675 ],
676 },
677 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
678 "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
679 }</pre>
680</div>
681
682<div class="method">
683 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
684 <pre>Retrieves the next page of results.
685
686Args:
687 previous_request: The request for the previous page. (required)
688 previous_response: The response from the request for the previous page. (required)
689
690Returns:
691 A request object that you can call 'execute()' on to request the next
692 page. Returns None if there are no more items in the collection.
693 </pre>
694</div>
695
696<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700697 <code class="details" id="patch">patch(project, region, healthCheck, body=None, requestId=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700698 <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.
699
700Args:
701 project: string, Project ID for this request. (required)
702 region: string, Name of the region scoping this request. (required)
703 healthCheck: string, Name of the HealthCheck resource to patch. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700704 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700705 The object takes the form of:
706
Dan O'Mearadd494642020-05-01 07:42:23 -0700707{ # Represents a Health Check resource.
708 #
709 # Google Compute Engine has two Health Check resources:
710 #
711 # * [Global](/compute/docs/reference/rest/{$api_version}/healthChecks) * [Regional](/compute/docs/reference/rest/{$api_version}/regionHealthChecks)
712 #
713 # 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.
714 #
715 # To perform health checks on network load balancers, you must use either httpHealthChecks or httpsHealthChecks.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700716 "kind": "compute#healthCheck", # Type of the resource.
717 "udpHealthCheck": {
718 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
719 "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.
720 "port": 42, # The UDP port number for the health check request. Valid values are 1 through 65535.
721 "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.
722 },
723 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
724 "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 -0700725 "grpcHealthCheck": {
726 "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.
727 "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:
728 # - Empty service_name means the overall status of all services at the backend.
729 # - Non-empty service_name means the health of that gRPC service, as defined by the owner of the service.
730 # The grpc_service_name can only be ASCII.
731 "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.
732 "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values:
733 # USE_FIXED_PORT: The port number in port is used for health checking.
734 # USE_NAMED_PORT: The portName is used for health checking.
735 # 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.
736 #
737 #
738 # If not specified, gRPC health check follows behavior specified in port and portName fields.
739 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700740 "checkIntervalSec": 42, # How often (in seconds) to send a health check. The default value is 5 seconds.
741 "tcpHealthCheck": {
742 "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.
743 "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.
744 "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 -0700745 # USE_FIXED_PORT: The port number in port is used for health checking.
746 # USE_NAMED_PORT: The portName is used for health checking.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700747 # 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.
748 #
749 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700750 # If not specified, TCP health check follows behavior specified in port and portName fields.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700751 "port": 42, # The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535.
752 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
753 "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.
754 },
755 "httpHealthCheck": {
756 "requestPath": "A String", # The request path of the HTTP health check request. The default value is /.
757 "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.
758 "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 -0700759 # USE_FIXED_PORT: The port number in port is used for health checking.
760 # USE_NAMED_PORT: The portName is used for health checking.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700761 # 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.
762 #
763 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700764 # If not specified, HTTP health check follows behavior specified in port and portName fields.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700765 "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.
766 "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.
767 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
768 "port": 42, # The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535.
769 },
770 "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 -0700771 "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.
772 },
773 "httpsHealthCheck": {
774 "requestPath": "A String", # The request path of the HTTPS health check request. The default value is /.
775 "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.
776 "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 -0700777 # USE_FIXED_PORT: The port number in port is used for health checking.
778 # USE_NAMED_PORT: The portName is used for health checking.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700779 # 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.
780 #
781 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700782 # If not specified, HTTPS health check follows behavior specified in port and portName fields.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700783 "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.
784 "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.
785 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
786 "port": 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.
787 },
788 "healthyThreshold": 42, # A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.
789 "sslHealthCheck": {
790 "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.
791 "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.
792 "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 -0700793 # USE_FIXED_PORT: The port number in port is used for health checking.
794 # USE_NAMED_PORT: The portName is used for health checking.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700795 # 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.
796 #
797 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700798 # If not specified, SSL health check follows behavior specified in port and portName fields.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700799 "port": 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.
800 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
801 "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.
802 },
803 "http2HealthCheck": {
804 "requestPath": "A String", # The request path of the HTTP/2 health check request. The default value is /.
805 "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.
806 "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 -0700807 # USE_FIXED_PORT: The port number in port is used for health checking.
808 # USE_NAMED_PORT: The portName is used for health checking.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700809 # 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.
810 #
811 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700812 # If not specified, HTTP2 health check follows behavior specified in port and portName fields.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700813 "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.
814 "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.
815 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
816 "port": 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.
817 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700818 "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 -0700819 "region": "A String", # [Output Only] Region where the health check resides. Not applicable to global health checks.
820 "unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
821 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
822 "creationTimestamp": "A String", # [Output Only] Creation timestamp in 3339 text format.
823 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
824 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
825 "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.
826 }
827
828 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.
829
830For 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.
831
832The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
833
834Returns:
835 An object of the form:
836
837 { # Represents an Operation resource.
838 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700839 # Google Compute Engine has three Operation resources:
840 #
841 # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
842 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700843 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
844 #
845 # Operations can be global, regional or zonal.
Dan O'Mearadd494642020-05-01 07:42:23 -0700846 # - For global operations, use the `globalOperations` resource.
847 # - For regional operations, use the `regionOperations` resource.
848 # - For zonal operations, use the `zonalOperations` resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700849 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700850 # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700851 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
852 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
853 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Dan O'Mearadd494642020-05-01 07:42:23 -0700854 "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 -0700855 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
856 "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 -0700857 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
858 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700859 "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 -0700860 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700861 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Dan O'Mearadd494642020-05-01 07:42:23 -0700862 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700863 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
864 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
865 {
866 "message": "A String", # [Output Only] A human-readable description of the warning code.
867 "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.
868 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
869 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
870 {
871 "value": "A String", # [Output Only] A warning data value corresponding to the key.
872 "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).
873 },
874 ],
875 },
876 ],
877 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
Dan O'Mearadd494642020-05-01 07:42:23 -0700878 "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700879 "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 -0700880 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
881 "name": "A String", # [Output Only] Name of the operation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700882 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
883 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
884 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
885 {
886 "message": "A String", # [Output Only] An optional, human-readable error message.
887 "code": "A String", # [Output Only] The error type identifier for this error.
888 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
889 },
890 ],
891 },
892 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
893 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
894 "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.
895 }</pre>
896</div>
897
898<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700899 <code class="details" id="testIamPermissions">testIamPermissions(project, region, resource, body=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700900 <pre>Returns permissions that a caller has on the specified resource.
901
902Args:
903 project: string, Project ID for this request. (required)
904 region: string, The name of the region for this request. (required)
905 resource: string, Name or id of the resource for this request. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700906 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700907 The object takes the form of:
908
909{
910 "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
911 "A String",
912 ],
913 }
914
915
916Returns:
917 An object of the form:
918
919 {
920 "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
921 "A String",
922 ],
923 }</pre>
924</div>
925
926<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700927 <code class="details" id="update">update(project, region, healthCheck, body=None, requestId=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700928 <pre>Updates a HealthCheck resource in the specified project using the data included in the request.
929
930Args:
931 project: string, Project ID for this request. (required)
932 region: string, Name of the region scoping this request. (required)
933 healthCheck: string, Name of the HealthCheck resource to update. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700934 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700935 The object takes the form of:
936
Dan O'Mearadd494642020-05-01 07:42:23 -0700937{ # Represents a Health Check resource.
938 #
939 # Google Compute Engine has two Health Check resources:
940 #
941 # * [Global](/compute/docs/reference/rest/{$api_version}/healthChecks) * [Regional](/compute/docs/reference/rest/{$api_version}/regionHealthChecks)
942 #
943 # 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.
944 #
945 # To perform health checks on network load balancers, you must use either httpHealthChecks or httpsHealthChecks.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700946 "kind": "compute#healthCheck", # Type of the resource.
947 "udpHealthCheck": {
948 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
949 "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.
950 "port": 42, # The UDP port number for the health check request. Valid values are 1 through 65535.
951 "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.
952 },
953 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
954 "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 -0700955 "grpcHealthCheck": {
956 "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.
957 "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:
958 # - Empty service_name means the overall status of all services at the backend.
959 # - Non-empty service_name means the health of that gRPC service, as defined by the owner of the service.
960 # The grpc_service_name can only be ASCII.
961 "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.
962 "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values:
963 # USE_FIXED_PORT: The port number in port is used for health checking.
964 # USE_NAMED_PORT: The portName is used for health checking.
965 # 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.
966 #
967 #
968 # If not specified, gRPC health check follows behavior specified in port and portName fields.
969 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700970 "checkIntervalSec": 42, # How often (in seconds) to send a health check. The default value is 5 seconds.
971 "tcpHealthCheck": {
972 "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.
973 "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.
974 "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 -0700975 # USE_FIXED_PORT: The port number in port is used for health checking.
976 # USE_NAMED_PORT: The portName is used for health checking.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700977 # 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.
978 #
979 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700980 # If not specified, TCP health check follows behavior specified in port and portName fields.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700981 "port": 42, # The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535.
982 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
983 "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.
984 },
985 "httpHealthCheck": {
986 "requestPath": "A String", # The request path of the HTTP health check request. The default value is /.
987 "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.
988 "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 -0700989 # USE_FIXED_PORT: The port number in port is used for health checking.
990 # USE_NAMED_PORT: The portName is used for health checking.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700991 # 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.
992 #
993 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700994 # If not specified, HTTP health check follows behavior specified in port and portName fields.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700995 "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.
996 "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.
997 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
998 "port": 42, # The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535.
999 },
1000 "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 -07001001 "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.
1002 },
1003 "httpsHealthCheck": {
1004 "requestPath": "A String", # The request path of the HTTPS 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.
1006 "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, HTTPS 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.
1014 "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.
1015 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
1016 "port": 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.
1017 },
1018 "healthyThreshold": 42, # A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.
1019 "sslHealthCheck": {
1020 "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.
1021 "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.
1022 "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 -07001023 # USE_FIXED_PORT: The port number in port is used for health checking.
1024 # USE_NAMED_PORT: The portName is used for health checking.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001025 # 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.
1026 #
1027 #
Dan O'Mearadd494642020-05-01 07:42:23 -07001028 # If not specified, SSL health check follows behavior specified in port and portName fields.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001029 "port": 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.
1030 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
1031 "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.
1032 },
1033 "http2HealthCheck": {
1034 "requestPath": "A String", # The request path of the HTTP/2 health check request. The default value is /.
1035 "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.
1036 "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 -07001037 # USE_FIXED_PORT: The port number in port is used for health checking.
1038 # USE_NAMED_PORT: The portName is used for health checking.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001039 # 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.
1040 #
1041 #
Dan O'Mearadd494642020-05-01 07:42:23 -07001042 # If not specified, HTTP2 health check follows behavior specified in port and portName fields.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001043 "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.
1044 "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.
1045 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
1046 "port": 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.
1047 },
Dan O'Mearadd494642020-05-01 07:42:23 -07001048 "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 -07001049 "region": "A String", # [Output Only] Region where the health check resides. Not applicable to global health checks.
1050 "unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
1051 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
1052 "creationTimestamp": "A String", # [Output Only] Creation timestamp in 3339 text format.
1053 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
1054 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
1055 "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.
1056 }
1057
1058 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.
1059
1060For 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.
1061
1062The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
1063
1064Returns:
1065 An object of the form:
1066
1067 { # Represents an Operation resource.
1068 #
Dan O'Mearadd494642020-05-01 07:42:23 -07001069 # Google Compute Engine has three Operation resources:
1070 #
1071 # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
1072 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001073 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
1074 #
1075 # Operations can be global, regional or zonal.
Dan O'Mearadd494642020-05-01 07:42:23 -07001076 # - For global operations, use the `globalOperations` resource.
1077 # - For regional operations, use the `regionOperations` resource.
1078 # - For zonal operations, use the `zonalOperations` resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001079 #
Dan O'Mearadd494642020-05-01 07:42:23 -07001080 # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001081 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
1082 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
1083 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Dan O'Mearadd494642020-05-01 07:42:23 -07001084 "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 -07001085 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
1086 "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 -07001087 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
1088 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001089 "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 -07001090 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001091 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Dan O'Mearadd494642020-05-01 07:42:23 -07001092 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001093 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
1094 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
1095 {
1096 "message": "A String", # [Output Only] A human-readable description of the warning code.
1097 "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.
1098 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
1099 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
1100 {
1101 "value": "A String", # [Output Only] A warning data value corresponding to the key.
1102 "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).
1103 },
1104 ],
1105 },
1106 ],
1107 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
Dan O'Mearadd494642020-05-01 07:42:23 -07001108 "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001109 "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 -07001110 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
1111 "name": "A String", # [Output Only] Name of the operation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001112 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
1113 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
1114 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
1115 {
1116 "message": "A String", # [Output Only] An optional, human-readable error message.
1117 "code": "A String", # [Output Only] The error type identifier for this error.
1118 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
1119 },
1120 ],
1121 },
1122 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
1123 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
1124 "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.
1125 }</pre>
1126</div>
1127
1128</body></html>