com.amazonaws.services.elasticloadbalancingv2.model

Class TargetHealth

java.lang.Object

com.amazonaws.services.elasticloadbalancingv2.model.TargetHealth

All Implemented Interfaces:

Serializable, Cloneable

public class TargetHealth
extends Object
implements Serializable, Cloneable

Information about the current health of a target.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
TargetHealth()

Method Summary

Modifier and Type	Method and Description
TargetHealth	clone()
boolean	equals(Object obj)
String	getDescription() A description of the target health that provides additional details.
String	getReason() The reason code.
String	getState() The state of the target.
int	hashCode()
void	setDescription(String description) A description of the target health that provides additional details.
void	setReason(String reason) The reason code.
void	setReason(TargetHealthReasonEnum reason) The reason code.
void	setState(String state) The state of the target.
void	setState(TargetHealthStateEnum state) The state of the target.
String	toString() Returns a string representation of this object; useful for testing and debugging.
TargetHealth	withDescription(String description) A description of the target health that provides additional details.
TargetHealth	withReason(String reason) The reason code.
TargetHealth	withReason(TargetHealthReasonEnum reason) The reason code.
TargetHealth	withState(String state) The state of the target.
TargetHealth	withState(TargetHealthStateEnum state) The state of the target.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

TargetHealth

public TargetHealth()

Method Detail

setState

public void setState(String state)

The state of the target.

Parameters:

state - The state of the target.

See Also:

TargetHealthStateEnum

getState

public String getState()

The state of the target.

Returns:

The state of the target.

See Also:

TargetHealthStateEnum

withState

public TargetHealth withState(String state)

The state of the target.

Parameters:

state - The state of the target.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

TargetHealthStateEnum

setState

public void setState(TargetHealthStateEnum state)

The state of the target.

Parameters:

state - The state of the target.

See Also:

TargetHealthStateEnum

withState

public TargetHealth withState(TargetHealthStateEnum state)

The state of the target.

Parameters:

state - The state of the target.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

TargetHealthStateEnum

setReason

public void setReason(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.

Parameters:

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.

See Also:

TargetHealthReasonEnum

getReason

public String getReason()

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

withReason

public TargetHealth withReason(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

See Also:

TargetHealthReasonEnum

setReason

public void setReason(TargetHealthReasonEnum 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.

Parameters:

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.

See Also:

TargetHealthReasonEnum

withReason

public TargetHealth withReason(TargetHealthReasonEnum 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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

See Also:

TargetHealthReasonEnum

setDescription

public void setDescription(String description)

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

Parameters:

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

getDescription

public String getDescription()

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.

withDescription

public TargetHealth withDescription(String description)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public TargetHealth clone()

Overrides:

clone in class Object