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(value="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 and Description
static interface	DescribeEnvironmentHealthResponse.Builder

Method Summary

Modifier and Type	Method and 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)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
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.
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()

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

The environment's name.

Returns:

The environment's name.

healthStatus

public String healthStatus()

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

Returns:

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

status

public 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 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 String color()

The health color of the environment.

Returns:

The health color of the environment.

causes

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

Returns:

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

applicationMetrics

public ApplicationMetrics applicationMetrics()

Application request metrics for the environment.

Returns:

Application request metrics for the environment.

instancesHealth

public InstanceHealthSummary instancesHealth()

Summary health information for the instances in the environment.

Returns:

Summary health information for the instances in the environment.

refreshedAt

public 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>

Overrides:

toBuilder in class AwsResponse

builder

public static DescribeEnvironmentHealthResponse.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Overrides:

getValueForField in class SdkResponse

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo