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