com.google.api.services.compute.model

Class HttpHealthCheck

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

Upgrade warning: starting with version 1.12 getResponseHeaders() is removed, instead use JsonHttpRequest.getLastResponseHeaders()

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()

Method Summary

Methods

Modifier and Type	Method and Description
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 host name of the HTTP health check request.
com.google.common.primitives.UnsignedLong	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	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 host name of the HTTP health check request.
HttpHealthCheck	setId(com.google.common.primitives.UnsignedLong 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

clone, getFactory, setFactory, toPrettyString, toString

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

entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, set, 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. The value returned may be null.

setCheckIntervalSec

public HttpHealthCheck setCheckIntervalSec(Integer checkIntervalSec)

How often (in seconds) to send a health check. The default value is 5 seconds. The value set may be null.

getCreationTimestamp

public String getCreationTimestamp()

Creation timestamp in RFC3339 text format (output only). The value returned may be null.

setCreationTimestamp

public HttpHealthCheck setCreationTimestamp(String creationTimestamp)

Creation timestamp in RFC3339 text format (output only). The value set may be null.

getDescription

public String getDescription()

An optional textual description of the resource; provided by the client when the resource is created. The value returned may be null.

setDescription

public HttpHealthCheck setDescription(String description)

An optional textual description of the resource; provided by the client when the resource is created. The value set may be null.

getHealthyThreshold

public Integer getHealthyThreshold()

A so-far unhealthy VM will be marked healthy after this many consecutive successes. The default value is 2. The value returned may be null.

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. The value set may be null.

getHost

public String getHost()

The host name of 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. The value returned may be null.

setHost

public HttpHealthCheck setHost(String host)

The host name of 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. The value set may be null.

getId

public com.google.common.primitives.UnsignedLong getId()

Unique identifier for the resource; defined by the server (output only). The value returned may be null.

setId

public HttpHealthCheck setId(com.google.common.primitives.UnsignedLong id)

Unique identifier for the resource; defined by the server (output only). The value set may be null.

getKind

public String getKind()

Type of the resource. The value returned may be null.

setKind

public HttpHealthCheck setKind(String kind)

Type of the resource. The value set may be null.

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. The value returned may be null.

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. The value set may be null.

getPort

public Integer getPort()

The TCP port number for the HTTP health check request. The default value is 80. The value returned may be null.

setPort

public HttpHealthCheck setPort(Integer port)

The TCP port number for the HTTP health check request. The default value is 80. The value set may be null.

getRequestPath

public String getRequestPath()

The request path of the HTTP health check request. The default value is "/". The value returned may be null.

setRequestPath

public HttpHealthCheck setRequestPath(String requestPath)

The request path of the HTTP health check request. The default value is "/". The value set may be null.

getSelfLink

public String getSelfLink()

Server defined URL for the resource (output only). The value returned may be null.

setSelfLink

public HttpHealthCheck setSelfLink(String selfLink)

Server defined URL for the resource (output only). The value set may be null.

getTimeoutSec

public Integer getTimeoutSec()

How long (in seconds) to wait before claiming failure. The default value is 5 seconds. The value returned may be null.

setTimeoutSec

public HttpHealthCheck setTimeoutSec(Integer timeoutSec)

How long (in seconds) to wait before claiming failure. The default value is 5 seconds. The value set may be null.

getUnhealthyThreshold

public Integer getUnhealthyThreshold()

A so-far healthy VM will be marked unhealthy after this many consecutive failures. The default value is 2. The value returned may be null.

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. The value set may be null.