Class SingleInstanceHealth

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

Detailed health information about an Amazon EC2 instance in your Elastic Beanstalk environment.

See Also:

  • Method Details

    • instanceId

      public final String instanceId()

      The ID of the Amazon EC2 instance.

      Returns:
      The ID of the Amazon EC2 instance.

    • healthStatus

      public final String healthStatus()

      Returns the health status of the specified instance. For more information, see Health Colors and Statuses.

      Returns:
      Returns the health status of the specified instance. For more information, see Health Colors and Statuses.

    • color

      public final String color()

      Represents the color indicator that gives you information about the health of the EC2 instance. For more information, see Health Colors and Statuses.

      Returns:
      Represents the color indicator that gives you information about the health of the EC2 instance. For more information, see Health Colors and Statuses.

    • hasCauses

      public final boolean hasCauses()
      For responses, this returns true if the service returned a value for the Causes 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.

    • causes

      public final List<String> causes()

      Represents the causes, which provide more information about the current health status.

      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 hasCauses() method.

      Returns:
      Represents the causes, which provide more information about the current health status.

    • launchedAt

      public final Instant launchedAt()

      The time at which the EC2 instance was launched.

      Returns:
      The time at which the EC2 instance was launched.

    • applicationMetrics

      public final ApplicationMetrics applicationMetrics()

      Request metrics from your application.

      Returns:
      Request metrics from your application.

    • system

      public final SystemStatus system()

      Operating system metrics from the instance.

      Returns:
      Operating system metrics from the instance.

    • deployment

      public final Deployment deployment()

      Information about the most recent deployment to an instance.

      Returns:
      Information about the most recent deployment to an instance.

    • availabilityZone

      public final String availabilityZone()

      The availability zone in which the instance runs.

      Returns:
      The availability zone in which the instance runs.

    • instanceType

      public final String instanceType()

      The instance's type.

      Returns:
      The instance's type.

    • toBuilder

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

    • builder

      public static SingleInstanceHealth.Builder builder()

    • serializableBuilderClass

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