Class UpdateHealthCheckConfig
java.lang.Object
io.github.alersrt.pod4j.openapi.model.UpdateHealthCheckConfig
- All Implemented Interfaces:
Serializable
@Generated("org.openapitools.codegen.languages.JavaClientCodegen")
public class UpdateHealthCheckConfig
extends Object
implements Serializable
UpdateHealthCheckConfig
- See Also:
-
Nested Class Summary
Nested Classes -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final String -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbooleanstatic UpdateHealthCheckConfigCreate an instance of UpdateHealthCheckConfig given an JSON stringHealthCmd set a healthcheck command for the container.HealthInterval set an interval for the healthcheck.HealthLogDestination set the destination of the HealthCheck log.HealthMaxLogCount set maximum number of attempts in the HealthCheck log file.HealthMaxLogSize set maximum length in characters of stored HealthCheck log.HealthOnFailure set the action to take once the container turns unhealthy.HealthRetries set the number of retries allowed before a healthcheck is considered to be unhealthy.HealthStartPeriod set the initialization time needed for a container to bootstrap.HealthStartupCmd set a startup healthcheck command for the container.HealthStartupInterval set an interval for the startup healthcheck.HealthStartupRetries set the maximum number of retries before the startup healthcheck will restart the container.HealthStartupSuccess set the number of consecutive successes before the startup healthcheck is marked as successful and the normal healthcheck begins (0 indicates any success will start the regular healthcheck)HealthStartupTimeout set the maximum amount of time that the startup healthcheck may take before it is considered failed.HealthTimeout set the maximum time allowed to complete the healthcheck before an interval is considered failed.Disable healthchecks on container.inthashCode()healthInterval(String healthInterval) healthLogDestination(String healthLogDestination) healthMaxLogCount(Integer healthMaxLogCount) healthMaxLogSize(Integer healthMaxLogSize) healthOnFailure(String healthOnFailure) healthRetries(Integer healthRetries) healthStartPeriod(String healthStartPeriod) healthStartupCmd(String healthStartupCmd) healthStartupInterval(String healthStartupInterval) healthStartupRetries(Integer healthStartupRetries) healthStartupSuccess(Integer healthStartupSuccess) healthStartupTimeout(String healthStartupTimeout) healthTimeout(String healthTimeout) noHealthcheck(Boolean noHealthcheck) voidsetHealthCmd(String healthCmd) voidsetHealthInterval(String healthInterval) voidsetHealthLogDestination(String healthLogDestination) voidsetHealthMaxLogCount(Integer healthMaxLogCount) voidsetHealthMaxLogSize(Integer healthMaxLogSize) voidsetHealthOnFailure(String healthOnFailure) voidsetHealthRetries(Integer healthRetries) voidsetHealthStartPeriod(String healthStartPeriod) voidsetHealthStartupCmd(String healthStartupCmd) voidsetHealthStartupInterval(String healthStartupInterval) voidsetHealthStartupRetries(Integer healthStartupRetries) voidsetHealthStartupSuccess(Integer healthStartupSuccess) voidsetHealthStartupTimeout(String healthStartupTimeout) voidsetHealthTimeout(String healthTimeout) voidsetNoHealthcheck(Boolean noHealthcheck) toJson()Convert an instance of UpdateHealthCheckConfig to an JSON stringtoString()static voidvalidateJsonObject(com.google.gson.JsonObject jsonObj) Validates the JSON Object and throws an exception if issues found
-
Field Details
-
SERIALIZED_NAME_HEALTH_CMD
- See Also:
-
SERIALIZED_NAME_HEALTH_INTERVAL
- See Also:
-
SERIALIZED_NAME_HEALTH_LOG_DESTINATION
- See Also:
-
SERIALIZED_NAME_HEALTH_MAX_LOG_COUNT
- See Also:
-
SERIALIZED_NAME_HEALTH_MAX_LOG_SIZE
- See Also:
-
SERIALIZED_NAME_HEALTH_ON_FAILURE
- See Also:
-
SERIALIZED_NAME_HEALTH_RETRIES
- See Also:
-
SERIALIZED_NAME_HEALTH_START_PERIOD
- See Also:
-
SERIALIZED_NAME_HEALTH_STARTUP_CMD
- See Also:
-
SERIALIZED_NAME_HEALTH_STARTUP_INTERVAL
- See Also:
-
SERIALIZED_NAME_HEALTH_STARTUP_RETRIES
- See Also:
-
SERIALIZED_NAME_HEALTH_STARTUP_SUCCESS
- See Also:
-
SERIALIZED_NAME_HEALTH_STARTUP_TIMEOUT
- See Also:
-
SERIALIZED_NAME_HEALTH_TIMEOUT
- See Also:
-
SERIALIZED_NAME_NO_HEALTHCHECK
- See Also:
-
openapiFields
-
openapiRequiredFields
-
-
Constructor Details
-
UpdateHealthCheckConfig
public UpdateHealthCheckConfig()
-
-
Method Details
-
healthCmd
-
getHealthCmd
HealthCmd set a healthcheck command for the container. ('none' disables the existing healthcheck)- Returns:
- healthCmd
-
setHealthCmd
-
healthInterval
-
getHealthInterval
HealthInterval set an interval for the healthcheck. (a value of disable results in no automatic timer setup) Changing this setting resets timer.- Returns:
- healthInterval
-
setHealthInterval
-
healthLogDestination
-
getHealthLogDestination
HealthLogDestination set the destination of the HealthCheck log. Directory path, local or events_logger (local use container state file) Warning: Changing this setting may cause the loss of previous logs!- Returns:
- healthLogDestination
-
setHealthLogDestination
-
healthMaxLogCount
-
getHealthMaxLogCount
HealthMaxLogCount set maximum number of attempts in the HealthCheck log file. ('0' value means an infinite number of attempts in the log file)- Returns:
- healthMaxLogCount
-
setHealthMaxLogCount
-
healthMaxLogSize
-
getHealthMaxLogSize
HealthMaxLogSize set maximum length in characters of stored HealthCheck log. ('0' value means an infinite log length)- Returns:
- healthMaxLogSize
-
setHealthMaxLogSize
-
healthOnFailure
-
getHealthOnFailure
HealthOnFailure set the action to take once the container turns unhealthy.- Returns:
- healthOnFailure
-
setHealthOnFailure
-
healthRetries
-
getHealthRetries
HealthRetries set the number of retries allowed before a healthcheck is considered to be unhealthy.- Returns:
- healthRetries
-
setHealthRetries
-
healthStartPeriod
-
getHealthStartPeriod
HealthStartPeriod set the initialization time needed for a container to bootstrap.- Returns:
- healthStartPeriod
-
setHealthStartPeriod
-
healthStartupCmd
-
getHealthStartupCmd
HealthStartupCmd set a startup healthcheck command for the container.- Returns:
- healthStartupCmd
-
setHealthStartupCmd
-
healthStartupInterval
-
getHealthStartupInterval
HealthStartupInterval set an interval for the startup healthcheck. Changing this setting resets the timer, depending on the state of the container.- Returns:
- healthStartupInterval
-
setHealthStartupInterval
-
healthStartupRetries
-
getHealthStartupRetries
HealthStartupRetries set the maximum number of retries before the startup healthcheck will restart the container.- Returns:
- healthStartupRetries
-
setHealthStartupRetries
-
healthStartupSuccess
-
getHealthStartupSuccess
HealthStartupSuccess set the number of consecutive successes before the startup healthcheck is marked as successful and the normal healthcheck begins (0 indicates any success will start the regular healthcheck)- Returns:
- healthStartupSuccess
-
setHealthStartupSuccess
-
healthStartupTimeout
-
getHealthStartupTimeout
HealthStartupTimeout set the maximum amount of time that the startup healthcheck may take before it is considered failed.- Returns:
- healthStartupTimeout
-
setHealthStartupTimeout
-
healthTimeout
-
getHealthTimeout
HealthTimeout set the maximum time allowed to complete the healthcheck before an interval is considered failed.- Returns:
- healthTimeout
-
setHealthTimeout
-
noHealthcheck
-
getNoHealthcheck
Disable healthchecks on container.- Returns:
- noHealthcheck
-
setNoHealthcheck
-
equals
-
hashCode
public int hashCode() -
toString
-
validateJsonObject
Validates the JSON Object and throws an exception if issues found- Parameters:
jsonObj- JSON Object- Throws:
IOException- if the JSON Object is invalid with respect to UpdateHealthCheckConfig
-
fromJson
Create an instance of UpdateHealthCheckConfig given an JSON string- Parameters:
jsonString- JSON string- Returns:
- An instance of UpdateHealthCheckConfig
- Throws:
IOException- if the JSON string is invalid with respect to UpdateHealthCheckConfig
-
toJson
Convert an instance of UpdateHealthCheckConfig to an JSON string- Returns:
- JSON string
-