Class InstanceStatus

java.lang.Object
software.amazon.awssdk.services.ec2.model.InstanceStatus
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<InstanceStatus.Builder,InstanceStatus>
@Generated("software.amazon.awssdk:codegen") public final class InstanceStatus extends Object implements SdkPojo, Serializable, ToCopyableBuilder<InstanceStatus.Builder,InstanceStatus>

Describes the status of an instance.

See Also:

  • Method Details

    • availabilityZone

      public final String availabilityZone()

      The Availability Zone of the instance.

      Returns:
      The Availability Zone of the instance.

    • availabilityZoneId

      public final String availabilityZoneId()

      The ID of the Availability Zone of the instance.

      Returns:
      The ID of the Availability Zone of the instance.

    • outpostArn

      public final String outpostArn()

      The Amazon Resource Name (ARN) of the Outpost.

      Returns:
      The Amazon Resource Name (ARN) of the Outpost.

    • operator

      public final OperatorResponse operator()

      The service provider that manages the instance.

      Returns:
      The service provider that manages the instance.

    • hasEvents

      public final boolean hasEvents()
      For responses, this returns true if the service returned a value for the Events property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • events

      public final List<InstanceStatusEvent> events()

      Any scheduled events associated with the instance.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasEvents() method.

      Returns:
      Any scheduled events associated with the instance.

    • instanceId

      public final String instanceId()

      The ID of the instance.

      Returns:
      The ID of the instance.

    • instanceState

      public final InstanceState instanceState()

      The intended state of the instance. DescribeInstanceStatus requires that an instance be in the running state.

      Returns:
      The intended state of the instance. DescribeInstanceStatus requires that an instance be in the running state.

    • instanceStatus

      public final InstanceStatusSummary instanceStatus()

      Reports impaired functionality that stems from issues internal to the instance, such as impaired reachability.

      Returns:
      Reports impaired functionality that stems from issues internal to the instance, such as impaired reachability.

    • systemStatus

      public final InstanceStatusSummary systemStatus()

      Reports impaired functionality that stems from issues related to the systems that support an instance, such as hardware failures and network connectivity problems.

      Returns:
      Reports impaired functionality that stems from issues related to the systems that support an instance, such as hardware failures and network connectivity problems.

    • attachedEbsStatus

      public final EbsStatusSummary attachedEbsStatus()

      Reports impaired functionality that stems from an attached Amazon EBS volume that is unreachable and unable to complete I/O operations.

      Returns:
      Reports impaired functionality that stems from an attached Amazon EBS volume that is unreachable and unable to complete I/O operations.

    • toBuilder

      public InstanceStatus.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<InstanceStatus.Builder,InstanceStatus>
      Returns:
      a builder for type T

    • builder

      public static InstanceStatus.Builder builder()

    • serializableBuilderClass

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