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 GenericJson

Cloud Run fully managed: not supported Cloud Run for Anthos: supported 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

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() (Optional) Cloud Run fully managed: not supported Cloud Run for Anthos: supported One and only one of the following should be specified.
Integer	getFailureThreshold() (Optional) Cloud Run fully managed: not supported Cloud Run for Anthos: supported Minimum consecutive failures for the probe to be considered failed after having succeeded.
HTTPGetAction	getHttpGet() (Optional) Cloud Run fully managed: not supported Cloud Run for Anthos: supported HTTPGet specifies the http request to perform.
Integer	getInitialDelaySeconds() (Optional) Cloud Run fully managed: not supported Cloud Run for Anthos: supported Number of seconds after the container has started before liveness probes are initiated.
Integer	getPeriodSeconds() (Optional) Cloud Run fully managed: not supported Cloud Run for Anthos: supported How often (in seconds) to perform the probe.
Integer	getSuccessThreshold() (Optional) Cloud Run fully managed: not supported Cloud Run for Anthos: supported Minimum consecutive successes for the probe to be considered successful after having failed.
TCPSocketAction	getTcpSocket() (Optional) Cloud Run fully managed: not supported Cloud Run for Anthos: supported TCPSocket specifies an action involving a TCP port.
Integer	getTimeoutSeconds() (Optional) Cloud Run fully managed: not supported Cloud Run for Anthos: supported Number of seconds after which the probe times out.
Probe	set(String fieldName, Object value)
Probe	setExec(ExecAction exec) (Optional) Cloud Run fully managed: not supported Cloud Run for Anthos: supported One and only one of the following should be specified.
Probe	setFailureThreshold(Integer failureThreshold) (Optional) Cloud Run fully managed: not supported Cloud Run for Anthos: supported Minimum consecutive failures for the probe to be considered failed after having succeeded.
Probe	setHttpGet(HTTPGetAction httpGet) (Optional) Cloud Run fully managed: not supported Cloud Run for Anthos: supported HTTPGet specifies the http request to perform.
Probe	setInitialDelaySeconds(Integer initialDelaySeconds) (Optional) Cloud Run fully managed: not supported Cloud Run for Anthos: supported Number of seconds after the container has started before liveness probes are initiated.
Probe	setPeriodSeconds(Integer periodSeconds) (Optional) Cloud Run fully managed: not supported Cloud Run for Anthos: supported How often (in seconds) to perform the probe.
Probe	setSuccessThreshold(Integer successThreshold) (Optional) Cloud Run fully managed: not supported Cloud Run for Anthos: supported Minimum consecutive successes for the probe to be considered successful after having failed.
Probe	setTcpSocket(TCPSocketAction tcpSocket) (Optional) Cloud Run fully managed: not supported Cloud Run for Anthos: supported TCPSocket specifies an action involving a TCP port.
Probe	setTimeoutSeconds(Integer timeoutSeconds) (Optional) Cloud Run fully managed: not supported Cloud Run for Anthos: supported 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()

(Optional) Cloud Run fully managed: not supported Cloud Run for Anthos: supported One and only one of the following should be specified. Exec specifies the action to take. A field inlined from the Handler message.

Returns:

value or null for none

setExec

public Probe setExec(ExecAction exec)

(Optional) Cloud Run fully managed: not supported Cloud Run for Anthos: supported One and only one of the following should be specified. Exec specifies the action to take. A field inlined from the Handler message.

Parameters:

exec - exec or null for none

getFailureThreshold

public Integer getFailureThreshold()

(Optional) Cloud Run fully managed: not supported Cloud Run for Anthos: supported 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)

(Optional) Cloud Run fully managed: not supported Cloud Run for Anthos: supported 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

getHttpGet

public HTTPGetAction getHttpGet()

(Optional) Cloud Run fully managed: not supported Cloud Run for Anthos: supported HTTPGet specifies the http request to perform. A field inlined from the Handler message.

Returns:

value or null for none

setHttpGet

public Probe setHttpGet(HTTPGetAction httpGet)

(Optional) Cloud Run fully managed: not supported Cloud Run for Anthos: supported HTTPGet specifies the http request to perform. A field inlined from the Handler message.

Parameters:

httpGet - httpGet or null for none

getInitialDelaySeconds

public Integer getInitialDelaySeconds()

(Optional) Cloud Run fully managed: not supported Cloud Run for Anthos: supported Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

Returns:

value or null for none

setInitialDelaySeconds

public Probe setInitialDelaySeconds(Integer initialDelaySeconds)

(Optional) Cloud Run fully managed: not supported Cloud Run for Anthos: supported Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

Parameters:

initialDelaySeconds - initialDelaySeconds or null for none

getPeriodSeconds

public Integer getPeriodSeconds()

(Optional) Cloud Run fully managed: not supported Cloud Run for Anthos: supported How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.

Returns:

value or null for none

setPeriodSeconds

public Probe setPeriodSeconds(Integer periodSeconds)

(Optional) Cloud Run fully managed: not supported Cloud Run for Anthos: supported How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.

Parameters:

periodSeconds - periodSeconds or null for none

getSuccessThreshold

public Integer getSuccessThreshold()

(Optional) Cloud Run fully managed: not supported Cloud Run for Anthos: supported Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness. Minimum value is 1.

Returns:

value or null for none

setSuccessThreshold

public Probe setSuccessThreshold(Integer successThreshold)

(Optional) Cloud Run fully managed: not supported Cloud Run for Anthos: supported Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness. Minimum value is 1.

Parameters:

successThreshold - successThreshold or null for none

getTcpSocket

public TCPSocketAction getTcpSocket()

(Optional) Cloud Run fully managed: not supported Cloud Run for Anthos: supported TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported A field inlined from the Handler message.

Returns:

value or null for none

setTcpSocket

public Probe setTcpSocket(TCPSocketAction tcpSocket)

(Optional) Cloud Run fully managed: not supported Cloud Run for Anthos: supported TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported A field inlined from the Handler message.

Parameters:

tcpSocket - tcpSocket or null for none

getTimeoutSeconds

public Integer getTimeoutSeconds()

(Optional) Cloud Run fully managed: not supported Cloud Run for Anthos: supported Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

Returns:

value or null for none

setTimeoutSeconds

public Probe setTimeoutSeconds(Integer timeoutSeconds)

(Optional) Cloud Run fully managed: not supported Cloud Run for Anthos: supported Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

Parameters:

timeoutSeconds - timeoutSeconds or null for none

set

public Probe set(String fieldName,
                 Object value)

Overrides:

set in class GenericJson

clone

public Probe clone()

Overrides:

clone in class GenericJson