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:

SdkPojo, ToCopyableBuilder<DescribeEnvironmentHealthRequest.Builder,DescribeEnvironmentHealthRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final 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)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAttributeNames() Returns true if the AttributeNames property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeEnvironmentHealthRequest.Builder>	serializableBuilderClass()
DescribeEnvironmentHealthRequest.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 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.

You can use hasAttributeNames() to see if a value was sent in this field.

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.

hasAttributeNames

public boolean hasAttributeNames()

Returns true if the AttributeNames property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

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.

You can use hasAttributeNames() to see if a value was sent in this field.

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

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeEnvironmentHealthRequest.Builder,DescribeEnvironmentHealthRequest>

Specified by:

toBuilder in class ElasticBeanstalkRequest

builder

public static DescribeEnvironmentHealthRequest.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo