Class DescribeEnvironmentHealthRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<DescribeEnvironmentHealthRequest.Builder,
DescribeEnvironmentHealthRequest>
See the example below to learn how to create a request body.
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal List
<EnvironmentHealthAttribute> Specify the response elements to return.Specify the response elements to return.builder()
final String
Specify the environment by ID.final String
Specify the environment by name.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final boolean
For responses, this returns true if the service returned a value for the AttributeNames property.final int
hashCode()
static Class
<? extends DescribeEnvironmentHealthRequest.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
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
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 theisEmpty()
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
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
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 interfaceToCopyableBuilder<DescribeEnvironmentHealthRequest.Builder,
DescribeEnvironmentHealthRequest> - Specified by:
toBuilder
in classElasticBeanstalkRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. 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, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- 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
-
sdkFields
-