TargetHealth (AWS SDK for Java

java.lang.Object
- software.amazon.awssdk.services.elasticloadbalancingv2.model.TargetHealth

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<TargetHealth.Builder,TargetHealth>

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

Information about the current health of a target.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface TargetHealth.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`TargetHealth.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static TargetHealth.Builder`	`builder()`
`String`	`description()` A description of the target health that provides additional details.
`boolean`	`equals(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`TargetHealthReasonEnum`	`reason()` The reason code.
`String`	`reasonAsString()` The reason code.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends TargetHealth.Builder>`	`serializableBuilderClass()`
`TargetHealthStateEnum`	`state()` The state of the target.
`String`	`stateAsString()` 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

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

- Method Detail
  - state
```
public TargetHealthStateEnum state()
```
    The state of the target.
    
    If the service returns an enum value that is not available in the current SDK version, state will return TargetHealthStateEnum.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().
    
    Returns:
    
    The state of the target.
    
    See Also:
    
    TargetHealthStateEnum
  - stateAsString
```
public String stateAsString()
```
    The state of the target.
    
    If the service returns an enum value that is not available in the current SDK version, state will return TargetHealthStateEnum.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().
    
    Returns:
    
    The state of the target.
    
    See Also:
    
    TargetHealthStateEnum
  - reason
```
public 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.IpUnusable - The target IP address is reserved for use by a 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.
    If the target state is unavailable, the reason code can be the following value:
    - Target.HealthCheckDisabled - Health checks are disabled for the target group.
    If the service returns an enum value that is not available in the current SDK version, reason will return TargetHealthReasonEnum.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from reasonAsString().
    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.IpUnusable - The target IP address is reserved for use by a 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.
    
    If the target state is unavailable, the reason code can be the following value:
    
    Target.HealthCheckDisabled - Health checks are disabled for the target group.
    See Also:
    
    TargetHealthReasonEnum
  - reasonAsString
```
public String reasonAsString()
```
    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.IpUnusable - The target IP address is reserved for use by a 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.
    If the target state is unavailable, the reason code can be the following value:
    - Target.HealthCheckDisabled - Health checks are disabled for the target group.
    If the service returns an enum value that is not available in the current SDK version, reason will return TargetHealthReasonEnum.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from reasonAsString().
    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.IpUnusable - The target IP address is reserved for use by a 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.
    
    If the target state is unavailable, the reason code can be the following value:
    
    Target.HealthCheckDisabled - Health checks are disabled for the target group.
    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
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
    
    Returns:
    
    List of SdkField in this POJO. May be empty list but should never be null.

Class TargetHealth

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

state

stateAsString

reason

reasonAsString

description

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField

sdkFields