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_alpha.html">Compute Engine API</a> . <a href="compute_alpha.healthChecks.html">healthChecks</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p> 79<p class="firstline">Retrieves the list of all HealthCheck resources, regional and global, available to the specified project.</p> 80<p class="toc_element"> 81 <code><a href="#aggregatedList_next">aggregatedList_next(previous_request, previous_response)</a></code></p> 82<p class="firstline">Retrieves the next page of results.</p> 83<p class="toc_element"> 84 <code><a href="#delete">delete(project, healthCheck, requestId=None)</a></code></p> 85<p class="firstline">Deletes the specified HealthCheck resource.</p> 86<p class="toc_element"> 87 <code><a href="#get">get(project, healthCheck)</a></code></p> 88<p class="firstline">Returns the specified HealthCheck resource. Gets a list of available health checks by making a list() request.</p> 89<p class="toc_element"> 90 <code><a href="#insert">insert(project, body, requestId=None)</a></code></p> 91<p class="firstline">Creates a HealthCheck resource in the specified project using the data included in the request.</p> 92<p class="toc_element"> 93 <code><a href="#list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p> 94<p class="firstline">Retrieves the list of HealthCheck resources available to the specified project.</p> 95<p class="toc_element"> 96 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 97<p class="firstline">Retrieves the next page of results.</p> 98<p class="toc_element"> 99 <code><a href="#patch">patch(project, healthCheck, body, requestId=None)</a></code></p> 100<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> 101<p class="toc_element"> 102 <code><a href="#testIamPermissions">testIamPermissions(project, resource, body)</a></code></p> 103<p class="firstline">Returns permissions that a caller has on the specified resource.</p> 104<p class="toc_element"> 105 <code><a href="#update">update(project, healthCheck, body, requestId=None)</a></code></p> 106<p class="firstline">Updates a HealthCheck resource in the specified project using the data included in the request.</p> 107<h3>Method Details</h3> 108<div class="method"> 109 <code class="details" id="aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code> 110 <pre>Retrieves the list of all HealthCheck resources, regional and global, available to the specified project. 111 112Args: 113 project: string, Name of the project scoping this request. (required) 114 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. 115 116You 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. 117 118Currently, only sorting by name or creationTimestamp desc is supported. 119 maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) 120 pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. 121 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 <. 122 123For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. 124 125You 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. 126 127To 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). 128 129Returns: 130 An object of the form: 131 132 { 133 "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. 134 "kind": "compute#healthChecksAggregatedList", # Type of resource. 135 "items": { # A list of HealthChecksScopedList resources. 136 "a_key": { # Name of the scope containing this set of HealthChecks. 137 "healthChecks": [ # A list of HealthChecks contained in this scope. 138 { # An HealthCheck resource. This resource defines a template for how individual virtual machines should be checked for health, via one of the supported protocols. 139 "kind": "compute#healthCheck", # Type of the resource. 140 "udpHealthCheck": { 141 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. 142 "request": "A String", # Raw data of request to send in payload of UDP packet. It is an error if this is empty. The request data can only be ASCII. 143 "port": 42, # The UDP port number for the health check request. Valid values are 1 through 65535. 144 "response": "A String", # The bytes to match against the beginning of the response data. It is an error if this is empty. The response data can only be ASCII. 145 }, 146 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 147 "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. 148 "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. 149 "checkIntervalSec": 42, # How often (in seconds) to send a health check. The default value is 5 seconds. 150 "tcpHealthCheck": { 151 "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. 152 "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. 153 "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values: 154 # USE_FIXED_PORT: The port number in 155 # port 156 # is used for health checking. 157 # USE_NAMED_PORT: The 158 # portName 159 # is used for health checking. 160 # 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. 161 # 162 # 163 # If not specified, TCP health check follows behavior specified in 164 # port 165 # and 166 # portName 167 # fields. 168 "port": 42, # The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535. 169 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. 170 "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. 171 }, 172 "httpHealthCheck": { 173 "requestPath": "A String", # The request path of the HTTP health check request. The default value is /. 174 "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. 175 "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values: 176 # USE_FIXED_PORT: The port number in 177 # port 178 # is used for health checking. 179 # USE_NAMED_PORT: The 180 # portName 181 # is used for health checking. 182 # 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. 183 # 184 # 185 # If not specified, HTTP health check follows behavior specified in 186 # port 187 # and 188 # portName 189 # fields. 190 "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. 191 "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. 192 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. 193 "port": 42, # The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535. 194 }, 195 "logConfig": { # Configuration of logging on a health check. If logging is enabled, logs will be exported to Stackdriver. # Configure logging on this health check. 196 "filter": "A String", # Specifies the desired filtering of logs on this health check. If this is unspecified and enable is true, logs are exported with LOG_TRANSITION filter. 197 "enable": True or False, # Indicates whether or not to export logs. This is false by default, which means no health check logging will be done. 198 }, 199 "httpsHealthCheck": { 200 "requestPath": "A String", # The request path of the HTTPS health check request. The default value is /. 201 "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. 202 "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values: 203 # USE_FIXED_PORT: The port number in 204 # port 205 # is used for health checking. 206 # USE_NAMED_PORT: The 207 # portName 208 # is used for health checking. 209 # 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. 210 # 211 # 212 # If not specified, HTTPS health check follows behavior specified in 213 # port 214 # and 215 # portName 216 # fields. 217 "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. 218 "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. 219 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. 220 "port": 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535. 221 }, 222 "healthyThreshold": 42, # A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2. 223 "sslHealthCheck": { 224 "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. 225 "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. 226 "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values: 227 # USE_FIXED_PORT: The port number in 228 # port 229 # is used for health checking. 230 # USE_NAMED_PORT: The 231 # portName 232 # is used for health checking. 233 # 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. 234 # 235 # 236 # If not specified, SSL health check follows behavior specified in 237 # port 238 # and 239 # portName 240 # fields. 241 "port": 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535. 242 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. 243 "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. 244 }, 245 "http2HealthCheck": { 246 "requestPath": "A String", # The request path of the HTTP/2 health check request. The default value is /. 247 "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. 248 "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values: 249 # USE_FIXED_PORT: The port number in 250 # port 251 # is used for health checking. 252 # USE_NAMED_PORT: The 253 # portName 254 # is used for health checking. 255 # 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. 256 # 257 # 258 # If not specified, HTTP2 health check follows behavior specified in 259 # port 260 # and 261 # portName 262 # fields. 263 "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. 264 "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. 265 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. 266 "port": 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535. 267 }, 268 "region": "A String", # [Output Only] Region where the health check resides. Not applicable to global health checks. 269 "unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2. 270 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 271 "creationTimestamp": "A String", # [Output Only] Creation timestamp in 3339 text format. 272 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 273 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 274 "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. 275 }, 276 ], 277 "warning": { # Informational warning which replaces the list of backend services when the list is empty. 278 "message": "A String", # [Output Only] A human-readable description of the warning code. 279 "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. 280 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 281 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 282 { 283 "value": "A String", # [Output Only] A warning data value corresponding to the key. 284 "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). 285 }, 286 ], 287 }, 288 }, 289 }, 290 "warning": { # [Output Only] Informational warning message. 291 "message": "A String", # [Output Only] A human-readable description of the warning code. 292 "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. 293 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 294 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 295 { 296 "value": "A String", # [Output Only] A warning data value corresponding to the key. 297 "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). 298 }, 299 ], 300 }, 301 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. 302 "selfLink": "A String", # [Output Only] Server-defined URL for this resource. 303 }</pre> 304</div> 305 306<div class="method"> 307 <code class="details" id="aggregatedList_next">aggregatedList_next(previous_request, previous_response)</code> 308 <pre>Retrieves the next page of results. 309 310Args: 311 previous_request: The request for the previous page. (required) 312 previous_response: The response from the request for the previous page. (required) 313 314Returns: 315 A request object that you can call 'execute()' on to request the next 316 page. Returns None if there are no more items in the collection. 317 </pre> 318</div> 319 320<div class="method"> 321 <code class="details" id="delete">delete(project, healthCheck, requestId=None)</code> 322 <pre>Deletes the specified HealthCheck resource. 323 324Args: 325 project: string, Project ID for this request. (required) 326 healthCheck: string, Name of the HealthCheck resource to delete. (required) 327 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. 328 329For 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. 330 331The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). 332 333Returns: 334 An object of the form: 335 336 { # Represents an Operation resource. 337 # 338 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. 339 # 340 # Operations can be global, regional or zonal. 341 # - For global operations, use the globalOperations resource. 342 # - For regional operations, use the regionOperations resource. 343 # - For zonal operations, use the zonalOperations resource. 344 # 345 # 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 ==) 346 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 347 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 348 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 349 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 350 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 351 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 352 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 353 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 354 "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. 355 "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. 356 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 357 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 358 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 359 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 360 { 361 "message": "A String", # [Output Only] A human-readable description of the warning code. 362 "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. 363 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 364 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 365 { 366 "value": "A String", # [Output Only] A warning data value corresponding to the key. 367 "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). 368 }, 369 ], 370 }, 371 ], 372 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 373 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. 374 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 375 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 376 "name": "A String", # [Output Only] Name of the resource. 377 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 378 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 379 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 380 { 381 "message": "A String", # [Output Only] An optional, human-readable error message. 382 "code": "A String", # [Output Only] The error type identifier for this error. 383 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 384 }, 385 ], 386 }, 387 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 388 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 389 "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. 390 }</pre> 391</div> 392 393<div class="method"> 394 <code class="details" id="get">get(project, healthCheck)</code> 395 <pre>Returns the specified HealthCheck resource. Gets a list of available health checks by making a list() request. 396 397Args: 398 project: string, Project ID for this request. (required) 399 healthCheck: string, Name of the HealthCheck resource to return. (required) 400 401Returns: 402 An object of the form: 403 404 { # An HealthCheck resource. This resource defines a template for how individual virtual machines should be checked for health, via one of the supported protocols. 405 "kind": "compute#healthCheck", # Type of the resource. 406 "udpHealthCheck": { 407 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. 408 "request": "A String", # Raw data of request to send in payload of UDP packet. It is an error if this is empty. The request data can only be ASCII. 409 "port": 42, # The UDP port number for the health check request. Valid values are 1 through 65535. 410 "response": "A String", # The bytes to match against the beginning of the response data. It is an error if this is empty. The response data can only be ASCII. 411 }, 412 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 413 "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. 414 "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. 415 "checkIntervalSec": 42, # How often (in seconds) to send a health check. The default value is 5 seconds. 416 "tcpHealthCheck": { 417 "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. 418 "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. 419 "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values: 420 # USE_FIXED_PORT: The port number in 421 # port 422 # is used for health checking. 423 # USE_NAMED_PORT: The 424 # portName 425 # is used for health checking. 426 # USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking. 427 # 428 # 429 # If not specified, TCP health check follows behavior specified in 430 # port 431 # and 432 # portName 433 # fields. 434 "port": 42, # The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535. 435 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. 436 "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. 437 }, 438 "httpHealthCheck": { 439 "requestPath": "A String", # The request path of the HTTP health check request. The default value is /. 440 "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. 441 "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values: 442 # USE_FIXED_PORT: The port number in 443 # port 444 # is used for health checking. 445 # USE_NAMED_PORT: The 446 # portName 447 # is used for health checking. 448 # 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. 449 # 450 # 451 # If not specified, HTTP health check follows behavior specified in 452 # port 453 # and 454 # portName 455 # fields. 456 "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. 457 "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. 458 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. 459 "port": 42, # The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535. 460 }, 461 "logConfig": { # Configuration of logging on a health check. If logging is enabled, logs will be exported to Stackdriver. # Configure logging on this health check. 462 "filter": "A String", # Specifies the desired filtering of logs on this health check. If this is unspecified and enable is true, logs are exported with LOG_TRANSITION filter. 463 "enable": True or False, # Indicates whether or not to export logs. This is false by default, which means no health check logging will be done. 464 }, 465 "httpsHealthCheck": { 466 "requestPath": "A String", # The request path of the HTTPS health check request. The default value is /. 467 "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. 468 "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values: 469 # USE_FIXED_PORT: The port number in 470 # port 471 # is used for health checking. 472 # USE_NAMED_PORT: The 473 # portName 474 # is used for health checking. 475 # 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. 476 # 477 # 478 # If not specified, HTTPS health check follows behavior specified in 479 # port 480 # and 481 # portName 482 # fields. 483 "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. 484 "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. 485 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. 486 "port": 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535. 487 }, 488 "healthyThreshold": 42, # A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2. 489 "sslHealthCheck": { 490 "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. 491 "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. 492 "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values: 493 # USE_FIXED_PORT: The port number in 494 # port 495 # is used for health checking. 496 # USE_NAMED_PORT: The 497 # portName 498 # is used for health checking. 499 # 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. 500 # 501 # 502 # If not specified, SSL health check follows behavior specified in 503 # port 504 # and 505 # portName 506 # fields. 507 "port": 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535. 508 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. 509 "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. 510 }, 511 "http2HealthCheck": { 512 "requestPath": "A String", # The request path of the HTTP/2 health check request. The default value is /. 513 "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. 514 "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values: 515 # USE_FIXED_PORT: The port number in 516 # port 517 # is used for health checking. 518 # USE_NAMED_PORT: The 519 # portName 520 # is used for health checking. 521 # 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. 522 # 523 # 524 # If not specified, HTTP2 health check follows behavior specified in 525 # port 526 # and 527 # portName 528 # fields. 529 "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. 530 "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. 531 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. 532 "port": 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535. 533 }, 534 "region": "A String", # [Output Only] Region where the health check resides. Not applicable to global health checks. 535 "unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2. 536 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 537 "creationTimestamp": "A String", # [Output Only] Creation timestamp in 3339 text format. 538 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 539 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 540 "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. 541 }</pre> 542</div> 543 544<div class="method"> 545 <code class="details" id="insert">insert(project, body, requestId=None)</code> 546 <pre>Creates a HealthCheck resource in the specified project using the data included in the request. 547 548Args: 549 project: string, Project ID for this request. (required) 550 body: object, The request body. (required) 551 The object takes the form of: 552 553{ # An HealthCheck resource. This resource defines a template for how individual virtual machines should be checked for health, via one of the supported protocols. 554 "kind": "compute#healthCheck", # Type of the resource. 555 "udpHealthCheck": { 556 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. 557 "request": "A String", # Raw data of request to send in payload of UDP packet. It is an error if this is empty. The request data can only be ASCII. 558 "port": 42, # The UDP port number for the health check request. Valid values are 1 through 65535. 559 "response": "A String", # The bytes to match against the beginning of the response data. It is an error if this is empty. The response data can only be ASCII. 560 }, 561 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 562 "timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec. 563 "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. 564 "checkIntervalSec": 42, # How often (in seconds) to send a health check. The default value is 5 seconds. 565 "tcpHealthCheck": { 566 "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. 567 "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. 568 "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values: 569 # USE_FIXED_PORT: The port number in 570 # port 571 # is used for health checking. 572 # USE_NAMED_PORT: The 573 # portName 574 # is used for health checking. 575 # 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. 576 # 577 # 578 # If not specified, TCP health check follows behavior specified in 579 # port 580 # and 581 # portName 582 # fields. 583 "port": 42, # The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535. 584 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. 585 "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. 586 }, 587 "httpHealthCheck": { 588 "requestPath": "A String", # The request path of the HTTP health check request. The default value is /. 589 "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. 590 "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values: 591 # USE_FIXED_PORT: The port number in 592 # port 593 # is used for health checking. 594 # USE_NAMED_PORT: The 595 # portName 596 # is used for health checking. 597 # 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. 598 # 599 # 600 # If not specified, HTTP health check follows behavior specified in 601 # port 602 # and 603 # portName 604 # fields. 605 "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. 606 "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. 607 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. 608 "port": 42, # The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535. 609 }, 610 "logConfig": { # Configuration of logging on a health check. If logging is enabled, logs will be exported to Stackdriver. # Configure logging on this health check. 611 "filter": "A String", # Specifies the desired filtering of logs on this health check. If this is unspecified and enable is true, logs are exported with LOG_TRANSITION filter. 612 "enable": True or False, # Indicates whether or not to export logs. This is false by default, which means no health check logging will be done. 613 }, 614 "httpsHealthCheck": { 615 "requestPath": "A String", # The request path of the HTTPS 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, HTTPS 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 HTTPS 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 "healthyThreshold": 42, # A so-far unhealthy instance will be marked healthy after this many consecutive successes. 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 "http2HealthCheck": { 661 "requestPath": "A String", # The request path of the HTTP/2 health check request. The default value is /. 662 "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. 663 "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values: 664 # USE_FIXED_PORT: The port number in 665 # port 666 # is used for health checking. 667 # USE_NAMED_PORT: The 668 # portName 669 # is used for health checking. 670 # 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. 671 # 672 # 673 # If not specified, HTTP2 health check follows behavior specified in 674 # port 675 # and 676 # portName 677 # fields. 678 "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. 679 "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. 680 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. 681 "port": 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535. 682 }, 683 "region": "A String", # [Output Only] Region where the health check resides. Not applicable to global health checks. 684 "unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2. 685 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 686 "creationTimestamp": "A String", # [Output Only] Creation timestamp in 3339 text format. 687 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 688 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 689 "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. 690 } 691 692 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. 693 694For 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. 695 696The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). 697 698Returns: 699 An object of the form: 700 701 { # Represents an Operation resource. 702 # 703 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. 704 # 705 # Operations can be global, regional or zonal. 706 # - For global operations, use the globalOperations resource. 707 # - For regional operations, use the regionOperations resource. 708 # - For zonal operations, use the zonalOperations resource. 709 # 710 # 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 ==) 711 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 712 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 713 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 714 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 715 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 716 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 717 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 718 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 719 "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. 720 "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. 721 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 722 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 723 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 724 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 725 { 726 "message": "A String", # [Output Only] A human-readable description of the warning code. 727 "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. 728 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 729 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 730 { 731 "value": "A String", # [Output Only] A warning data value corresponding to the key. 732 "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). 733 }, 734 ], 735 }, 736 ], 737 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 738 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. 739 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 740 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 741 "name": "A String", # [Output Only] Name of the resource. 742 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 743 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 744 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 745 { 746 "message": "A String", # [Output Only] An optional, human-readable error message. 747 "code": "A String", # [Output Only] The error type identifier for this error. 748 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 749 }, 750 ], 751 }, 752 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 753 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 754 "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. 755 }</pre> 756</div> 757 758<div class="method"> 759 <code class="details" id="list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code> 760 <pre>Retrieves the list of HealthCheck resources available to the specified project. 761 762Args: 763 project: string, Project ID for this request. (required) 764 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. 765 766You 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. 767 768Currently, only sorting by name or creationTimestamp desc is supported. 769 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) 770 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. 771 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 <. 772 773For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. 774 775You 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. 776 777To 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). 778 779Returns: 780 An object of the form: 781 782 { # Contains a list of HealthCheck resources. 783 "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. 784 "kind": "compute#healthCheckList", # Type of resource. 785 "items": [ # A list of HealthCheck resources. 786 { # An HealthCheck resource. This resource defines a template for how individual virtual machines should be checked for health, via one of the supported protocols. 787 "kind": "compute#healthCheck", # Type of the resource. 788 "udpHealthCheck": { 789 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. 790 "request": "A String", # Raw data of request to send in payload of UDP packet. It is an error if this is empty. The request data can only be ASCII. 791 "port": 42, # The UDP port number for the health check request. Valid values are 1 through 65535. 792 "response": "A String", # The bytes to match against the beginning of the response data. It is an error if this is empty. The response data can only be ASCII. 793 }, 794 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 795 "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. 796 "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. 797 "checkIntervalSec": 42, # How often (in seconds) to send a health check. The default value is 5 seconds. 798 "tcpHealthCheck": { 799 "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. 800 "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. 801 "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values: 802 # USE_FIXED_PORT: The port number in 803 # port 804 # is used for health checking. 805 # USE_NAMED_PORT: The 806 # portName 807 # is used for health checking. 808 # 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. 809 # 810 # 811 # If not specified, TCP health check follows behavior specified in 812 # port 813 # and 814 # portName 815 # fields. 816 "port": 42, # The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535. 817 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. 818 "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. 819 }, 820 "httpHealthCheck": { 821 "requestPath": "A String", # The request path of the HTTP health check request. The default value is /. 822 "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. 823 "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values: 824 # USE_FIXED_PORT: The port number in 825 # port 826 # is used for health checking. 827 # USE_NAMED_PORT: The 828 # portName 829 # is used for health checking. 830 # 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. 831 # 832 # 833 # If not specified, HTTP health check follows behavior specified in 834 # port 835 # and 836 # portName 837 # fields. 838 "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. 839 "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. 840 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. 841 "port": 42, # The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535. 842 }, 843 "logConfig": { # Configuration of logging on a health check. If logging is enabled, logs will be exported to Stackdriver. # Configure logging on this health check. 844 "filter": "A String", # Specifies the desired filtering of logs on this health check. If this is unspecified and enable is true, logs are exported with LOG_TRANSITION filter. 845 "enable": True or False, # Indicates whether or not to export logs. This is false by default, which means no health check logging will be done. 846 }, 847 "httpsHealthCheck": { 848 "requestPath": "A String", # The request path of the HTTPS health check request. The default value is /. 849 "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. 850 "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values: 851 # USE_FIXED_PORT: The port number in 852 # port 853 # is used for health checking. 854 # USE_NAMED_PORT: The 855 # portName 856 # is used for health checking. 857 # 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. 858 # 859 # 860 # If not specified, HTTPS health check follows behavior specified in 861 # port 862 # and 863 # portName 864 # fields. 865 "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. 866 "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. 867 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. 868 "port": 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535. 869 }, 870 "healthyThreshold": 42, # A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2. 871 "sslHealthCheck": { 872 "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. 873 "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. 874 "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values: 875 # USE_FIXED_PORT: The port number in 876 # port 877 # is used for health checking. 878 # USE_NAMED_PORT: The 879 # portName 880 # is used for health checking. 881 # 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. 882 # 883 # 884 # If not specified, SSL health check follows behavior specified in 885 # port 886 # and 887 # portName 888 # fields. 889 "port": 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535. 890 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. 891 "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. 892 }, 893 "http2HealthCheck": { 894 "requestPath": "A String", # The request path of the HTTP/2 health check request. The default value is /. 895 "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. 896 "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values: 897 # USE_FIXED_PORT: The port number in 898 # port 899 # is used for health checking. 900 # USE_NAMED_PORT: The 901 # portName 902 # is used for health checking. 903 # 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. 904 # 905 # 906 # If not specified, HTTP2 health check follows behavior specified in 907 # port 908 # and 909 # portName 910 # fields. 911 "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. 912 "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. 913 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. 914 "port": 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535. 915 }, 916 "region": "A String", # [Output Only] Region where the health check resides. Not applicable to global health checks. 917 "unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2. 918 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 919 "creationTimestamp": "A String", # [Output Only] Creation timestamp in 3339 text format. 920 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 921 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 922 "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. 923 }, 924 ], 925 "warning": { # [Output Only] Informational warning message. 926 "message": "A String", # [Output Only] A human-readable description of the warning code. 927 "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. 928 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 929 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 930 { 931 "value": "A String", # [Output Only] A warning data value corresponding to the key. 932 "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). 933 }, 934 ], 935 }, 936 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. 937 "selfLink": "A String", # [Output Only] Server-defined URL for this resource. 938 }</pre> 939</div> 940 941<div class="method"> 942 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 943 <pre>Retrieves the next page of results. 944 945Args: 946 previous_request: The request for the previous page. (required) 947 previous_response: The response from the request for the previous page. (required) 948 949Returns: 950 A request object that you can call 'execute()' on to request the next 951 page. Returns None if there are no more items in the collection. 952 </pre> 953</div> 954 955<div class="method"> 956 <code class="details" id="patch">patch(project, healthCheck, body, requestId=None)</code> 957 <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. 958 959Args: 960 project: string, Project ID for this request. (required) 961 healthCheck: string, Name of the HealthCheck resource to patch. (required) 962 body: object, The request body. (required) 963 The object takes the form of: 964 965{ # An HealthCheck resource. This resource defines a template for how individual virtual machines should be checked for health, via one of the supported protocols. 966 "kind": "compute#healthCheck", # Type of the resource. 967 "udpHealthCheck": { 968 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. 969 "request": "A String", # Raw data of request to send in payload of UDP packet. It is an error if this is empty. The request data can only be ASCII. 970 "port": 42, # The UDP port number for the health check request. Valid values are 1 through 65535. 971 "response": "A String", # The bytes to match against the beginning of the response data. It is an error if this is empty. The response data can only be ASCII. 972 }, 973 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 974 "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. 975 "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. 976 "checkIntervalSec": 42, # How often (in seconds) to send a health check. The default value is 5 seconds. 977 "tcpHealthCheck": { 978 "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. 979 "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. 980 "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values: 981 # USE_FIXED_PORT: The port number in 982 # port 983 # is used for health checking. 984 # USE_NAMED_PORT: The 985 # portName 986 # is used for health checking. 987 # 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. 988 # 989 # 990 # If not specified, TCP health check follows behavior specified in 991 # port 992 # and 993 # portName 994 # fields. 995 "port": 42, # The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535. 996 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. 997 "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. 998 }, 999 "httpHealthCheck": { 1000 "requestPath": "A String", # The request path of the HTTP health check request. The default value is /. 1001 "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. 1002 "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values: 1003 # USE_FIXED_PORT: The port number in 1004 # port 1005 # is used for health checking. 1006 # USE_NAMED_PORT: The 1007 # portName 1008 # is used for health checking. 1009 # USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking. 1010 # 1011 # 1012 # If not specified, HTTP health check follows behavior specified in 1013 # port 1014 # and 1015 # portName 1016 # fields. 1017 "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. 1018 "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. 1019 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. 1020 "port": 42, # The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535. 1021 }, 1022 "logConfig": { # Configuration of logging on a health check. If logging is enabled, logs will be exported to Stackdriver. # Configure logging on this health check. 1023 "filter": "A String", # Specifies the desired filtering of logs on this health check. If this is unspecified and enable is true, logs are exported with LOG_TRANSITION filter. 1024 "enable": True or False, # Indicates whether or not to export logs. This is false by default, which means no health check logging will be done. 1025 }, 1026 "httpsHealthCheck": { 1027 "requestPath": "A String", # The request path of the HTTPS health check request. The default value is /. 1028 "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. 1029 "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values: 1030 # USE_FIXED_PORT: The port number in 1031 # port 1032 # is used for health checking. 1033 # USE_NAMED_PORT: The 1034 # portName 1035 # is used for health checking. 1036 # 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. 1037 # 1038 # 1039 # If not specified, HTTPS health check follows behavior specified in 1040 # port 1041 # and 1042 # portName 1043 # fields. 1044 "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. 1045 "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. 1046 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. 1047 "port": 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535. 1048 }, 1049 "healthyThreshold": 42, # A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2. 1050 "sslHealthCheck": { 1051 "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. 1052 "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. 1053 "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values: 1054 # USE_FIXED_PORT: The port number in 1055 # port 1056 # is used for health checking. 1057 # USE_NAMED_PORT: The 1058 # portName 1059 # is used for health checking. 1060 # 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. 1061 # 1062 # 1063 # If not specified, SSL health check follows behavior specified in 1064 # port 1065 # and 1066 # portName 1067 # fields. 1068 "port": 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535. 1069 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. 1070 "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. 1071 }, 1072 "http2HealthCheck": { 1073 "requestPath": "A String", # The request path of the HTTP/2 health check request. The default value is /. 1074 "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. 1075 "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values: 1076 # USE_FIXED_PORT: The port number in 1077 # port 1078 # is used for health checking. 1079 # USE_NAMED_PORT: The 1080 # portName 1081 # is used for health checking. 1082 # 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. 1083 # 1084 # 1085 # If not specified, HTTP2 health check follows behavior specified in 1086 # port 1087 # and 1088 # portName 1089 # fields. 1090 "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. 1091 "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. 1092 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. 1093 "port": 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535. 1094 }, 1095 "region": "A String", # [Output Only] Region where the health check resides. Not applicable to global health checks. 1096 "unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2. 1097 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 1098 "creationTimestamp": "A String", # [Output Only] Creation timestamp in 3339 text format. 1099 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 1100 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 1101 "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. 1102 } 1103 1104 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. 1105 1106For 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. 1107 1108The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). 1109 1110Returns: 1111 An object of the form: 1112 1113 { # Represents an Operation resource. 1114 # 1115 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. 1116 # 1117 # Operations can be global, regional or zonal. 1118 # - For global operations, use the globalOperations resource. 1119 # - For regional operations, use the regionOperations resource. 1120 # - For zonal operations, use the zonalOperations resource. 1121 # 1122 # 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 ==) 1123 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 1124 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 1125 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 1126 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 1127 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 1128 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 1129 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 1130 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 1131 "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. 1132 "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. 1133 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 1134 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 1135 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 1136 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 1137 { 1138 "message": "A String", # [Output Only] A human-readable description of the warning code. 1139 "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. 1140 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 1141 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 1142 { 1143 "value": "A String", # [Output Only] A warning data value corresponding to the key. 1144 "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). 1145 }, 1146 ], 1147 }, 1148 ], 1149 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 1150 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. 1151 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 1152 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 1153 "name": "A String", # [Output Only] Name of the resource. 1154 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 1155 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 1156 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 1157 { 1158 "message": "A String", # [Output Only] An optional, human-readable error message. 1159 "code": "A String", # [Output Only] The error type identifier for this error. 1160 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 1161 }, 1162 ], 1163 }, 1164 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 1165 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 1166 "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. 1167 }</pre> 1168</div> 1169 1170<div class="method"> 1171 <code class="details" id="testIamPermissions">testIamPermissions(project, resource, body)</code> 1172 <pre>Returns permissions that a caller has on the specified resource. 1173 1174Args: 1175 project: string, Project ID for this request. (required) 1176 resource: string, Name or id of the resource for this request. (required) 1177 body: object, The request body. (required) 1178 The object takes the form of: 1179 1180{ 1181 "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. 1182 "A String", 1183 ], 1184 } 1185 1186 1187Returns: 1188 An object of the form: 1189 1190 { 1191 "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed. 1192 "A String", 1193 ], 1194 }</pre> 1195</div> 1196 1197<div class="method"> 1198 <code class="details" id="update">update(project, healthCheck, body, requestId=None)</code> 1199 <pre>Updates a HealthCheck resource in the specified project using the data included in the request. 1200 1201Args: 1202 project: string, Project ID for this request. (required) 1203 healthCheck: string, Name of the HealthCheck resource to update. (required) 1204 body: object, The request body. (required) 1205 The object takes the form of: 1206 1207{ # An HealthCheck resource. This resource defines a template for how individual virtual machines should be checked for health, via one of the supported protocols. 1208 "kind": "compute#healthCheck", # Type of the resource. 1209 "udpHealthCheck": { 1210 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. 1211 "request": "A String", # Raw data of request to send in payload of UDP packet. It is an error if this is empty. The request data can only be ASCII. 1212 "port": 42, # The UDP port number for the health check request. Valid values are 1 through 65535. 1213 "response": "A String", # The bytes to match against the beginning of the response data. It is an error if this is empty. The response data can only be ASCII. 1214 }, 1215 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 1216 "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. 1217 "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. 1218 "checkIntervalSec": 42, # How often (in seconds) to send a health check. The default value is 5 seconds. 1219 "tcpHealthCheck": { 1220 "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. 1221 "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. 1222 "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values: 1223 # USE_FIXED_PORT: The port number in 1224 # port 1225 # is used for health checking. 1226 # USE_NAMED_PORT: The 1227 # portName 1228 # is used for health checking. 1229 # 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. 1230 # 1231 # 1232 # If not specified, TCP health check follows behavior specified in 1233 # port 1234 # and 1235 # portName 1236 # fields. 1237 "port": 42, # The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535. 1238 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. 1239 "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. 1240 }, 1241 "httpHealthCheck": { 1242 "requestPath": "A String", # The request path of the HTTP health check request. The default value is /. 1243 "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. 1244 "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values: 1245 # USE_FIXED_PORT: The port number in 1246 # port 1247 # is used for health checking. 1248 # USE_NAMED_PORT: The 1249 # portName 1250 # is used for health checking. 1251 # 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. 1252 # 1253 # 1254 # If not specified, HTTP health check follows behavior specified in 1255 # port 1256 # and 1257 # portName 1258 # fields. 1259 "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. 1260 "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. 1261 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. 1262 "port": 42, # The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535. 1263 }, 1264 "logConfig": { # Configuration of logging on a health check. If logging is enabled, logs will be exported to Stackdriver. # Configure logging on this health check. 1265 "filter": "A String", # Specifies the desired filtering of logs on this health check. If this is unspecified and enable is true, logs are exported with LOG_TRANSITION filter. 1266 "enable": True or False, # Indicates whether or not to export logs. This is false by default, which means no health check logging will be done. 1267 }, 1268 "httpsHealthCheck": { 1269 "requestPath": "A String", # The request path of the HTTPS health check request. The default value is /. 1270 "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. 1271 "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values: 1272 # USE_FIXED_PORT: The port number in 1273 # port 1274 # is used for health checking. 1275 # USE_NAMED_PORT: The 1276 # portName 1277 # is used for health checking. 1278 # 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. 1279 # 1280 # 1281 # If not specified, HTTPS health check follows behavior specified in 1282 # port 1283 # and 1284 # portName 1285 # fields. 1286 "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. 1287 "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. 1288 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. 1289 "port": 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535. 1290 }, 1291 "healthyThreshold": 42, # A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2. 1292 "sslHealthCheck": { 1293 "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. 1294 "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. 1295 "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values: 1296 # USE_FIXED_PORT: The port number in 1297 # port 1298 # is used for health checking. 1299 # USE_NAMED_PORT: The 1300 # portName 1301 # is used for health checking. 1302 # 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. 1303 # 1304 # 1305 # If not specified, SSL health check follows behavior specified in 1306 # port 1307 # and 1308 # portName 1309 # fields. 1310 "port": 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535. 1311 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. 1312 "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. 1313 }, 1314 "http2HealthCheck": { 1315 "requestPath": "A String", # The request path of the HTTP/2 health check request. The default value is /. 1316 "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. 1317 "portSpecification": "A String", # Specifies how port is selected for health checking, can be one of following values: 1318 # USE_FIXED_PORT: The port number in 1319 # port 1320 # is used for health checking. 1321 # USE_NAMED_PORT: The 1322 # portName 1323 # is used for health checking. 1324 # 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. 1325 # 1326 # 1327 # If not specified, HTTP2 health check follows behavior specified in 1328 # port 1329 # and 1330 # portName 1331 # fields. 1332 "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. 1333 "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. 1334 "portName": "A String", # Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. 1335 "port": 42, # The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535. 1336 }, 1337 "region": "A String", # [Output Only] Region where the health check resides. Not applicable to global health checks. 1338 "unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2. 1339 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 1340 "creationTimestamp": "A String", # [Output Only] Creation timestamp in 3339 text format. 1341 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 1342 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 1343 "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. 1344 } 1345 1346 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. 1347 1348For 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. 1349 1350The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). 1351 1352Returns: 1353 An object of the form: 1354 1355 { # Represents an Operation resource. 1356 # 1357 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. 1358 # 1359 # Operations can be global, regional or zonal. 1360 # - For global operations, use the globalOperations resource. 1361 # - For regional operations, use the regionOperations resource. 1362 # - For zonal operations, use the zonalOperations resource. 1363 # 1364 # 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 ==) 1365 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 1366 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 1367 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 1368 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 1369 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 1370 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 1371 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 1372 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 1373 "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. 1374 "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. 1375 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 1376 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 1377 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 1378 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 1379 { 1380 "message": "A String", # [Output Only] A human-readable description of the warning code. 1381 "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. 1382 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 1383 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 1384 { 1385 "value": "A String", # [Output Only] A warning data value corresponding to the key. 1386 "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). 1387 }, 1388 ], 1389 }, 1390 ], 1391 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 1392 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. 1393 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 1394 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 1395 "name": "A String", # [Output Only] Name of the resource. 1396 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 1397 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 1398 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 1399 { 1400 "message": "A String", # [Output Only] An optional, human-readable error message. 1401 "code": "A String", # [Output Only] The error type identifier for this error. 1402 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 1403 }, 1404 ], 1405 }, 1406 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 1407 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 1408 "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. 1409 }</pre> 1410</div> 1411 1412</body></html>