com.google.api.services.appengine.v1.model

Class ReadinessCheck

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.v1.model.ReadinessCheck

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>

public final class ReadinessCheck
extends com.google.api.client.json.GenericJson

Readiness checking configuration for VM instances. Unhealthy instances are removed from traffic rotation.

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

Method Summary

Modifier and Type	Method and Description
ReadinessCheck	clone()
java.lang.String	getAppStartTimeout() A maximum time limit on application initialization, measured from moment the application successfully replies to a healthcheck until it is ready to serve traffic.
java.lang.String	getCheckInterval() Interval between health checks.
java.lang.Long	getFailureThreshold() Number of consecutive failed checks required before removing traffic.
java.lang.String	getHost() Host header to send when performing a HTTP Readiness check.
java.lang.String	getPath() The request path.
java.lang.Long	getSuccessThreshold() Number of consecutive successful checks required before receiving traffic.
java.lang.String	getTimeout() Time before the check is considered failed.
ReadinessCheck	set(java.lang.String fieldName, java.lang.Object value)
ReadinessCheck	setAppStartTimeout(java.lang.String appStartTimeout) A maximum time limit on application initialization, measured from moment the application successfully replies to a healthcheck until it is ready to serve traffic.
ReadinessCheck	setCheckInterval(java.lang.String checkInterval) Interval between health checks.
ReadinessCheck	setFailureThreshold(java.lang.Long failureThreshold) Number of consecutive failed checks required before removing traffic.
ReadinessCheck	setHost(java.lang.String host) Host header to send when performing a HTTP Readiness check.
ReadinessCheck	setPath(java.lang.String path) The request path.
ReadinessCheck	setSuccessThreshold(java.lang.Long successThreshold) Number of consecutive successful checks required before receiving traffic.
ReadinessCheck	setTimeout(java.lang.String timeout) Time before the check is considered failed.

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

ReadinessCheck

public ReadinessCheck()

Method Detail

getAppStartTimeout

public java.lang.String getAppStartTimeout()

A maximum time limit on application initialization, measured from moment the application successfully replies to a healthcheck until it is ready to serve traffic.

Returns:

value or null for none

setAppStartTimeout

public ReadinessCheck setAppStartTimeout(java.lang.String appStartTimeout)

A maximum time limit on application initialization, measured from moment the application successfully replies to a healthcheck until it is ready to serve traffic.

Parameters:

appStartTimeout - appStartTimeout or null for none

getCheckInterval

public java.lang.String getCheckInterval()

Interval between health checks.

Returns:

value or null for none

setCheckInterval

public ReadinessCheck setCheckInterval(java.lang.String checkInterval)

Interval between health checks.

Parameters:

checkInterval - checkInterval or null for none

getFailureThreshold

public java.lang.Long getFailureThreshold()

Number of consecutive failed checks required before removing traffic.

Returns:

value or null for none

setFailureThreshold

public ReadinessCheck setFailureThreshold(java.lang.Long failureThreshold)

Number of consecutive failed checks required before removing traffic.

Parameters:

failureThreshold - failureThreshold or null for none

getHost

public java.lang.String getHost()

Host header to send when performing a HTTP Readiness check. Example: "myapp.appspot.com"

Returns:

value or null for none

setHost

public ReadinessCheck setHost(java.lang.String host)

Host header to send when performing a HTTP Readiness check. Example: "myapp.appspot.com"

Parameters:

host - host or null for none

getPath

public java.lang.String getPath()

The request path.

Returns:

value or null for none

setPath

public ReadinessCheck setPath(java.lang.String path)

The request path.

Parameters:

path - path or null for none

getSuccessThreshold

public java.lang.Long getSuccessThreshold()

Number of consecutive successful checks required before receiving traffic.

Returns:

value or null for none

setSuccessThreshold

public ReadinessCheck setSuccessThreshold(java.lang.Long successThreshold)

Number of consecutive successful checks required before receiving traffic.

Parameters:

successThreshold - successThreshold or null for none

getTimeout

public java.lang.String getTimeout()

Time before the check is considered failed.

Returns:

value or null for none

setTimeout

public ReadinessCheck setTimeout(java.lang.String timeout)

Time before the check is considered failed.

Parameters:

timeout - timeout or null for none

set

public ReadinessCheck set(java.lang.String fieldName,
                          java.lang.Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public ReadinessCheck clone()

Overrides:

clone in class com.google.api.client.json.GenericJson