TargetHealth (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.elasticloadbalancingv2.model.TargetHealth

All Implemented Interfaces:

Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class TargetHealth
extends Object
implements Serializable, Cloneable
```
Information about the current health of a target.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

TargetHealth()

Constructors
Constructor and Description
`TargetHealth()`

Method Summary

All Methods Instance Methods Concrete Methods
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.
`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. Applies only to Application Load Balancers and Gateway Load Balancers.
    - Target.Timeout - The health check requests timed out. Applies only to Application Load Balancers and Gateway Load Balancers.
    - Target.FailedHealthChecks - The load balancer received an error while establishing a connection to the target or the target response was malformed.
    - Elb.InternalError - The health checks failed due to an internal error. Applies only to Application Load Balancers.
    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.
    - Target.IpUnusable - The target IP address is reserved for use by a load balancer.
    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.
    If the target state is unavailable, the reason code can be the following value:
    - Target.HealthCheckDisabled - Health checks are disabled for the target group. Applies only to Application Load Balancers.
    - Elb.InternalError - Target health is unavailable due to an internal error. Applies only to Network Load Balancers.
    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. Applies only to Application Load Balancers and Gateway Load Balancers.
    
    Target.Timeout - The health check requests timed out. Applies only to Application Load Balancers and Gateway Load Balancers.
    
    Target.FailedHealthChecks - The load balancer received an error while establishing a connection to the target or the target response was malformed.
    
    Elb.InternalError - The health checks failed due to an internal error. Applies only to Application Load Balancers.
    
    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.
    
    Target.IpUnusable - The target IP address is reserved for use by a load balancer.
    
    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.
    
    If the target state is unavailable, the reason code can be the following value:
    
    Target.HealthCheckDisabled - Health checks are disabled for the target group. Applies only to Application Load Balancers.
    
    Elb.InternalError - Target health is unavailable due to an internal error. Applies only to Network Load Balancers.
    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. Applies only to Application Load Balancers and Gateway Load Balancers.
    - Target.Timeout - The health check requests timed out. Applies only to Application Load Balancers and Gateway Load Balancers.
    - Target.FailedHealthChecks - The load balancer received an error while establishing a connection to the target or the target response was malformed.
    - Elb.InternalError - The health checks failed due to an internal error. Applies only to Application Load Balancers.
    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.
    - Target.IpUnusable - The target IP address is reserved for use by a load balancer.
    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.
    If the target state is unavailable, the reason code can be the following value:
    - Target.HealthCheckDisabled - Health checks are disabled for the target group. Applies only to Application Load Balancers.
    - Elb.InternalError - Target health is unavailable due to an internal error. Applies only to Network Load Balancers.
    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. Applies only to Application Load Balancers and Gateway Load Balancers.
    
    Target.Timeout - The health check requests timed out. Applies only to Application Load Balancers and Gateway Load Balancers.
    
    Target.FailedHealthChecks - The load balancer received an error while establishing a connection to the target or the target response was malformed.
    
    Elb.InternalError - The health checks failed due to an internal error. Applies only to Application Load Balancers.
    
    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.
    
    Target.IpUnusable - The target IP address is reserved for use by a load balancer.
    
    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.
    
    If the target state is unavailable, the reason code can be the following value:
    
    Target.HealthCheckDisabled - Health checks are disabled for the target group. Applies only to Application Load Balancers.
    
    Elb.InternalError - Target health is unavailable due to an internal error. Applies only to Network Load Balancers.
    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. Applies only to Application Load Balancers and Gateway Load Balancers.
    - Target.Timeout - The health check requests timed out. Applies only to Application Load Balancers and Gateway Load Balancers.
    - Target.FailedHealthChecks - The load balancer received an error while establishing a connection to the target or the target response was malformed.
    - Elb.InternalError - The health checks failed due to an internal error. Applies only to Application Load Balancers.
    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.
    - Target.IpUnusable - The target IP address is reserved for use by a load balancer.
    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.
    If the target state is unavailable, the reason code can be the following value:
    - Target.HealthCheckDisabled - Health checks are disabled for the target group. Applies only to Application Load Balancers.
    - Elb.InternalError - Target health is unavailable due to an internal error. Applies only to Network Load Balancers.
    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. Applies only to Application Load Balancers and Gateway Load Balancers.
    
    Target.Timeout - The health check requests timed out. Applies only to Application Load Balancers and Gateway Load Balancers.
    
    Target.FailedHealthChecks - The load balancer received an error while establishing a connection to the target or the target response was malformed.
    
    Elb.InternalError - The health checks failed due to an internal error. Applies only to Application Load Balancers.
    
    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.
    
    Target.IpUnusable - The target IP address is reserved for use by a load balancer.
    
    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.
    
    If the target state is unavailable, the reason code can be the following value:
    
    Target.HealthCheckDisabled - Health checks are disabled for the target group. Applies only to Application Load Balancers.
    
    Elb.InternalError - Target health is unavailable due to an internal error. Applies only to Network Load Balancers.
    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. Applies only to Application Load Balancers and Gateway Load Balancers.
    - Target.Timeout - The health check requests timed out. Applies only to Application Load Balancers and Gateway Load Balancers.
    - Target.FailedHealthChecks - The load balancer received an error while establishing a connection to the target or the target response was malformed.
    - Elb.InternalError - The health checks failed due to an internal error. Applies only to Application Load Balancers.
    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.
    - Target.IpUnusable - The target IP address is reserved for use by a load balancer.
    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.
    If the target state is unavailable, the reason code can be the following value:
    - Target.HealthCheckDisabled - Health checks are disabled for the target group. Applies only to Application Load Balancers.
    - Elb.InternalError - Target health is unavailable due to an internal error. Applies only to Network Load Balancers.
    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. Applies only to Application Load Balancers and Gateway Load Balancers.
    
    Target.Timeout - The health check requests timed out. Applies only to Application Load Balancers and Gateway Load Balancers.
    
    Target.FailedHealthChecks - The load balancer received an error while establishing a connection to the target or the target response was malformed.
    
    Elb.InternalError - The health checks failed due to an internal error. Applies only to Application Load Balancers.
    
    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.
    
    Target.IpUnusable - The target IP address is reserved for use by a load balancer.
    
    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.
    
    If the target state is unavailable, the reason code can be the following value:
    
    Target.HealthCheckDisabled - Health checks are disabled for the target group. Applies only to Application Load Balancers.
    
    Elb.InternalError - Target health is unavailable due to an internal error. Applies only to Network Load Balancers.
    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. Applies only to Application Load Balancers and Gateway Load Balancers.
    - Target.Timeout - The health check requests timed out. Applies only to Application Load Balancers and Gateway Load Balancers.
    - Target.FailedHealthChecks - The load balancer received an error while establishing a connection to the target or the target response was malformed.
    - Elb.InternalError - The health checks failed due to an internal error. Applies only to Application Load Balancers.
    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.
    - Target.IpUnusable - The target IP address is reserved for use by a load balancer.
    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.
    If the target state is unavailable, the reason code can be the following value:
    - Target.HealthCheckDisabled - Health checks are disabled for the target group. Applies only to Application Load Balancers.
    - Elb.InternalError - Target health is unavailable due to an internal error. Applies only to Network Load Balancers.
    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. Applies only to Application Load Balancers and Gateway Load Balancers.
    
    Target.Timeout - The health check requests timed out. Applies only to Application Load Balancers and Gateway Load Balancers.
    
    Target.FailedHealthChecks - The load balancer received an error while establishing a connection to the target or the target response was malformed.
    
    Elb.InternalError - The health checks failed due to an internal error. Applies only to Application Load Balancers.
    
    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.
    
    Target.IpUnusable - The target IP address is reserved for use by a load balancer.
    
    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.
    
    If the target state is unavailable, the reason code can be the following value:
    
    Target.HealthCheckDisabled - Health checks are disabled for the target group. Applies only to Application Load Balancers.
    
    Elb.InternalError - Target health is unavailable due to an internal error. Applies only to Network Load Balancers.
    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. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    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

AWS SDK for Java 1.x API Reference - 1.12.619

Class TargetHealth

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TargetHealth

Method Detail

setState

getState

withState

setState

withState

setReason

getReason

withReason

setReason

withReason

setDescription

getDescription

withDescription

toString

equals

hashCode

clone