Package 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("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	Description
static interface	DescribeEnvironmentHealthRequest.Builder

Method Summary

Modifier and Type	Method	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()	For responses, this returns true if the service returned a value for the AttributeNames property.
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 final 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 final 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 final 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.

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:

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

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.

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:

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