Package software.amazon.awssdk.services.elasticloadbalancing.model

Class InstanceState

java.lang.Object

software.amazon.awssdk.services.elasticloadbalancing.model.InstanceState

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<InstanceState.Builder,InstanceState>

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

Information about the state of an EC2 instance.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	InstanceState.Builder

Method Summary

Modifier and Type	Method	Description
static InstanceState.Builder	builder()
String	description()	A description of the instance state.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	instanceId()	The ID of the instance.
String	reasonCode()	Information about the cause of OutOfService instances.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends InstanceState.Builder>	serializableBuilderClass()
String	state()	The current state of the instance.
InstanceState.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

instanceId

public final String instanceId()

The ID of the instance.

Returns:

The ID of the instance.

state

public final String state()

The current state of the instance.

Valid values: InService | OutOfService | Unknown

Returns:

The current state of the instance.

Valid values: InService | OutOfService | Unknown

reasonCode

public final String reasonCode()

Information about the cause of OutOfService instances. Specifically, whether the cause is Elastic Load Balancing or the instance.

Valid values: ELB | Instance | N/A

Returns:

Information about the cause of OutOfService instances. Specifically, whether the cause is Elastic Load Balancing or the instance.

Valid values: ELB | Instance | N/A

description

public final String description()

A description of the instance state. This string can contain one or more of the following messages.

• N/A

• A transient error occurred. Please try again later.

• Instance has failed at least the UnhealthyThreshold number of health checks consecutively.

• Instance has not passed the configured HealthyThreshold number of health checks consecutively.

• Instance registration is still in progress.

• Instance is in the EC2 Availability Zone for which LoadBalancer is not configured to route traffic to.

• Instance is not currently registered with the LoadBalancer.

• Instance deregistration currently in progress.

• Disable Availability Zone is currently in progress.

• Instance is in pending state.

• Instance is in stopped state.

• Instance is in terminated state.

Returns:

A description of the instance state. This string can contain one or more of the following messages.

• N/A

• A transient error occurred. Please try again later.

• Instance has failed at least the UnhealthyThreshold number of health checks consecutively.

• Instance has not passed the configured HealthyThreshold number of health checks consecutively.

• Instance registration is still in progress.

• Instance is in the EC2 Availability Zone for which LoadBalancer is not configured to route traffic to.

• Instance is not currently registered with the LoadBalancer.

• Instance deregistration currently in progress.

• Disable Availability Zone is currently in progress.

• Instance is in pending state.

• Instance is in stopped state.

• Instance is in terminated state.

toBuilder

public InstanceState.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<InstanceState.Builder,InstanceState>

builder

public static InstanceState.Builder builder()

serializableBuilderClass

public static Class<? extends InstanceState.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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo