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