HttpHealthCheck (Compute Engine API v1 (Rev. 5) 1.14.2-beta)

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

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class HttpHealthCheck
extends GenericJson
```
An HttpHealthCheck resource. This resource defines a template for how individual VMs should be checked for health, via HTTP.
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: http://code.google.com/p/google-api-java-client/wiki/Json

Author:

Google, Inc.

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

Constructor Summary

Constructors
Constructor and Description

HttpHealthCheck()

Constructors
Constructor and Description
`HttpHealthCheck()`

Method Summary

Methods
Modifier and Type	Method and Description
`HttpHealthCheck`	`clone()`
`Integer`	`getCheckIntervalSec()` How often (in seconds) to send a health check.
`String`	`getCreationTimestamp()` Creation timestamp in RFC3339 text format (output only).
`String`	`getDescription()` An optional textual description of the resource; provided by the client when the resource is created.
`Integer`	`getHealthyThreshold()` A so-far unhealthy VM will be marked healthy after this many consecutive successes.
`String`	`getHost()` The value of the host header in the HTTP health check request.
`BigInteger`	`getId()` Unique identifier for the resource; defined by the server (output only).
`String`	`getKind()` Type of the resource.
`String`	`getName()` Name of the resource; provided by the client when the resource is created.
`Integer`	`getPort()` The TCP port number for the HTTP health check request.
`String`	`getRequestPath()` The request path of the HTTP health check request.
`String`	`getSelfLink()` Server defined URL for the resource (output only).
`Integer`	`getTimeoutSec()` How long (in seconds) to wait before claiming failure.
`Integer`	`getUnhealthyThreshold()` A so-far healthy VM will be marked unhealthy after this many consecutive failures.
`HttpHealthCheck`	`set(String fieldName, Object value)`
`HttpHealthCheck`	`setCheckIntervalSec(Integer checkIntervalSec)` How often (in seconds) to send a health check.
`HttpHealthCheck`	`setCreationTimestamp(String creationTimestamp)` Creation timestamp in RFC3339 text format (output only).
`HttpHealthCheck`	`setDescription(String description)` An optional textual description of the resource; provided by the client when the resource is created.
`HttpHealthCheck`	`setHealthyThreshold(Integer healthyThreshold)` A so-far unhealthy VM will be marked healthy after this many consecutive successes.
`HttpHealthCheck`	`setHost(String host)` The value of the host header in the HTTP health check request.
`HttpHealthCheck`	`setId(BigInteger id)` Unique identifier for the resource; defined by the server (output only).
`HttpHealthCheck`	`setKind(String kind)` Type of the resource.
`HttpHealthCheck`	`setName(String name)` Name of the resource; provided by the client when the resource is created.
`HttpHealthCheck`	`setPort(Integer port)` The TCP port number for the HTTP health check request.
`HttpHealthCheck`	`setRequestPath(String requestPath)` The request path of the HTTP health check request.
`HttpHealthCheck`	`setSelfLink(String selfLink)` Server defined URL for the resource (output only).
`HttpHealthCheck`	`setTimeoutSec(Integer timeoutSec)` How long (in seconds) to wait before claiming failure.
`HttpHealthCheck`	`setUnhealthyThreshold(Integer unhealthyThreshold)` A so-far healthy VM 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

- Constructor Detail
  - HttpHealthCheck
```
public HttpHealthCheck()
```
- Method Detail
  - getCheckIntervalSec
```
public 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 HttpHealthCheck setCheckIntervalSec(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 String getCreationTimestamp()
```
    Creation timestamp in RFC3339 text format (output only).
    
    Returns:
    value or null for none
  - setCreationTimestamp
```
public HttpHealthCheck setCreationTimestamp(String creationTimestamp)
```
    Creation timestamp in RFC3339 text format (output only).
    
    Parameters:
    creationTimestamp - creationTimestamp or null for none
  - getDescription
```
public String getDescription()
```
    An optional textual description of the resource; provided by the client when the resource is created.
    
    Returns:
    value or null for none
  - setDescription
```
public HttpHealthCheck setDescription(String description)
```
    An optional textual description of the resource; provided by the client when the resource is created.
    
    Parameters:
    description - description or null for none
  - getHealthyThreshold
```
public Integer getHealthyThreshold()
```
    A so-far unhealthy VM will be marked healthy after this many consecutive successes. The default value is 2.
    
    Returns:
    value or null for none
  - setHealthyThreshold
```
public HttpHealthCheck setHealthyThreshold(Integer healthyThreshold)
```
    A so-far unhealthy VM will be marked healthy after this many consecutive successes. The default value is 2.
    
    Parameters:
    healthyThreshold - healthyThreshold or null for none
  - getHost
```
public String getHost()
```
    The value of the host header in the HTTP health check request. If left empty (default value), the public IP on behalf of which this health check is performed will be used.
    
    Returns:
    value or null for none
  - setHost
```
public HttpHealthCheck setHost(String host)
```
    The value of the host header in the HTTP health check request. If left empty (default value), the public IP on behalf of which this health check is performed will be used.
    
    Parameters:
    host - host or null for none
  - getId
```
public BigInteger getId()
```
    Unique identifier for the resource; defined by the server (output only).
    
    Returns:
    value or null for none
  - setId
```
public HttpHealthCheck setId(BigInteger id)
```
    Unique identifier for the resource; defined by the server (output only).
    
    Parameters:
    id - id or null for none
  - getKind
```
public String getKind()
```
    Type of the resource.
    
    Returns:
    value or null for none
  - setKind
```
public HttpHealthCheck setKind(String kind)
```
    Type of the resource.
    
    Parameters:
    kind - kind or null for none
  - getName
```
public 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.
    
    Returns:
    value or null for none
  - setName
```
public HttpHealthCheck setName(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.
    
    Parameters:
    name - name or null for none
  - getPort
```
public Integer getPort()
```
    The TCP port number for the HTTP health check request. The default value is 80.
    
    Returns:
    value or null for none
  - setPort
```
public HttpHealthCheck setPort(Integer port)
```
    The TCP port number for the HTTP health check request. The default value is 80.
    
    Parameters:
    port - port or null for none
  - getRequestPath
```
public String getRequestPath()
```
    The request path of the HTTP health check request. The default value is "/".
    
    Returns:
    value or null for none
  - setRequestPath
```
public HttpHealthCheck setRequestPath(String requestPath)
```
    The request path of the HTTP health check request. The default value is "/".
    
    Parameters:
    requestPath - requestPath or null for none
  - getSelfLink
```
public String getSelfLink()
```
    Server defined URL for the resource (output only).
    
    Returns:
    value or null for none
  - setSelfLink
```
public HttpHealthCheck setSelfLink(String selfLink)
```
    Server defined URL for the resource (output only).
    
    Parameters:
    selfLink - selfLink or null for none
  - getTimeoutSec
```
public Integer getTimeoutSec()
```
    How long (in seconds) to wait before claiming failure. The default value is 5 seconds.
    
    Returns:
    value or null for none
  - setTimeoutSec
```
public HttpHealthCheck setTimeoutSec(Integer timeoutSec)
```
    How long (in seconds) to wait before claiming failure. The default value is 5 seconds.
    
    Parameters:
    timeoutSec - timeoutSec or null for none
  - getUnhealthyThreshold
```
public Integer getUnhealthyThreshold()
```
    A so-far healthy VM will be marked unhealthy after this many consecutive failures. The default value is 2.
    
    Returns:
    value or null for none
  - setUnhealthyThreshold
```
public HttpHealthCheck setUnhealthyThreshold(Integer unhealthyThreshold)
```
    A so-far healthy VM will be marked unhealthy after this many consecutive failures. The default value is 2.
    
    Parameters:
    unhealthyThreshold - unhealthyThreshold or null for none
  - set
```
public HttpHealthCheck set(String fieldName,
                  Object value)
```
    Overrides:
    
    set in class GenericJson
  - clone
```
public HttpHealthCheck clone()
```
    Overrides:
    
    clone in class GenericJson

Compute Engine API v1 (revision 5)

Class HttpHealthCheck

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

Constructor Detail

HttpHealthCheck

Method Detail

getCheckIntervalSec

setCheckIntervalSec

getCreationTimestamp

setCreationTimestamp

getDescription

setDescription

getHealthyThreshold

setHealthyThreshold

getHost

setHost

getId

setId

getKind

setKind

getName

setName

getPort

setPort

getRequestPath

setRequestPath

getSelfLink

setSelfLink

getTimeoutSec

setTimeoutSec

getUnhealthyThreshold

setUnhealthyThreshold

set

clone