Class InstanceState

java.lang.Object
software.amazon.awssdk.services.ec2.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>

Describes the current state of an instance.

See Also:

  • Method Details

    • code

      public final Integer code()

      The state of the instance as a 16-bit unsigned integer.

      The high byte is all of the bits between 2^8 and (2^16)-1, which equals decimal values between 256 and 65,535. These numerical values are used for internal purposes and should be ignored.

      The low byte is all of the bits between 2^0 and (2^8)-1, which equals decimal values between 0 and 255.

      The valid values for instance-state-code will all be in the range of the low byte and they are:

      • 0 : pending

      • 16 : running

      • 32 : shutting-down

      • 48 : terminated

      • 64 : stopping

      • 80 : stopped

      You can ignore the high byte value by zeroing out all of the bits above 2^8 or 256 in decimal.

      Returns:
      The state of the instance as a 16-bit unsigned integer.

      The high byte is all of the bits between 2^8 and (2^16)-1, which equals decimal values between 256 and 65,535. These numerical values are used for internal purposes and should be ignored.

      The low byte is all of the bits between 2^0 and (2^8)-1, which equals decimal values between 0 and 255.

      The valid values for instance-state-code will all be in the range of the low byte and they are:

      • 0 : pending

      • 16 : running

      • 32 : shutting-down

      • 48 : terminated

      • 64 : stopping

      • 80 : stopped

      You can ignore the high byte value by zeroing out all of the bits above 2^8 or 256 in decimal.

    • name

      public final InstanceStateName name()

      The current state of the instance.

      If the service returns an enum value that is not available in the current SDK version, name will return InstanceStateName.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from nameAsString().

      Returns:
      The current state of the instance.
      See Also:

    • nameAsString

      public final String nameAsString()

      The current state of the instance.

      If the service returns an enum value that is not available in the current SDK version, name will return InstanceStateName.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from nameAsString().

      Returns:
      The current state of the instance.
      See Also:

    • 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.