1<html><body> 2<style> 3 4body, h1, h2, h3, div, span, p, pre, a { 5 margin: 0; 6 padding: 0; 7 border: 0; 8 font-weight: inherit; 9 font-style: inherit; 10 font-size: 100%; 11 font-family: inherit; 12 vertical-align: baseline; 13} 14 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, h2, h3 { 50 border-bottom: solid #CCC 1px; 51} 52 53.toc_element { 54 margin-top: 0.5em; 55} 56 57.firstline { 58 margin-left: 2 em; 59} 60 61.method { 62 margin-top: 1em; 63 border: solid 1px #CCC; 64 padding: 1em; 65 background: #EEE; 66} 67 68.details { 69 font-weight: bold; 70 font-size: 14px; 71} 72 73</style> 74 75<h1><a href="compute_v1.html">Compute Engine API</a> . <a href="compute_v1.healthChecks.html">healthChecks</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#delete">delete(project, 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, 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"> 84 <code><a href="#insert">insert(project, body, requestId=None)</a></code></p> 85<p class="firstline">Creates a HealthCheck resource in the specified project using the data included in the request.</p> 86<p class="toc_element"> 87 <code><a href="#list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p> 88<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"> 93 <code><a href="#patch">patch(project, healthCheck, body, requestId=None)</a></code></p> 94<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"> 96 <code><a href="#update">update(project, healthCheck, body, requestId=None)</a></code></p> 97<p class="firstline">Updates a HealthCheck resource in the specified project using the data included in the request.</p> 98<h3>Method Details</h3> 99<div class="method"> 100 <code class="details" id="delete">delete(project, healthCheck, requestId=None)</code> 101 <pre>Deletes the specified HealthCheck resource. 102 103Args: 104 project: string, Project ID for this request. (required) 105 healthCheck: string, Name of the HealthCheck resource to delete. (required) 106 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. 107 108For 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. 109 110The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). 111 112Returns: 113 An object of the form: 114 115 { # Represents an Operation resource. 116 # 117 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. 118 # 119 # Operations can be global, regional or zonal. 120 # - For global operations, use the globalOperations resource. 121 # - For regional operations, use the regionOperations resource. 122 # - For zonal operations, use the zonalOperations resource. 123 # 124 # For more information, read Global, Regional, and Zonal Resources. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==) 125 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 126 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 127 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 128 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 129 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 130 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 131 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 132 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 133 "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. 134 "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. 135 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 136 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 137 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 138 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 139 { 140 "message": "A String", # [Output Only] A human-readable description of the warning code. 141 "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. 142 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 143 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 144 { 145 "value": "A String", # [Output Only] A warning data value corresponding to the key. 146 "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). 147 }, 148 ], 149 }, 150 ], 151 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. 152 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 153 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 154 "name": "A String", # [Output Only] Name of the resource. 155 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 156 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 157 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 158 { 159 "message": "A String", # [Output Only] An optional, human-readable error message. 160 "code": "A String", # [Output Only] The error type identifier for this error. 161 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 162 }, 163 ], 164 }, 165 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 166 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 167 "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. 168 }</pre> 169</div> 170 171<div class="method"> 172 <code class="details" id="get">get(project, healthCheck)</code> 173 <pre>Returns the specified HealthCheck resource. Gets a list of available health checks by making a list() request. 174 175Args: 176 project: string, Project ID for this request. (required) 177 healthCheck: string, Name of the HealthCheck resource to return. (required) 178 179Returns: 180 An object of the form: 181 182 { # An HealthCheck resource. This resource defines a template for how individual virtual machines should be checked for health, via one of the supported protocols. 183 "kind": "compute#healthCheck", # Type of the resource. 184 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 185 "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. 186 "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. 187 "checkIntervalSec": 42, # How often (in seconds) to send a health check. The default value is 5 seconds. 188 "tcpHealthCheck": { 189 "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. 190 "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. 191 "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values: 192 # USE_FIXED_PORT: The port number in 193 # port 194 # is used for health checking. 195 # USE_NAMED_PORT: The 196 # portName 197 # is used for health checking. 198 # 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. 199 # 200 # 201 # If not specified, TCP health check follows behavior specified in 202 # port 203 # and 204 # portName 205 # fields. 206 "port": 42, # The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535. 207 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. 208 "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. 209 }, 210 "httpHealthCheck": { 211 "requestPath": "A String", # The request path of the HTTP health check request. The default value is /. 212 "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. 213 "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values: 214 # USE_FIXED_PORT: The port number in 215 # port 216 # is used for health checking. 217 # USE_NAMED_PORT: The 218 # portName 219 # 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, HTTP health check follows behavior specified in 224 # port 225 # and 226 # portName 227 # fields. 228 "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. 229 "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. 230 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. 231 "port": 42, # The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535. 232 }, 233 "httpsHealthCheck": { 234 "requestPath": "A String", # The request path of the HTTPS health check request. The default value is /. 235 "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. 236 "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values: 237 # USE_FIXED_PORT: The port number in 238 # port 239 # is used for health checking. 240 # USE_NAMED_PORT: The 241 # portName 242 # is used for health checking. 243 # 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. 244 # 245 # 246 # If not specified, HTTPS health check follows behavior specified in 247 # port 248 # and 249 # portName 250 # fields. 251 "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. 252 "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. 253 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. 254 "port": 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535. 255 }, 256 "healthyThreshold": 42, # A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2. 257 "http2HealthCheck": { 258 "requestPath": "A String", # The request path of the HTTP/2 health check request. The default value is /. 259 "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. 260 "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values: 261 # USE_FIXED_PORT: The port number in 262 # port 263 # is used for health checking. 264 # USE_NAMED_PORT: The 265 # portName 266 # is used for health checking. 267 # 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. 268 # 269 # 270 # If not specified, HTTP2 health check follows behavior specified in 271 # port 272 # and 273 # portName 274 # fields. 275 "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. 276 "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. 277 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. 278 "port": 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535. 279 }, 280 "unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2. 281 "sslHealthCheck": { 282 "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. 283 "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. 284 "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values: 285 # USE_FIXED_PORT: The port number in 286 # port 287 # is used for health checking. 288 # USE_NAMED_PORT: The 289 # portName 290 # is used for health checking. 291 # 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. 292 # 293 # 294 # If not specified, SSL health check follows behavior specified in 295 # port 296 # and 297 # portName 298 # fields. 299 "port": 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535. 300 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. 301 "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. 302 }, 303 "creationTimestamp": "A String", # [Output Only] Creation timestamp in 3339 text format. 304 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 305 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 306 "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. 307 }</pre> 308</div> 309 310<div class="method"> 311 <code class="details" id="insert">insert(project, body, requestId=None)</code> 312 <pre>Creates a HealthCheck resource in the specified project using the data included in the request. 313 314Args: 315 project: string, Project ID for this request. (required) 316 body: object, The request body. (required) 317 The object takes the form of: 318 319{ # An HealthCheck resource. This resource defines a template for how individual virtual machines should be checked for health, via one of the supported protocols. 320 "kind": "compute#healthCheck", # Type of the resource. 321 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 322 "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. 323 "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. 324 "checkIntervalSec": 42, # How often (in seconds) to send a health check. The default value is 5 seconds. 325 "tcpHealthCheck": { 326 "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. 327 "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. 328 "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values: 329 # USE_FIXED_PORT: The port number in 330 # port 331 # is used for health checking. 332 # USE_NAMED_PORT: The 333 # portName 334 # is used for health checking. 335 # 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. 336 # 337 # 338 # If not specified, TCP health check follows behavior specified in 339 # port 340 # and 341 # portName 342 # fields. 343 "port": 42, # The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535. 344 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. 345 "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. 346 }, 347 "httpHealthCheck": { 348 "requestPath": "A String", # The request path of the HTTP health check request. The default value is /. 349 "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. 350 "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values: 351 # USE_FIXED_PORT: The port number in 352 # port 353 # is used for health checking. 354 # USE_NAMED_PORT: The 355 # portName 356 # is used for health checking. 357 # 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. 358 # 359 # 360 # If not specified, HTTP health check follows behavior specified in 361 # port 362 # and 363 # portName 364 # fields. 365 "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. 366 "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. 367 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. 368 "port": 42, # The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535. 369 }, 370 "httpsHealthCheck": { 371 "requestPath": "A String", # The request path of the HTTPS health check request. The default value is /. 372 "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. 373 "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values: 374 # USE_FIXED_PORT: The port number in 375 # port 376 # is used for health checking. 377 # USE_NAMED_PORT: The 378 # portName 379 # is used for health checking. 380 # 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. 381 # 382 # 383 # If not specified, HTTPS health check follows behavior specified in 384 # port 385 # and 386 # portName 387 # fields. 388 "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. 389 "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. 390 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. 391 "port": 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535. 392 }, 393 "healthyThreshold": 42, # A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2. 394 "http2HealthCheck": { 395 "requestPath": "A String", # The request path of the HTTP/2 health check request. The default value is /. 396 "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. 397 "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values: 398 # USE_FIXED_PORT: The port number in 399 # port 400 # is used for health checking. 401 # USE_NAMED_PORT: The 402 # portName 403 # is used for health checking. 404 # 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. 405 # 406 # 407 # If not specified, HTTP2 health check follows behavior specified in 408 # port 409 # and 410 # portName 411 # fields. 412 "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. 413 "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. 414 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. 415 "port": 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535. 416 }, 417 "unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2. 418 "sslHealthCheck": { 419 "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. 420 "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. 421 "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values: 422 # USE_FIXED_PORT: The port number in 423 # port 424 # is used for health checking. 425 # USE_NAMED_PORT: The 426 # portName 427 # is used for health checking. 428 # 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. 429 # 430 # 431 # If not specified, SSL health check follows behavior specified in 432 # port 433 # and 434 # portName 435 # fields. 436 "port": 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535. 437 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. 438 "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. 439 }, 440 "creationTimestamp": "A String", # [Output Only] Creation timestamp in 3339 text format. 441 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 442 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 443 "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. 444 } 445 446 requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. 447 448For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. 449 450The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). 451 452Returns: 453 An object of the form: 454 455 { # Represents an Operation resource. 456 # 457 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. 458 # 459 # Operations can be global, regional or zonal. 460 # - For global operations, use the globalOperations resource. 461 # - For regional operations, use the regionOperations resource. 462 # - For zonal operations, use the zonalOperations resource. 463 # 464 # For more information, read Global, Regional, and Zonal Resources. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==) 465 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 466 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 467 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 468 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 469 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 470 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 471 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 472 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 473 "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. 474 "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. 475 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 476 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 477 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 478 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 479 { 480 "message": "A String", # [Output Only] A human-readable description of the warning code. 481 "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. 482 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 483 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 484 { 485 "value": "A String", # [Output Only] A warning data value corresponding to the key. 486 "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). 487 }, 488 ], 489 }, 490 ], 491 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. 492 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 493 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 494 "name": "A String", # [Output Only] Name of the resource. 495 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 496 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 497 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 498 { 499 "message": "A String", # [Output Only] An optional, human-readable error message. 500 "code": "A String", # [Output Only] The error type identifier for this error. 501 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 502 }, 503 ], 504 }, 505 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 506 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 507 "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. 508 }</pre> 509</div> 510 511<div class="method"> 512 <code class="details" id="list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code> 513 <pre>Retrieves the list of HealthCheck resources available to the specified project. 514 515Args: 516 project: string, Project ID for this request. (required) 517 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. 518 519You 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. 520 521Currently, only sorting by name or creationTimestamp desc is supported. 522 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) 523 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. 524 filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. 525 526For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. 527 528You 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. 529 530To 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). 531 532Returns: 533 An object of the form: 534 535 { # Contains a list of HealthCheck resources. 536 "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. 537 "kind": "compute#healthCheckList", # Type of resource. 538 "items": [ # A list of HealthCheck resources. 539 { # An HealthCheck resource. This resource defines a template for how individual virtual machines should be checked for health, via one of the supported protocols. 540 "kind": "compute#healthCheck", # Type of the resource. 541 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 542 "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. 543 "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. 544 "checkIntervalSec": 42, # How often (in seconds) to send a health check. The default value is 5 seconds. 545 "tcpHealthCheck": { 546 "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. 547 "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. 548 "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values: 549 # USE_FIXED_PORT: The port number in 550 # port 551 # is used for health checking. 552 # USE_NAMED_PORT: The 553 # portName 554 # is used for health checking. 555 # 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. 556 # 557 # 558 # If not specified, TCP health check follows behavior specified in 559 # port 560 # and 561 # portName 562 # fields. 563 "port": 42, # The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535. 564 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. 565 "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. 566 }, 567 "httpHealthCheck": { 568 "requestPath": "A String", # The request path of the HTTP health check request. The default value is /. 569 "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. 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 572 # port 573 # is used for health checking. 574 # USE_NAMED_PORT: The 575 # portName 576 # is used for health checking. 577 # 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. 578 # 579 # 580 # If not specified, HTTP health check follows behavior specified in 581 # port 582 # and 583 # portName 584 # fields. 585 "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. 586 "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. 587 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. 588 "port": 42, # The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535. 589 }, 590 "httpsHealthCheck": { 591 "requestPath": "A String", # The request path of the HTTPS health check request. The default value is /. 592 "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. 593 "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values: 594 # USE_FIXED_PORT: The port number in 595 # port 596 # is used for health checking. 597 # USE_NAMED_PORT: The 598 # portName 599 # is used for health checking. 600 # 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. 601 # 602 # 603 # If not specified, HTTPS health check follows behavior specified in 604 # port 605 # and 606 # portName 607 # fields. 608 "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. 609 "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. 610 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. 611 "port": 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535. 612 }, 613 "healthyThreshold": 42, # A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2. 614 "http2HealthCheck": { 615 "requestPath": "A String", # The request path of the HTTP/2 health check request. The default value is /. 616 "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. 617 "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values: 618 # USE_FIXED_PORT: The port number in 619 # port 620 # is used for health checking. 621 # USE_NAMED_PORT: The 622 # portName 623 # is used for health checking. 624 # 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. 625 # 626 # 627 # If not specified, HTTP2 health check follows behavior specified in 628 # port 629 # and 630 # portName 631 # fields. 632 "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. 633 "host": "A String", # The value of the host header in the HTTP/2 health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used. 634 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. 635 "port": 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535. 636 }, 637 "unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2. 638 "sslHealthCheck": { 639 "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. 640 "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. 641 "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values: 642 # USE_FIXED_PORT: The port number in 643 # port 644 # is used for health checking. 645 # USE_NAMED_PORT: The 646 # portName 647 # is used for health checking. 648 # 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. 649 # 650 # 651 # If not specified, SSL health check follows behavior specified in 652 # port 653 # and 654 # portName 655 # fields. 656 "port": 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535. 657 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. 658 "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. 659 }, 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"> 697 <code class="details" id="patch">patch(project, healthCheck, body, requestId=None)</code> 698 <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 healthCheck: string, Name of the HealthCheck resource to patch. (required) 703 body: object, The request body. (required) 704 The object takes the form of: 705 706{ # An HealthCheck resource. This resource defines a template for how individual virtual machines should be checked for health, via one of the supported protocols. 707 "kind": "compute#healthCheck", # Type of the resource. 708 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 709 "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. 710 "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. 711 "checkIntervalSec": 42, # How often (in seconds) to send a health check. The default value is 5 seconds. 712 "tcpHealthCheck": { 713 "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. 714 "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. 715 "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values: 716 # USE_FIXED_PORT: The port number in 717 # port 718 # is used for health checking. 719 # USE_NAMED_PORT: The 720 # portName 721 # is used for health checking. 722 # USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking. 723 # 724 # 725 # If not specified, TCP health check follows behavior specified in 726 # port 727 # and 728 # portName 729 # fields. 730 "port": 42, # The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535. 731 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. 732 "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. 733 }, 734 "httpHealthCheck": { 735 "requestPath": "A String", # The request path of the HTTP health check request. The default value is /. 736 "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. 737 "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values: 738 # USE_FIXED_PORT: The port number in 739 # port 740 # is used for health checking. 741 # USE_NAMED_PORT: The 742 # portName 743 # is used for health checking. 744 # USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking. 745 # 746 # 747 # If not specified, HTTP health check follows behavior specified in 748 # port 749 # and 750 # portName 751 # fields. 752 "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. 753 "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. 754 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. 755 "port": 42, # The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535. 756 }, 757 "httpsHealthCheck": { 758 "requestPath": "A String", # The request path of the HTTPS health check request. The default value is /. 759 "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. 760 "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values: 761 # USE_FIXED_PORT: The port number in 762 # port 763 # is used for health checking. 764 # USE_NAMED_PORT: The 765 # portName 766 # is used for health checking. 767 # 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. 768 # 769 # 770 # If not specified, HTTPS health check follows behavior specified in 771 # port 772 # and 773 # portName 774 # fields. 775 "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. 776 "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. 777 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. 778 "port": 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535. 779 }, 780 "healthyThreshold": 42, # A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2. 781 "http2HealthCheck": { 782 "requestPath": "A String", # The request path of the HTTP/2 health check request. The default value is /. 783 "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. 784 "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values: 785 # USE_FIXED_PORT: The port number in 786 # port 787 # is used for health checking. 788 # USE_NAMED_PORT: The 789 # portName 790 # is used for health checking. 791 # 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. 792 # 793 # 794 # If not specified, HTTP2 health check follows behavior specified in 795 # port 796 # and 797 # portName 798 # fields. 799 "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. 800 "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. 801 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. 802 "port": 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535. 803 }, 804 "unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2. 805 "sslHealthCheck": { 806 "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. 807 "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. 808 "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values: 809 # USE_FIXED_PORT: The port number in 810 # port 811 # is used for health checking. 812 # USE_NAMED_PORT: The 813 # portName 814 # is used for health checking. 815 # 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. 816 # 817 # 818 # If not specified, SSL health check follows behavior specified in 819 # port 820 # and 821 # portName 822 # fields. 823 "port": 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535. 824 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. 825 "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. 826 }, 827 "creationTimestamp": "A String", # [Output Only] Creation timestamp in 3339 text format. 828 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 829 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 830 "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. 831 } 832 833 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. 834 835For 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. 836 837The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). 838 839Returns: 840 An object of the form: 841 842 { # Represents an Operation resource. 843 # 844 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. 845 # 846 # Operations can be global, regional or zonal. 847 # - For global operations, use the globalOperations resource. 848 # - For regional operations, use the regionOperations resource. 849 # - For zonal operations, use the zonalOperations resource. 850 # 851 # For more information, read Global, Regional, and Zonal Resources. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==) 852 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 853 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 854 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 855 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 856 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 857 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 858 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 859 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 860 "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. 861 "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. 862 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 863 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 864 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 865 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 866 { 867 "message": "A String", # [Output Only] A human-readable description of the warning code. 868 "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. 869 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 870 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 871 { 872 "value": "A String", # [Output Only] A warning data value corresponding to the key. 873 "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). 874 }, 875 ], 876 }, 877 ], 878 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. 879 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 880 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 881 "name": "A String", # [Output Only] Name of the resource. 882 "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"> 899 <code class="details" id="update">update(project, healthCheck, body, requestId=None)</code> 900 <pre>Updates a HealthCheck resource in the specified project using the data included in the request. 901 902Args: 903 project: string, Project ID for this request. (required) 904 healthCheck: string, Name of the HealthCheck resource to update. (required) 905 body: object, The request body. (required) 906 The object takes the form of: 907 908{ # An HealthCheck resource. This resource defines a template for how individual virtual machines should be checked for health, via one of the supported protocols. 909 "kind": "compute#healthCheck", # Type of the resource. 910 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 911 "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. 912 "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. 913 "checkIntervalSec": 42, # How often (in seconds) to send a health check. The default value is 5 seconds. 914 "tcpHealthCheck": { 915 "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. 916 "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. 917 "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values: 918 # USE_FIXED_PORT: The port number in 919 # port 920 # is used for health checking. 921 # USE_NAMED_PORT: The 922 # portName 923 # is used for health checking. 924 # 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. 925 # 926 # 927 # If not specified, TCP health check follows behavior specified in 928 # port 929 # and 930 # portName 931 # fields. 932 "port": 42, # The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535. 933 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. 934 "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. 935 }, 936 "httpHealthCheck": { 937 "requestPath": "A String", # The request path of the HTTP health check request. The default value is /. 938 "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. 939 "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values: 940 # USE_FIXED_PORT: The port number in 941 # port 942 # is used for health checking. 943 # USE_NAMED_PORT: The 944 # portName 945 # is used for health checking. 946 # 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. 947 # 948 # 949 # If not specified, HTTP health check follows behavior specified in 950 # port 951 # and 952 # portName 953 # fields. 954 "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. 955 "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. 956 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. 957 "port": 42, # The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535. 958 }, 959 "httpsHealthCheck": { 960 "requestPath": "A String", # The request path of the HTTPS health check request. The default value is /. 961 "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. 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 964 # port 965 # is used for health checking. 966 # USE_NAMED_PORT: The 967 # portName 968 # is used for health checking. 969 # 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. 970 # 971 # 972 # If not specified, HTTPS health check follows behavior specified in 973 # port 974 # and 975 # portName 976 # fields. 977 "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. 978 "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. 979 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. 980 "port": 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535. 981 }, 982 "healthyThreshold": 42, # A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2. 983 "http2HealthCheck": { 984 "requestPath": "A String", # The request path of the HTTP/2 health check request. The default value is /. 985 "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. 986 "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values: 987 # USE_FIXED_PORT: The port number in 988 # port 989 # is used for health checking. 990 # USE_NAMED_PORT: The 991 # portName 992 # is used for health checking. 993 # 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. 994 # 995 # 996 # If not specified, HTTP2 health check follows behavior specified in 997 # port 998 # and 999 # portName 1000 # fields. 1001 "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. 1002 "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. 1003 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. 1004 "port": 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535. 1005 }, 1006 "unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2. 1007 "sslHealthCheck": { 1008 "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. 1009 "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. 1010 "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values: 1011 # USE_FIXED_PORT: The port number in 1012 # port 1013 # is used for health checking. 1014 # USE_NAMED_PORT: The 1015 # portName 1016 # is used for health checking. 1017 # 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. 1018 # 1019 # 1020 # If not specified, SSL health check follows behavior specified in 1021 # port 1022 # and 1023 # portName 1024 # fields. 1025 "port": 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535. 1026 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. 1027 "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. 1028 }, 1029 "creationTimestamp": "A String", # [Output Only] Creation timestamp in 3339 text format. 1030 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 1031 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 1032 "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. 1033 } 1034 1035 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. 1036 1037For 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. 1038 1039The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). 1040 1041Returns: 1042 An object of the form: 1043 1044 { # Represents an Operation resource. 1045 # 1046 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. 1047 # 1048 # Operations can be global, regional or zonal. 1049 # - For global operations, use the globalOperations resource. 1050 # - For regional operations, use the regionOperations resource. 1051 # - For zonal operations, use the zonalOperations resource. 1052 # 1053 # For more information, read Global, Regional, and Zonal Resources. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==) 1054 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 1055 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 1056 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 1057 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 1058 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 1059 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 1060 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 1061 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 1062 "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. 1063 "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. 1064 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 1065 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 1066 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 1067 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 1068 { 1069 "message": "A String", # [Output Only] A human-readable description of the warning code. 1070 "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. 1071 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 1072 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 1073 { 1074 "value": "A String", # [Output Only] A warning data value corresponding to the key. 1075 "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). 1076 }, 1077 ], 1078 }, 1079 ], 1080 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. 1081 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 1082 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 1083 "name": "A String", # [Output Only] Name of the resource. 1084 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 1085 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 1086 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 1087 { 1088 "message": "A String", # [Output Only] An optional, human-readable error message. 1089 "code": "A String", # [Output Only] The error type identifier for this error. 1090 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 1091 }, 1092 ], 1093 }, 1094 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 1095 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 1096 "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. 1097 }</pre> 1098</div> 1099 1100</body></html>