software.amazon.awssdk.services.securityhub.model

Class AwsEcsTaskDefinitionContainerDefinitionsHealthCheckDetails

java.lang.Object

software.amazon.awssdk.services.securityhub.model.AwsEcsTaskDefinitionContainerDefinitionsHealthCheckDetails

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<AwsEcsTaskDefinitionContainerDefinitionsHealthCheckDetails.Builder,AwsEcsTaskDefinitionContainerDefinitionsHealthCheckDetails>

@Generated(value="software.amazon.awssdk:codegen")
public final class AwsEcsTaskDefinitionContainerDefinitionsHealthCheckDetails
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<AwsEcsTaskDefinitionContainerDefinitionsHealthCheckDetails.Builder,AwsEcsTaskDefinitionContainerDefinitionsHealthCheckDetails>

The container health check command and associated configuration parameters for the container.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AwsEcsTaskDefinitionContainerDefinitionsHealthCheckDetails.Builder

Method Summary

Modifier and Type	Method and Description
static AwsEcsTaskDefinitionContainerDefinitionsHealthCheckDetails.Builder	builder()
List<String>	command() The command that the container runs to determine whether it is healthy.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasCommand() For responses, this returns true if the service returned a value for the Command property.
int	hashCode()
Integer	interval() The time period in seconds between each health check execution.
Integer	retries() The number of times to retry a failed health check before the container is considered unhealthy.
List<SdkField<?>>	sdkFields()
static Class<? extends AwsEcsTaskDefinitionContainerDefinitionsHealthCheckDetails.Builder>	serializableBuilderClass()
Integer	startPeriod() The optional grace period in seconds that allows containers time to bootstrap before failed health checks count towards the maximum number of retries.
Integer	timeout() The time period in seconds to wait for a health check to succeed before it is considered a failure.
AwsEcsTaskDefinitionContainerDefinitionsHealthCheckDetails.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

hasCommand

public final boolean hasCommand()

For responses, this returns true if the service returned a value for the Command property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

command

public final List<String> command()

The command that the container runs to determine whether it is healthy.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasCommand() method.

Returns:

The command that the container runs to determine whether it is healthy.

interval

public final Integer interval()

The time period in seconds between each health check execution. The default value is 30 seconds.

Returns:

The time period in seconds between each health check execution. The default value is 30 seconds.

retries

public final Integer retries()

The number of times to retry a failed health check before the container is considered unhealthy. The default value is 3.

Returns:

The number of times to retry a failed health check before the container is considered unhealthy. The default value is 3.

startPeriod

public final Integer startPeriod()

The optional grace period in seconds that allows containers time to bootstrap before failed health checks count towards the maximum number of retries.

Returns:

The optional grace period in seconds that allows containers time to bootstrap before failed health checks count towards the maximum number of retries.

timeout

public final Integer timeout()

The time period in seconds to wait for a health check to succeed before it is considered a failure. The default value is 5.

Returns:

The time period in seconds to wait for a health check to succeed before it is considered a failure. The default value is 5.

toBuilder

public AwsEcsTaskDefinitionContainerDefinitionsHealthCheckDetails.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AwsEcsTaskDefinitionContainerDefinitionsHealthCheckDetails.Builder,AwsEcsTaskDefinitionContainerDefinitionsHealthCheckDetails>

builder

public static AwsEcsTaskDefinitionContainerDefinitionsHealthCheckDetails.Builder builder()

serializableBuilderClass

public static Class<? extends AwsEcsTaskDefinitionContainerDefinitionsHealthCheckDetails.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo