@Generated(value="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.
Modifier and Type | Class and Description |
---|---|
static interface |
InstanceHealthSummary.Builder |
Modifier and Type | Method and Description |
---|---|
static InstanceHealthSummary.Builder |
builder() |
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj)
Indicates whether some other object is "equal to" this one by SDK fields.
|
<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()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString()
Returns a string representation of this object.
|
copy
public final String instanceName()
The name of the Lightsail instance for which you are requesting health check data.
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()
.
InstanceHealthState
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()
.
InstanceHealthState
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()
.
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.
InstanceHealthReason
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()
.
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.
InstanceHealthReason
public InstanceHealthSummary.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<InstanceHealthSummary.Builder,InstanceHealthSummary>
public static InstanceHealthSummary.Builder builder()
public static Class<? extends InstanceHealthSummary.Builder> serializableBuilderClass()
public final boolean equalsBySdkFields(Object obj)
SdkPojo
SdkPojo
class,
and is generated based on a service model.
If an SdkPojo
class does not have any inherited fields, equalsBySdkFields
and equals
are essentially the same.
equalsBySdkFields
in interface SdkPojo
obj
- the object to be compared withpublic final String toString()