com.google.api.services.appengine.model

Class HealthCheck

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.appengine.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

Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances. Only applicable for instances in App Engine flexible environment.

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 App Engine Admin 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()

Method Summary

Modifier and Type	Method and Description
HealthCheck	clone()
java.lang.String	getCheckInterval() Interval between health checks.
java.lang.Boolean	getDisableHealthCheck() Whether to explicitly disable health checks for this instance.
java.lang.Long	getHealthyThreshold() Number of consecutive successful health checks required before receiving traffic.
java.lang.String	getHost() Host header to send when performing an HTTP health check.
java.lang.Long	getRestartThreshold() Number of consecutive failed health checks required before an instance is restarted.
java.lang.String	getTimeout() Time before the health check is considered failed.
java.lang.Long	getUnhealthyThreshold() Number of consecutive failed health checks required before removing traffic.
HealthCheck	set(java.lang.String fieldName, java.lang.Object value)
HealthCheck	setCheckInterval(java.lang.String checkInterval) Interval between health checks.
HealthCheck	setDisableHealthCheck(java.lang.Boolean disableHealthCheck) Whether to explicitly disable health checks for this instance.
HealthCheck	setHealthyThreshold(java.lang.Long healthyThreshold) Number of consecutive successful health checks required before receiving traffic.
HealthCheck	setHost(java.lang.String host) Host header to send when performing an HTTP health check.
HealthCheck	setRestartThreshold(java.lang.Long restartThreshold) Number of consecutive failed health checks required before an instance is restarted.
HealthCheck	setTimeout(java.lang.String timeout) Time before the health check is considered failed.
HealthCheck	setUnhealthyThreshold(java.lang.Long unhealthyThreshold) Number of consecutive failed health checks required before removing traffic.

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

getCheckInterval

public java.lang.String getCheckInterval()

Interval between health checks.

Returns:

value or null for none

setCheckInterval

public HealthCheck setCheckInterval(java.lang.String checkInterval)

Interval between health checks.

Parameters:

checkInterval - checkInterval or null for none

getDisableHealthCheck

public java.lang.Boolean getDisableHealthCheck()

Whether to explicitly disable health checks for this instance.

Returns:

value or null for none

setDisableHealthCheck

public HealthCheck setDisableHealthCheck(java.lang.Boolean disableHealthCheck)

Whether to explicitly disable health checks for this instance.

Parameters:

disableHealthCheck - disableHealthCheck or null for none

getHealthyThreshold

public java.lang.Long getHealthyThreshold()

Number of consecutive successful health checks required before receiving traffic.

Returns:

value or null for none

setHealthyThreshold

public HealthCheck setHealthyThreshold(java.lang.Long healthyThreshold)

Number of consecutive successful health checks required before receiving traffic.

Parameters:

healthyThreshold - healthyThreshold or null for none

getHost

public java.lang.String getHost()

Host header to send when performing an HTTP health check. Example: "myapp.appspot.com"

Returns:

value or null for none

setHost

public HealthCheck setHost(java.lang.String host)

Host header to send when performing an HTTP health check. Example: "myapp.appspot.com"

Parameters:

host - host or null for none

getRestartThreshold

public java.lang.Long getRestartThreshold()

Number of consecutive failed health checks required before an instance is restarted.

Returns:

value or null for none

setRestartThreshold

public HealthCheck setRestartThreshold(java.lang.Long restartThreshold)

Number of consecutive failed health checks required before an instance is restarted.

Parameters:

restartThreshold - restartThreshold or null for none

getTimeout

public java.lang.String getTimeout()

Time before the health check is considered failed.

Returns:

value or null for none

setTimeout

public HealthCheck setTimeout(java.lang.String timeout)

Time before the health check is considered failed.

Parameters:

timeout - timeout or null for none

getUnhealthyThreshold

public java.lang.Long getUnhealthyThreshold()

Number of consecutive failed health checks required before removing traffic.

Returns:

value or null for none

setUnhealthyThreshold

public HealthCheck setUnhealthyThreshold(java.lang.Long unhealthyThreshold)

Number of consecutive failed health checks required before removing traffic.

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