java.lang.Object
- software.amazon.awssdk.services.lightsail.model.InstanceHealthSummary

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

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

Describes information about the health of the instance.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface InstanceHealthSummary.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static InstanceHealthSummary.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`InstanceHealthState`	`instanceHealth()`	Describes the overall instance health.
`String`	`instanceHealthAsString()`	Describes the overall instance health.
`InstanceHealthReason`	`instanceHealthReason()`	More information about the instance health.
`String`	`instanceHealthReasonAsString()`	More information about the instance health.
`String`	`instanceName()`	The name of the Lightsail instance for which you are requesting health check data.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends InstanceHealthSummary.Builder>`	`serializableBuilderClass()`
`InstanceHealthSummary.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
  - instanceName
```
public final String instanceName()
```
    The name of the Lightsail instance for which you are requesting health check data.
    
    Returns:
    
    The name of the Lightsail instance for which you are requesting health check data.
  - instanceHealth
```
public final InstanceHealthState instanceHealth()
```
    Describes the overall instance health. Valid values are below.
    
    If the service returns an enum value that is not available in the current SDK version, instanceHealth will return InstanceHealthState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from instanceHealthAsString().
    
    Returns:
    
    Describes the overall instance health. Valid values are below.
    
    See Also:
    
    InstanceHealthState
  - instanceHealthAsString
```
public final String instanceHealthAsString()
```
    Describes the overall instance health. Valid values are below.
    
    If the service returns an enum value that is not available in the current SDK version, instanceHealth will return InstanceHealthState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from instanceHealthAsString().
    
    Returns:
    
    Describes the overall instance health. Valid values are below.
    
    See Also:
    
    InstanceHealthState
  - instanceHealthReason
```
public final InstanceHealthReason instanceHealthReason()
```
    More information about the instance health. If the instanceHealth is healthy, then an instanceHealthReason value is not provided.
    
    If instanceHealth is initial, the instanceHealthReason value can be one of the following:
    
    Lb.RegistrationInProgress - The target instance is in the process of being registered with the load balancer.
    
    Lb.InitialHealthChecking - The Lightsail load balancer is still sending the target instance the minimum number of health checks required to determine its health status.
    
    If instanceHealth is unhealthy, the instanceHealthReason value can be one of the following:
    
    Instance.ResponseCodeMismatch - The health checks did not return an expected HTTP code.
    
    Instance.Timeout - The health check requests timed out.
    
    Instance.FailedHealthChecks - The health checks failed because the connection to the target instance timed out, the target instance response was malformed, or the target instance failed the health check for an unknown reason.
    
    Lb.InternalError - The health checks failed due to an internal error.
    
    If instanceHealth is unused, the instanceHealthReason value can be one of the following:
    
    Instance.NotRegistered - The target instance is not registered with the target group.
    
    Instance.NotInUse - The target group is not used by any load balancer, or the target instance is in an Availability Zone that is not enabled for its load balancer.
    
    Instance.IpUnusable - The target IP address is reserved for use by a Lightsail load balancer.
    
    Instance.InvalidState - The target is in the stopped or terminated state.
    
    If instanceHealth is draining, the instanceHealthReason value can be one of the following:
    
    Instance.DeregistrationInProgress - The target instance is in the process of being deregistered and the deregistration delay period has not expired.
    
    If the service returns an enum value that is not available in the current SDK version, instanceHealthReason will return InstanceHealthReason.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from instanceHealthReasonAsString().
    Returns:
    
    More information about the instance health. If the instanceHealth is healthy, then an instanceHealthReason value is not provided.
    
    If instanceHealth is initial, the instanceHealthReason value can be one of the following:
    
    Lb.RegistrationInProgress - The target instance is in the process of being registered with the load balancer.
    
    Lb.InitialHealthChecking - The Lightsail load balancer is still sending the target instance the minimum number of health checks required to determine its health status.
    
    If instanceHealth is unhealthy, the instanceHealthReason value can be one of the following:
    
    Instance.ResponseCodeMismatch - The health checks did not return an expected HTTP code.
    
    Instance.Timeout - The health check requests timed out.
    
    Instance.FailedHealthChecks - The health checks failed because the connection to the target instance timed out, the target instance response was malformed, or the target instance failed the health check for an unknown reason.
    
    Lb.InternalError - The health checks failed due to an internal error.
    
    If instanceHealth is unused, the instanceHealthReason value can be one of the following:
    
    Instance.NotRegistered - The target instance is not registered with the target group.
    
    Instance.NotInUse - The target group is not used by any load balancer, or the target instance is in an Availability Zone that is not enabled for its load balancer.
    
    Instance.IpUnusable - The target IP address is reserved for use by a Lightsail load balancer.
    
    Instance.InvalidState - The target is in the stopped or terminated state.
    
    If instanceHealth is draining, the instanceHealthReason value can be one of the following:
    
    Instance.DeregistrationInProgress - The target instance is in the process of being deregistered and the deregistration delay period has not expired.
    
    See Also:
    
    InstanceHealthReason
  - instanceHealthReasonAsString
