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

Class DescribeInstancesHealthRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.elasticbeanstalk.model.ElasticBeanstalkRequest

software.amazon.awssdk.services.elasticbeanstalk.model.DescribeInstancesHealthRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeInstancesHealthRequest.Builder,DescribeInstancesHealthRequest>

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

Parameters for a call to DescribeInstancesHealth.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DescribeInstancesHealthRequest.Builder

Method Summary

Modifier and Type	Method	Description
List<InstancesHealthAttribute>	attributeNames()	Specifies the response elements you wish to receive.
List<String>	attributeNamesAsStrings()	Specifies the response elements you wish to receive.
static DescribeInstancesHealthRequest.Builder	builder()
String	environmentId()	Specify the AWS Elastic Beanstalk environment by ID.
String	environmentName()	Specify the AWS Elastic Beanstalk environment by name.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAttributeNames()	For responses, this returns true if the service returned a value for the AttributeNames property.
int	hashCode()
String	nextToken()	Specify the pagination token returned by a previous call.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeInstancesHealthRequest.Builder>	serializableBuilderClass()
DescribeInstancesHealthRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

Specify the AWS Elastic Beanstalk environment by name.

Returns:

Specify the AWS Elastic Beanstalk environment by name.

environmentId

public final String environmentId()

Specify the AWS Elastic Beanstalk environment by ID.

Returns:

Specify the AWS Elastic Beanstalk environment by ID.

attributeNames

public final List<InstancesHealthAttribute> attributeNames()

Specifies the response elements you wish to receive. To retrieve all attributes, set to All. If no attribute names are specified, returns a list of instances.

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

Returns:

Specifies the response elements you wish to receive. To retrieve all attributes, set to All. If no attribute names are specified, returns a list of instances.

hasAttributeNames

public final boolean hasAttributeNames()

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

attributeNamesAsStrings

public final List<String> attributeNamesAsStrings()

Specifies the response elements you wish to receive. To retrieve all attributes, set to All. If no attribute names are specified, returns a list of instances.

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

Returns:

Specifies the response elements you wish to receive. To retrieve all attributes, set to All. If no attribute names are specified, returns a list of instances.

nextToken

public final String nextToken()

Specify the pagination token returned by a previous call.

Returns:

Specify the pagination token returned by a previous call.

toBuilder

public DescribeInstancesHealthRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeInstancesHealthRequest.Builder,DescribeInstancesHealthRequest>

Specified by:

toBuilder in class ElasticBeanstalkRequest

builder

public static DescribeInstancesHealthRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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 SdkRequest

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