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:

  • Method Details

    • 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()
      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<InstanceState.Builder,InstanceState>
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an 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.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.