```
public final String instanceHealthReasonAsString()
```
    More information about the instance health. If the instanceHealth is healthy, then an instanceHealthReason value is not provided.
    
    If instanceHealth is initial, the instanceHealthReason value can be one of the following:
    
    Lb.RegistrationInProgress - The target instance is in the process of being registered with the load balancer.
    
    Lb.InitialHealthChecking - The Lightsail load balancer is still sending the target instance the minimum number of health checks required to determine its health status.
    
    If instanceHealth is unhealthy, the instanceHealthReason value can be one of the following:
    
    Instance.ResponseCodeMismatch - The health checks did not return an expected HTTP code.
    
    Instance.Timeout - The health check requests timed out.
    
    Instance.FailedHealthChecks - The health checks failed because the connection to the target instance timed out, the target instance response was malformed, or the target instance failed the health check for an unknown reason.
    
    Lb.InternalError - The health checks failed due to an internal error.
    
    If instanceHealth is unused, the instanceHealthReason value can be one of the following:
    
    Instance.NotRegistered - The target instance is not registered with the target group.
    
    Instance.NotInUse - The target group is not used by any load balancer, or the target instance is in an Availability Zone that is not enabled for its load balancer.
    
    Instance.IpUnusable - The target IP address is reserved for use by a Lightsail load balancer.
    
    Instance.InvalidState - The target is in the stopped or terminated state.
    
    If instanceHealth is draining, the instanceHealthReason value can be one of the following:
    
    Instance.DeregistrationInProgress - The target instance is in the process of being deregistered and the deregistration delay period has not expired.
    
    If the service returns an enum value that is not available in the current SDK version, instanceHealthReason will return InstanceHealthReason.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from instanceHealthReasonAsString().
    Returns:
    
    More information about the instance health. If the instanceHealth is healthy, then an instanceHealthReason value is not provided.
    
    If instanceHealth is initial, the instanceHealthReason value can be one of the following:
    
    Lb.RegistrationInProgress - The target instance is in the process of being registered with the load balancer.
    
    Lb.InitialHealthChecking - The Lightsail load balancer is still sending the target instance the minimum number of health checks required to determine its health status.
    
    If instanceHealth is unhealthy, the instanceHealthReason value can be one of the following:
    
    Instance.ResponseCodeMismatch - The health checks did not return an expected HTTP code.
    
    Instance.Timeout - The health check requests timed out.
    
    Instance.FailedHealthChecks - The health checks failed because the connection to the target instance timed out, the target instance response was malformed, or the target instance failed the health check for an unknown reason.
    
    Lb.InternalError - The health checks failed due to an internal error.
    
    If instanceHealth is unused, the instanceHealthReason value can be one of the following:
    
    Instance.NotRegistered - The target instance is not registered with the target group.
    
    Instance.NotInUse - The target group is not used by any load balancer, or the target instance is in an Availability Zone that is not enabled for its load balancer.
    
    Instance.IpUnusable - The target IP address is reserved for use by a Lightsail load balancer.
    
    Instance.InvalidState - The target is in the stopped or terminated state.
    
    If instanceHealth is draining, the instanceHealthReason value can be one of the following:
    
    Instance.DeregistrationInProgress - The target instance is in the process of being deregistered and the deregistration delay period has not expired.
    
    See Also:
    
    InstanceHealthReason
  - toBuilder
```
public InstanceHealthSummary.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<InstanceHealthSummary.Builder,InstanceHealthSummary>
  - builder
```
public static InstanceHealthSummary.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends InstanceHealthSummary.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 InstanceHealthSummary

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

instanceName

instanceHealth

instanceHealthAsString

instanceHealthReason

instanceHealthReasonAsString

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields