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

Class DescribeInstancesHealthResponse

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeInstancesHealthResponse.Builder,DescribeInstancesHealthResponse>

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

Detailed health information about the Amazon EC2 instances in an AWS Elastic Beanstalk environment.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DescribeInstancesHealthResponse.Builder

Method Summary

Modifier and Type	Method	Description
static DescribeInstancesHealthResponse.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasInstanceHealthList()	For responses, this returns true if the service returned a value for the InstanceHealthList property.
List<SingleInstanceHealth>	instanceHealthList()	Detailed health information about each instance.
String	nextToken()	Pagination token for the next page of results, if available.
Instant	refreshedAt()	The date and time that the health information was retrieved.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeInstancesHealthResponse.Builder>	serializableBuilderClass()
DescribeInstancesHealthResponse.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

hasInstanceHealthList

public final boolean hasInstanceHealthList()

For responses, this returns true if the service returned a value for the InstanceHealthList 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.

instanceHealthList

public final List<SingleInstanceHealth> instanceHealthList()

Detailed health information about each instance.

The output differs slightly between Linux and Windows environments. There is a difference in the members that are supported under the <CPUUtilization> type.

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

Returns:

Detailed health information about each instance.

The output differs slightly between Linux and Windows environments. There is a difference in the members that are supported under the <CPUUtilization> type.

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.

nextToken

public final String nextToken()

Pagination token for the next page of results, if available.

Returns:

Pagination token for the next page of results, if available.

toBuilder

public DescribeInstancesHealthResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeInstancesHealthResponse.Builder,DescribeInstancesHealthResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static DescribeInstancesHealthResponse.Builder builder()

serializableBuilderClass

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