Package software.amazon.awssdk.services.elasticbeanstalk.model

Class DescribeEnvironmentHealthResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.elasticbeanstalk.model.ElasticBeanstalkResponse

software.amazon.awssdk.services.elasticbeanstalk.model.DescribeEnvironmentHealthResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeEnvironmentHealthResponse.Builder,DescribeEnvironmentHealthResponse>

@Generated("software.amazon.awssdk:codegen")
public final class DescribeEnvironmentHealthResponse
extends ElasticBeanstalkResponse
implements ToCopyableBuilder<DescribeEnvironmentHealthResponse.Builder,DescribeEnvironmentHealthResponse>

Health details for an AWS Elastic Beanstalk environment.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DescribeEnvironmentHealthResponse.Builder

Method Summary

Modifier and Type	Method	Description
ApplicationMetrics	applicationMetrics()	Application request metrics for the environment.
static DescribeEnvironmentHealthResponse.Builder	builder()
List<String>	causes()	Descriptions of the data that contributed to the environment's current health status.
String	color()	The health color of the environment.
String	environmentName()	The environment's name.
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()	The health status of the environment.
InstanceHealthSummary	instancesHealth()	Summary health information for the instances in the environment.
Instant	refreshedAt()	The date and time that the health information was retrieved.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeEnvironmentHealthResponse.Builder>	serializableBuilderClass()
EnvironmentHealth	status()	The environment's operational status.
String	statusAsString()	The environment's operational status.
DescribeEnvironmentHealthResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.elasticbeanstalk.model.ElasticBeanstalkResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

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

environmentName

public final String environmentName()

The environment's name.

Returns:

The environment's name.

healthStatus

public final String healthStatus()

The health status of the environment. For example, Ok.

Returns:

The health status of the environment. For example, Ok.

status

public final EnvironmentHealth status()

The environment's operational status. Ready, Launching, Updating, Terminating, or Terminated.

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

Returns:

The environment's operational status. Ready, Launching, Updating, Terminating, or Terminated.

See Also:

EnvironmentHealth

statusAsString

public final String statusAsString()

The environment's operational status. Ready, Launching, Updating, Terminating, or Terminated.

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

Returns:

The environment's operational status. Ready, Launching, Updating, Terminating, or Terminated.

See Also:

EnvironmentHealth

color

public final String color()

The health color of the environment.

Returns:

The health color of the environment.

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()

Descriptions of the data that contributed to the environment's 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:

Descriptions of the data that contributed to the environment's current health status.

applicationMetrics

public final ApplicationMetrics applicationMetrics()

Application request metrics for the environment.

Returns:

Application request metrics for the environment.

instancesHealth

public final InstanceHealthSummary instancesHealth()

Summary health information for the instances in the environment.

Returns:

Summary health information for the instances in the environment.

refreshedAt

public final Instant refreshedAt()

The date and time that the health information was retrieved.

Returns:

The date and time that the health information was retrieved.

toBuilder

public DescribeEnvironmentHealthResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeEnvironmentHealthResponse.Builder,DescribeEnvironmentHealthResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static DescribeEnvironmentHealthResponse.Builder builder()

serializableBuilderClass

public static Class<? extends DescribeEnvironmentHealthResponse.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

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)

Overrides:

getValueForField in class SdkResponse

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo