software.amazon.awssdk.services.elasticbeanstalk.model

Class SingleInstanceHealth

java.lang.Object

software.amazon.awssdk.services.elasticbeanstalk.model.SingleInstanceHealth

All Implemented Interfaces:

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

@Generated(value="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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SingleInstanceHealth.Builder

Method Summary

Modifier and Type	Method and Description
ApplicationMetrics	applicationMetrics() Request metrics from your application.
String	availabilityZone() The availability zone in which the instance runs.
static SingleInstanceHealth.Builder	builder()
List<String>	causes() Represents the causes, which provide more information about the current health status.
String	color() Represents the color indicator that gives you information about the health of the EC2 instance.
Deployment	deployment() Information about the most recent deployment to an instance.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasCauses() For responses, this returns true if the service returned a value for the Causes property.
int	hashCode()
String	healthStatus() Returns the health status of the specified instance.
String	instanceId() The ID of the Amazon EC2 instance.
String	instanceType() The instance's type.
Instant	launchedAt() The time at which the EC2 instance was launched.
List<SdkField<?>>	sdkFields()
static Class<? extends SingleInstanceHealth.Builder>	serializableBuilderClass()
SystemStatus	system() Operating system metrics from the instance.
SingleInstanceHealth.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 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()

Specified by:

toBuilder in interface ToCopyableBuilder<SingleInstanceHealth.Builder,SingleInstanceHealth>

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)

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