TargetHealth (AWS Java SDK :: Services :: Elastic Load Balancing V2 2.20.28 API)

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)`
`boolean`	`equalsBySdkFields(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()`
`String`	`toString()` Returns a string representation of this object.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

- Method Detail
  - state
```
public final 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 final 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 final 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.
    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. 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
  - reasonAsString
```
public final 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. 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.
    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. 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
  - description
```
public final 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()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<TargetHealth.Builder,TargetHealth>
  - builder
```
public static TargetHealth.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends TargetHealth.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final 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
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

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

equalsBySdkFields

toString

getValueForField

sdkFields