Package software.amazon.awssdk.services.elasticloadbalancingv2.model

Class TargetHealth

java.lang.Object

software.amazon.awssdk.services.elasticloadbalancingv2.model.TargetHealth

All Implemented Interfaces:

ToCopyableBuilder<TargetHealth.Builder,TargetHealth>

@Generated("software.amazon.awssdk:codegen")
public class TargetHealth
extends Object
implements ToCopyableBuilder<TargetHealth.Builder,TargetHealth>

Information about the current health of a target.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	TargetHealth.Builder

Method Summary

Modifier and Type	Method	Description
static TargetHealth.Builder	builder()
String	description()	A description of the target health that provides additional details.
boolean	equals(Object obj)
int	hashCode()
String	reason()	The reason code.
static Class<? extends TargetHealth.Builder>	serializableBuilderClass()
String	state()	The state of the target.
TargetHealth.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

state

public String state()

The state of the target.

Returns:

The state of the target.

See Also:

TargetHealthStateEnum

reason

public String reason()

The reason code. If the target state is healthy, a reason code is not provided.

If the target state is initial, the reason code can be one of the following values:

• Elb.RegistrationInProgress - The target is in the process of being registered with the load balancer.

• Elb.InitialHealthChecking - The load balancer is still sending the target the minimum number of health checks required to determine its health status.

If the target state is unhealthy, the reason code can be one of the following values:

• Target.ResponseCodeMismatch - The health checks did not return an expected HTTP code.

• Target.Timeout - The health check requests timed out.

• Target.FailedHealthChecks - The health checks failed because the connection to the target timed out, the target response was malformed, or the target failed the health check for an unknown reason.

• Elb.InternalError - The health checks failed due to an internal error.

If the target state is unused, the reason code can be one of the following values:

• Target.NotRegistered - The target is not registered with the target group.

• Target.NotInUse - The target group is not used by any load balancer or the target is in an Availability Zone that is not enabled for its load balancer.

• Target.InvalidState - The target is in the stopped or terminated state.

If the target state is draining, the reason code can be the following value:

• Target.DeregistrationInProgress - The target is in the process of being deregistered and the deregistration delay period has not expired.

Returns:

The reason code. If the target state is healthy, a reason code is not provided.

If the target state is initial, the reason code can be one of the following values:

• Elb.RegistrationInProgress - The target is in the process of being registered with the load balancer.

• Elb.InitialHealthChecking - The load balancer is still sending the target the minimum number of health checks required to determine its health status.

If the target state is unhealthy, the reason code can be one of the following values:

• Target.ResponseCodeMismatch - The health checks did not return an expected HTTP code.

• Target.Timeout - The health check requests timed out.

• Target.FailedHealthChecks - The health checks failed because the connection to the target timed out, the target response was malformed, or the target failed the health check for an unknown reason.

• Elb.InternalError - The health checks failed due to an internal error.

If the target state is unused, the reason code can be one of the following values:

• Target.NotRegistered - The target is not registered with the target group.

• Target.NotInUse - The target group is not used by any load balancer or the target is in an Availability Zone that is not enabled for its load balancer.

• Target.InvalidState - The target is in the stopped or terminated state.

If the target state is draining, the reason code can be the following value:

• Target.DeregistrationInProgress - The target is in the process of being deregistered and the deregistration delay period has not expired.

See Also:

TargetHealthReasonEnum

description

public String description()

A description of the target health that provides additional details. If the state is healthy, a description is not provided.

Returns:

A description of the target health that provides additional details. If the state is healthy , a description is not provided.

toBuilder

public TargetHealth.Builder 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 interface ToCopyableBuilder<TargetHealth.Builder,TargetHealth>

Returns:

a builder for type T

builder

public static TargetHealth.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object