HealthCheck (Compute Engine API v1 (Rev. 235) 1.25.0)

java.lang.Object
- java.util.AbstractMap<java.lang.String,java.lang.Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.compute.model.HealthCheck

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>
```
public final class HealthCheck
extends com.google.api.client.json.GenericJson
```
Represents a Health Check resource. Google Compute Engine has two Health Check resources: * [Global](/compute/docs/reference/rest/latest/healthChecks) * [Regional](/compute/docs/reference/rest/latest/regionHealthChecks) Internal HTTP(S) load balancers use regional health checks. All other types of GCP load balancers and managed instance group auto-healing use global health checks. For more information, read Health Check Concepts. To perform health checks on network load balancers, you must use either httpHealthChecks or httpsHealthChecks.
This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Compute Engine API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
  com.google.api.client.util.GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  java.util.Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

HealthCheck()

Constructors
Constructor and Description
`HealthCheck()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`HealthCheck`	`clone()`
`java.lang.Integer`	`getCheckIntervalSec()` How often (in seconds) to send a health check.
`java.lang.String`	`getCreationTimestamp()` [Output Only] Creation timestamp in 3339 text format.
`java.lang.String`	`getDescription()` An optional description of this resource.
`java.lang.Integer`	`getHealthyThreshold()` A so-far unhealthy instance will be marked healthy after this many consecutive successes.
`HTTP2HealthCheck`	`getHttp2HealthCheck()`
`HTTPHealthCheck`	`getHttpHealthCheck()`
`HTTPSHealthCheck`	`getHttpsHealthCheck()`
`java.math.BigInteger`	`getId()` [Output Only] The unique identifier for the resource.
`java.lang.String`	`getKind()` Type of the resource.
`java.lang.String`	`getName()` Name of the resource.
`java.lang.String`	`getRegion()` [Output Only] Region where the health check resides.
`java.lang.String`	`getSelfLink()` [Output Only] Server-defined URL for the resource.
`SSLHealthCheck`	`getSslHealthCheck()`
`TCPHealthCheck`	`getTcpHealthCheck()`
`java.lang.Integer`	`getTimeoutSec()` How long (in seconds) to wait before claiming failure.
`java.lang.String`	`getType()` Specifies the type of the healthCheck, either TCP, SSL, HTTP, HTTPS or HTTP2.
`java.lang.Integer`	`getUnhealthyThreshold()` A so-far healthy instance will be marked unhealthy after this many consecutive failures.
`HealthCheck`	`set(java.lang.String fieldName, java.lang.Object value)`
`HealthCheck`	`setCheckIntervalSec(java.lang.Integer checkIntervalSec)` How often (in seconds) to send a health check.
`HealthCheck`	`setCreationTimestamp(java.lang.String creationTimestamp)` [Output Only] Creation timestamp in 3339 text format.
`HealthCheck`	`setDescription(java.lang.String description)` An optional description of this resource.
`HealthCheck`	`setHealthyThreshold(java.lang.Integer healthyThreshold)` A so-far unhealthy instance will be marked healthy after this many consecutive successes.
`HealthCheck`	`setHttp2HealthCheck(HTTP2HealthCheck http2HealthCheck)`
`HealthCheck`	`setHttpHealthCheck(HTTPHealthCheck httpHealthCheck)`
`HealthCheck`	`setHttpsHealthCheck(HTTPSHealthCheck httpsHealthCheck)`
`HealthCheck`	`setId(java.math.BigInteger id)` [Output Only] The unique identifier for the resource.
`HealthCheck`	`setKind(java.lang.String kind)` Type of the resource.
`HealthCheck`	`setName(java.lang.String name)` Name of the resource.
`HealthCheck`	`setRegion(java.lang.String region)` [Output Only] Region where the health check resides.
`HealthCheck`	`setSelfLink(java.lang.String selfLink)` [Output Only] Server-defined URL for the resource.
`HealthCheck`	`setSslHealthCheck(SSLHealthCheck sslHealthCheck)`
`HealthCheck`	`setTcpHealthCheck(TCPHealthCheck tcpHealthCheck)`
`HealthCheck`	`setTimeoutSec(java.lang.Integer timeoutSec)` How long (in seconds) to wait before claiming failure.
`HealthCheck`	`setType(java.lang.String type)` Specifies the type of the healthCheck, either TCP, SSL, HTTP, HTTPS or HTTP2.
`HealthCheck`	`setUnhealthyThreshold(java.lang.Integer unhealthyThreshold)` A so-far healthy instance will be marked unhealthy after this many consecutive failures.

Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData
entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - HealthCheck
```
public HealthCheck()
```
- Method Detail
  - getCheckIntervalSec
```
public java.lang.Integer getCheckIntervalSec()
```
    How often (in seconds) to send a health check. The default value is 5 seconds.
    
    Returns:
    
    value or null for none
  - setCheckIntervalSec
```
public HealthCheck setCheckIntervalSec(java.lang.Integer checkIntervalSec)
```
    How often (in seconds) to send a health check. The default value is 5 seconds.
    
    Parameters:
    
    checkIntervalSec - checkIntervalSec or null for none
  - getCreationTimestamp
```
public java.lang.String getCreationTimestamp()
```
    [Output Only] Creation timestamp in 3339 text format.
    
    Returns:
    
    value or null for none
  - setCreationTimestamp
```
public HealthCheck setCreationTimestamp(java.lang.String creationTimestamp)
```
    [Output Only] Creation timestamp in 3339 text format.
    
    Parameters:
    
    creationTimestamp - creationTimestamp or null for none
  - getDescription
```
public java.lang.String getDescription()
```
    An optional description of this resource. Provide this property when you create the resource.
    
    Returns:
    
    value or null for none
  - setDescription
```
public HealthCheck setDescription(java.lang.String description)
```
    An optional description of this resource. Provide this property when you create the resource.
    
    Parameters:
    
    description - description or null for none
  - getHealthyThreshold
```
public java.lang.Integer getHealthyThreshold()
```
    A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.
    
    Returns:
    
    value or null for none
  - setHealthyThreshold
```
public HealthCheck setHealthyThreshold(java.lang.Integer healthyThreshold)
```
    A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.
    
    Parameters:
    
    healthyThreshold - healthyThreshold or null for none
  - getHttp2HealthCheck
```
public HTTP2HealthCheck getHttp2HealthCheck()
```
    Returns:
    
    value or null for none
  - setHttp2HealthCheck
```
public HealthCheck setHttp2HealthCheck(HTTP2HealthCheck http2HealthCheck)
```
    Parameters:
    
    http2HealthCheck - http2HealthCheck or null for none
  - getHttpHealthCheck
```
public HTTPHealthCheck getHttpHealthCheck()
```
    Returns:
    
    value or null for none
  - setHttpHealthCheck
```
public HealthCheck setHttpHealthCheck(HTTPHealthCheck httpHealthCheck)
```
    Parameters:
    
    httpHealthCheck - httpHealthCheck or null for none
  - getHttpsHealthCheck
```
public HTTPSHealthCheck getHttpsHealthCheck()
```
    Returns:
    
    value or null for none
  - setHttpsHealthCheck
```
public HealthCheck setHttpsHealthCheck(HTTPSHealthCheck httpsHealthCheck)
```
    Parameters:
    
    httpsHealthCheck - httpsHealthCheck or null for none
  - getId
```
public java.math.BigInteger getId()
```
    [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    
    Returns:
    
    value or null for none
  - setId
```
public HealthCheck setId(java.math.BigInteger id)
```
    [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    
    Parameters:
    
    id - id or null for none
  - getKind
```
public java.lang.String getKind()
```
    Type of the resource.
    
    Returns:
    
    value or null for none
  - setKind
```
public HealthCheck setKind(java.lang.String kind)
```
    Type of the resource.
    
    Parameters:
    
    kind - kind or null for none
  - getName
```
public java.lang.String getName()
```
    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.
    
    Returns:
    
    value or null for none
  - setName
```
public HealthCheck setName(java.lang.String name)
```
    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.
    
    Parameters:
    
    name - name or null for none
  - getRegion
```
public java.lang.String getRegion()
```
    [Output Only] Region where the health check resides. Not applicable to global health checks.
    
    Returns:
    
    value or null for none
  - setRegion
```
public HealthCheck setRegion(java.lang.String region)
```
    [Output Only] Region where the health check resides. Not applicable to global health checks.
    
    Parameters:
    
    region - region or null for none
  - getSelfLink
```
public java.lang.String getSelfLink()
```
    [Output Only] Server-defined URL for the resource.
    
    Returns:
    
    value or null for none
  - setSelfLink
```
public HealthCheck setSelfLink(java.lang.String selfLink)
```
    [Output Only] Server-defined URL for the resource.
    
    Parameters:
    
    selfLink - selfLink or null for none
  - getSslHealthCheck
```
public SSLHealthCheck getSslHealthCheck()
```
    Returns:
    
    value or null for none
  - setSslHealthCheck
```
public HealthCheck setSslHealthCheck(SSLHealthCheck sslHealthCheck)
```
    Parameters:
    
    sslHealthCheck - sslHealthCheck or null for none
  - getTcpHealthCheck
```
public TCPHealthCheck getTcpHealthCheck()
```
    Returns:
    
    value or null for none
  - setTcpHealthCheck
```
public HealthCheck setTcpHealthCheck(TCPHealthCheck tcpHealthCheck)
```
    Parameters:
    
    tcpHealthCheck - tcpHealthCheck or null for none
  - getTimeoutSec
```
public java.lang.Integer getTimeoutSec()
```
    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.
    
    Returns:
    
    value or null for none
  - setTimeoutSec
```
public HealthCheck setTimeoutSec(java.lang.Integer timeoutSec)
```
    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.
    
    Parameters:
    
    timeoutSec - timeoutSec or null for none
  - getType
```
public java.lang.String getType()
```
    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.
    
    Returns:
    
    value or null for none
  - setType
```
public HealthCheck setType(java.lang.String type)
```
    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.
    
    Parameters:
    
    type - type or null for none
  - getUnhealthyThreshold
```
public java.lang.Integer getUnhealthyThreshold()
```
    A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
    
    Returns:
    
    value or null for none
  - setUnhealthyThreshold
```
public HealthCheck setUnhealthyThreshold(java.lang.Integer unhealthyThreshold)
```
    A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
    
    Parameters:
    
    unhealthyThreshold - unhealthyThreshold or null for none
  - set
```
public HealthCheck set(java.lang.String fieldName,
                       java.lang.Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public HealthCheck clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Compute Engine API v1 (revision 235)

Class HealthCheck

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class com.google.api.client.json.GenericJson

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

HealthCheck

Method Detail

getCheckIntervalSec

setCheckIntervalSec

getCreationTimestamp

setCreationTimestamp

getDescription

setDescription

getHealthyThreshold

setHealthyThreshold

getHttp2HealthCheck

setHttp2HealthCheck

getHttpHealthCheck

setHttpHealthCheck

getHttpsHealthCheck

setHttpsHealthCheck

getId

setId

getKind

setKind

getName

setName

getRegion

setRegion

getSelfLink

setSelfLink

getSslHealthCheck

setSslHealthCheck

getTcpHealthCheck

setTcpHealthCheck

getTimeoutSec

setTimeoutSec

getType

setType

getUnhealthyThreshold

setUnhealthyThreshold

set

clone