software.amazon.awssdk.services.elasticbeanstalk.model

Class DescribeEnvironmentHealthRequest

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

All Implemented Interfaces:

ToCopyableBuilder<DescribeEnvironmentHealthRequest.Builder,DescribeEnvironmentHealthRequest>

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

See the example below to learn how to create a request body.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DescribeEnvironmentHealthRequest.Builder

Method Summary

Modifier and Type	Method and Description
List<EnvironmentHealthAttribute>	attributeNames() Specify the response elements to return.
List<String>	attributeNamesAsStrings() Specify the response elements to return.
static DescribeEnvironmentHealthRequest.Builder	builder()
String	environmentId() Specify the environment by ID.
String	environmentName() Specify the environment by name.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
static Class<? extends DescribeEnvironmentHealthRequest.Builder>	serializableBuilderClass()
DescribeEnvironmentHealthRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

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

requestOverrideConfig

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

environmentName

public String environmentName()

Specify the environment by name.

You must specify either this or an EnvironmentName, or both.

Returns:

Specify the environment by name.

You must specify either this or an EnvironmentName, or both.

environmentId

public String environmentId()

Specify the environment by ID.

You must specify either this or an EnvironmentName, or both.

Returns:

Specify the environment by ID.

You must specify either this or an EnvironmentName, or both.

attributeNames

public List<EnvironmentHealthAttribute> attributeNames()

Specify the response elements to return. To retrieve all attributes, set to All. If no attribute names are specified, returns the name of the environment.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

Specify the response elements to return. To retrieve all attributes, set to All. If no attribute names are specified, returns the name of the environment.

attributeNamesAsStrings

public List<String> attributeNamesAsStrings()

Specify the response elements to return. To retrieve all attributes, set to All. If no attribute names are specified, returns the name of the environment.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

Specify the response elements to return. To retrieve all attributes, set to All. If no attribute names are specified, returns the name of the environment.

toBuilder

public DescribeEnvironmentHealthRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeEnvironmentHealthRequest.Builder,DescribeEnvironmentHealthRequest>

Specified by:

toBuilder in class ElasticBeanstalkRequest

Returns:

a builder for type T

builder

public static DescribeEnvironmentHealthRequest.Builder builder()

serializableBuilderClass

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

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value