com.google.api.services.run.v1.model

Class Probe

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.run.v1.model.Probe

All Implemented Interfaces:

Cloneable, Map<String,Object>

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

Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.

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 Cloud Run 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

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

Method Summary

Modifier and Type	Method and Description
Probe	clone()
ExecAction	getExec() Not supported by Cloud Run.
Integer	getFailureThreshold() Minimum consecutive failures for the probe to be considered failed after having succeeded.
GRPCAction	getGrpc() GRPCAction specifies an action involving a GRPC port.
HTTPGetAction	getHttpGet() HTTPGet specifies the http request to perform.
Integer	getInitialDelaySeconds() Number of seconds after the container has started before the probe is initiated.
Integer	getPeriodSeconds() How often (in seconds) to perform the probe.
Integer	getSuccessThreshold() Minimum consecutive successes for the probe to be considered successful after having failed.
TCPSocketAction	getTcpSocket() TCPSocket specifies an action involving a TCP port.
Integer	getTimeoutSeconds() Number of seconds after which the probe times out.
Probe	set(String fieldName, Object value)
Probe	setExec(ExecAction exec) Not supported by Cloud Run.
Probe	setFailureThreshold(Integer failureThreshold) Minimum consecutive failures for the probe to be considered failed after having succeeded.
Probe	setGrpc(GRPCAction grpc) GRPCAction specifies an action involving a GRPC port.
Probe	setHttpGet(HTTPGetAction httpGet) HTTPGet specifies the http request to perform.
Probe	setInitialDelaySeconds(Integer initialDelaySeconds) Number of seconds after the container has started before the probe is initiated.
Probe	setPeriodSeconds(Integer periodSeconds) How often (in seconds) to perform the probe.
Probe	setSuccessThreshold(Integer successThreshold) Minimum consecutive successes for the probe to be considered successful after having failed.
Probe	setTcpSocket(TCPSocketAction tcpSocket) TCPSocket specifies an action involving a TCP port.
Probe	setTimeoutSeconds(Integer timeoutSeconds) Number of seconds after which the probe times out.

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, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, 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

Probe

public Probe()

Method Detail

getExec

public ExecAction getExec()

Not supported by Cloud Run.

Returns:

value or null for none

setExec

public Probe setExec(ExecAction exec)

Not supported by Cloud Run.

Parameters:

exec - exec or null for none

getFailureThreshold

public Integer getFailureThreshold()

Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.

Returns:

value or null for none

setFailureThreshold

public Probe setFailureThreshold(Integer failureThreshold)

Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.

Parameters:

failureThreshold - failureThreshold or null for none

getGrpc

public GRPCAction getGrpc()

GRPCAction specifies an action involving a GRPC port.

Returns:

value or null for none

setGrpc

public Probe setGrpc(GRPCAction grpc)

GRPCAction specifies an action involving a GRPC port.

Parameters:

grpc - grpc or null for none

getHttpGet

public HTTPGetAction getHttpGet()

HTTPGet specifies the http request to perform.

Returns:

value or null for none

setHttpGet

public Probe setHttpGet(HTTPGetAction httpGet)

HTTPGet specifies the http request to perform.

Parameters:

httpGet - httpGet or null for none

getInitialDelaySeconds

public Integer getInitialDelaySeconds()

Number of seconds after the container has started before the probe is initiated. Defaults to 0 seconds. Minimum value is 0. Maximum value for liveness probe is 3600. Maximum value for startup probe is 240.

Returns:

value or null for none

setInitialDelaySeconds

public Probe setInitialDelaySeconds(Integer initialDelaySeconds)

Number of seconds after the container has started before the probe is initiated. Defaults to 0 seconds. Minimum value is 0. Maximum value for liveness probe is 3600. Maximum value for startup probe is 240.

Parameters:

initialDelaySeconds - initialDelaySeconds or null for none

getPeriodSeconds

public Integer getPeriodSeconds()

How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Maximum value for liveness probe is 3600. Maximum value for startup probe is 240. Must be greater or equal than timeout_seconds.

Returns:

value or null for none

setPeriodSeconds

public Probe setPeriodSeconds(Integer periodSeconds)

How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Maximum value for liveness probe is 3600. Maximum value for startup probe is 240. Must be greater or equal than timeout_seconds.

Parameters:

periodSeconds - periodSeconds or null for none

getSuccessThreshold

public Integer getSuccessThreshold()

Minimum consecutive successes for the probe to be considered successful after having failed. Must be 1 if set.

Returns:

value or null for none

setSuccessThreshold

public Probe setSuccessThreshold(Integer successThreshold)

Minimum consecutive successes for the probe to be considered successful after having failed. Must be 1 if set.

Parameters:

successThreshold - successThreshold or null for none

getTcpSocket

public TCPSocketAction getTcpSocket()

TCPSocket specifies an action involving a TCP port.

Returns:

value or null for none

setTcpSocket

public Probe setTcpSocket(TCPSocketAction tcpSocket)

TCPSocket specifies an action involving a TCP port.

Parameters:

tcpSocket - tcpSocket or null for none

getTimeoutSeconds

public Integer getTimeoutSeconds()

Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 3600. Must be smaller than period_seconds; if period_seconds is not set, must be less or equal than 10.

Returns:

value or null for none

setTimeoutSeconds

public Probe setTimeoutSeconds(Integer timeoutSeconds)

Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 3600. Must be smaller than period_seconds; if period_seconds is not set, must be less or equal than 10.

Parameters:

timeoutSeconds - timeoutSeconds or null for none

set

public Probe set(String fieldName,
                 Object value)

Overrides:

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

clone

public Probe clone()

Overrides:

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