Class AwsEcsTaskDefinitionContainerDefinitionsHealthCheckDetails
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<AwsEcsTaskDefinitionContainerDefinitionsHealthCheckDetails.Builder,
AwsEcsTaskDefinitionContainerDefinitionsHealthCheckDetails>
The container health check command and associated configuration parameters for the container.
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic interface
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
command()
The command that the container runs to determine whether it is healthy.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the Command property.final int
hashCode()
final Integer
interval()
The time period in seconds between each health check execution.final Integer
retries()
The number of times to retry a failed health check before the container is considered unhealthy.static Class
<? extends AwsEcsTaskDefinitionContainerDefinitionsHealthCheckDetails.Builder> final Integer
The optional grace period in seconds that allows containers time to bootstrap before failed health checks count towards the maximum number of retries.final Integer
timeout()
The time period in seconds to wait for a health check to succeed before it is considered a failure.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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 theisEmpty()
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
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
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
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
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
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
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<AwsEcsTaskDefinitionContainerDefinitionsHealthCheckDetails.Builder,
AwsEcsTaskDefinitionContainerDefinitionsHealthCheckDetails> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
public static Class<? extends AwsEcsTaskDefinitionContainerDefinitionsHealthCheckDetails.Builder> serializableBuilderClass() -
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-