com.google.api.services.run.v2.model

Class GoogleCloudRunV2Probe

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.v2.model.GoogleCloudRunV2Probe

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class GoogleCloudRunV2Probe
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
GoogleCloudRunV2Probe()

Method Summary

Modifier and Type	Method and Description
GoogleCloudRunV2Probe	clone()
Integer	getFailureThreshold() Optional.
GoogleCloudRunV2GRPCAction	getGrpc() Optional.
GoogleCloudRunV2HTTPGetAction	getHttpGet() Optional.
Integer	getInitialDelaySeconds() Optional.
Integer	getPeriodSeconds() Optional.
GoogleCloudRunV2TCPSocketAction	getTcpSocket() Optional.
Integer	getTimeoutSeconds() Optional.
GoogleCloudRunV2Probe	set(String fieldName, Object value)
GoogleCloudRunV2Probe	setFailureThreshold(Integer failureThreshold) Optional.
GoogleCloudRunV2Probe	setGrpc(GoogleCloudRunV2GRPCAction grpc) Optional.
GoogleCloudRunV2Probe	setHttpGet(GoogleCloudRunV2HTTPGetAction httpGet) Optional.
GoogleCloudRunV2Probe	setInitialDelaySeconds(Integer initialDelaySeconds) Optional.
GoogleCloudRunV2Probe	setPeriodSeconds(Integer periodSeconds) Optional.
GoogleCloudRunV2Probe	setTcpSocket(GoogleCloudRunV2TCPSocketAction tcpSocket) Optional.
GoogleCloudRunV2Probe	setTimeoutSeconds(Integer timeoutSeconds) Optional.

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

GoogleCloudRunV2Probe

public GoogleCloudRunV2Probe()

Method Detail

getFailureThreshold

public Integer getFailureThreshold()

Optional. 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 GoogleCloudRunV2Probe setFailureThreshold(Integer failureThreshold)

Optional. 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 GoogleCloudRunV2GRPCAction getGrpc()

Optional. GRPC specifies an action involving a gRPC port. Exactly one of httpGet, tcpSocket, or grpc must be specified.

Returns:

value or null for none

setGrpc

public GoogleCloudRunV2Probe setGrpc(GoogleCloudRunV2GRPCAction grpc)

Optional. GRPC specifies an action involving a gRPC port. Exactly one of httpGet, tcpSocket, or grpc must be specified.

Parameters:

grpc - grpc or null for none

getHttpGet

public GoogleCloudRunV2HTTPGetAction getHttpGet()

Optional. HTTPGet specifies the http request to perform. Exactly one of httpGet, tcpSocket, or grpc must be specified.

Returns:

value or null for none

setHttpGet

public GoogleCloudRunV2Probe setHttpGet(GoogleCloudRunV2HTTPGetAction httpGet)

Optional. HTTPGet specifies the http request to perform. Exactly one of httpGet, tcpSocket, or grpc must be specified.

Parameters:

httpGet - httpGet or null for none

getInitialDelaySeconds

public Integer getInitialDelaySeconds()

Optional. 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 GoogleCloudRunV2Probe setInitialDelaySeconds(Integer initialDelaySeconds)

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

Optional. 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 GoogleCloudRunV2Probe setPeriodSeconds(Integer periodSeconds)

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

getTcpSocket

public GoogleCloudRunV2TCPSocketAction getTcpSocket()

Optional. TCPSocket specifies an action involving a TCP port. Exactly one of httpGet, tcpSocket, or grpc must be specified.

Returns:

value or null for none

setTcpSocket

public GoogleCloudRunV2Probe setTcpSocket(GoogleCloudRunV2TCPSocketAction tcpSocket)

Optional. TCPSocket specifies an action involving a TCP port. Exactly one of httpGet, tcpSocket, or grpc must be specified.

Parameters:

tcpSocket - tcpSocket or null for none

getTimeoutSeconds

public Integer getTimeoutSeconds()

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

Returns:

value or null for none

setTimeoutSeconds

public GoogleCloudRunV2Probe setTimeoutSeconds(Integer timeoutSeconds)

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

Parameters:

timeoutSeconds - timeoutSeconds or null for none

set

public GoogleCloudRunV2Probe set(String fieldName,
                                 Object value)

Overrides:

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

clone

public GoogleCloudRunV2Probe clone()

Overrides:

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