Package com.oracle.bmc.containerinstances.model

Class ContainerHealthCheck

java.lang.Object

com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

com.oracle.bmc.containerinstances.model.ContainerHealthCheck

Direct Known Subclasses:

ContainerHttpHealthCheck, ContainerTcpHealthCheck

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20210415")
public class ContainerHealthCheck
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

Type of container health check which could be either HTTP, TCP, or Command.
Note: Objects should always be created or deserialized using the Builder. This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the Builder, which maintain a set of all explicitly set fields called Builder#__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ContainerHealthCheck.Status	Status of container

Field Summary

Fields inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ContainerHealthCheck(String name, Integer initialDelayInSeconds, Integer intervalInSeconds, Integer failureThreshold, Integer successThreshold, Integer timeoutInSeconds, ContainerHealthCheck.Status status, String statusDetails, ContainerHealthCheckFailureAction failureAction)	Deprecated.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
ContainerHealthCheckFailureAction	getFailureAction()	The action will be triggered when the container health check fails.
Integer	getFailureThreshold()	Number of consecutive failures at which we consider the check failed.
Integer	getInitialDelayInSeconds()	The initial delay in seconds before start checking container health status.
Integer	getIntervalInSeconds()	Number of seconds between two consecutive runs for checking container health.
String	getName()	Health check name.
ContainerHealthCheck.Status	getStatus()	Status of container
String	getStatusDetails()	A message describing the current status in more details.
Integer	getSuccessThreshold()	Number of consecutive successes at which we consider the check succeeded again after it was in failure state.
Integer	getTimeoutInSeconds()	Length of waiting time in seconds before marking health check failed.
int	hashCode()
String	toString()
String	toString(boolean includeByteArrayContents)	Return a string representation of the object.

Methods inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

markPropertyAsExplicitlySet, wasPropertyExplicitlySet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ContainerHealthCheck

@Deprecated
@ConstructorProperties({"name","initialDelayInSeconds","intervalInSeconds","failureThreshold","successThreshold","timeoutInSeconds","status","statusDetails","failureAction"})
protected ContainerHealthCheck(String name,
                               Integer initialDelayInSeconds,
                               Integer intervalInSeconds,
                               Integer failureThreshold,
                               Integer successThreshold,
                               Integer timeoutInSeconds,
                               ContainerHealthCheck.Status status,
                               String statusDetails,
                               ContainerHealthCheckFailureAction failureAction)

Deprecated.

Method Detail

getName

public String getName()

Health check name.

Returns:

the value

getInitialDelayInSeconds

public Integer getInitialDelayInSeconds()

The initial delay in seconds before start checking container health status.

Returns:

the value

getIntervalInSeconds

public Integer getIntervalInSeconds()

Number of seconds between two consecutive runs for checking container health.

Returns:

the value

getFailureThreshold

public Integer getFailureThreshold()

Number of consecutive failures at which we consider the check failed.

Returns:

the value

getSuccessThreshold

public Integer getSuccessThreshold()

Number of consecutive successes at which we consider the check succeeded again after it was in failure state.

Returns:

the value

getTimeoutInSeconds

public Integer getTimeoutInSeconds()

Length of waiting time in seconds before marking health check failed.

Returns:

the value

getStatus

public ContainerHealthCheck.Status getStatus()

Status of container

Returns:

the value

getStatusDetails

public String getStatusDetails()

A message describing the current status in more details.

Returns:

the value

getFailureAction

public ContainerHealthCheckFailureAction getFailureAction()

The action will be triggered when the container health check fails.

There are two types of action: KILL or NONE. The default action is KILL. If failure action is KILL, the container will be subject to the container restart policy.

Returns:

the value

toString

public String toString()

Overrides:

toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

toString

public String toString(boolean includeByteArrayContents)

Return a string representation of the object.

Parameters:

includeByteArrayContents - true to include the full contents of byte arrays

Returns:

string representation

equals

public boolean equals(Object o)

Overrides:

equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

hashCode

public int hashCode()

Overrides:

hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel