Class DescribeEnvironmentsRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<DescribeEnvironmentsRequest.Builder,
DescribeEnvironmentsRequest>
Request to describe one or more environments.
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application.builder()
If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified IDs.If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified names.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 EnvironmentIds property.final boolean
For responses, this returns true if the service returned a value for the EnvironmentNames property.final int
hashCode()
final Instant
If specified whenIncludeDeleted
is set totrue
, then environments deleted after this date are displayed.final Boolean
Indicates whether to include deleted environments:final Integer
For a paginated request.final String
For a paginated request.static Class
<? extends DescribeEnvironmentsRequest.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.final String
If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application version.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
applicationName
If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application.
- Returns:
- If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application.
-
versionLabel
If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application version.
- Returns:
- If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application version.
-
hasEnvironmentIds
public final boolean hasEnvironmentIds()For responses, this returns true if the service returned a value for the EnvironmentIds 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. -
environmentIds
If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified IDs.
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
hasEnvironmentIds()
method.- Returns:
- If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified IDs.
-
hasEnvironmentNames
public final boolean hasEnvironmentNames()For responses, this returns true if the service returned a value for the EnvironmentNames 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. -
environmentNames
If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified names.
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
hasEnvironmentNames()
method.- Returns:
- If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified names.
-
includeDeleted
Indicates whether to include deleted environments:
true
: Environments that have been deleted afterIncludedDeletedBackTo
are displayed.false
: Do not include deleted environments.- Returns:
- Indicates whether to include deleted environments:
true
: Environments that have been deleted afterIncludedDeletedBackTo
are displayed.false
: Do not include deleted environments.
-
includedDeletedBackTo
If specified when
IncludeDeleted
is set totrue
, then environments deleted after this date are displayed.- Returns:
- If specified when
IncludeDeleted
is set totrue
, then environments deleted after this date are displayed.
-
maxRecords
For a paginated request. Specify a maximum number of environments to include in each response.
If no
MaxRecords
is specified, all available environments are retrieved in a single response.- Returns:
- For a paginated request. Specify a maximum number of environments to include in each response.
If no
MaxRecords
is specified, all available environments are retrieved in a single response.
-
nextToken
For a paginated request. Specify a token from a previous response page to retrieve the next response page. All other parameter values must be identical to the ones specified in the initial request.
If no
NextToken
is specified, the first page is retrieved.- Returns:
- For a paginated request. Specify a token from a previous response page to retrieve the next response
page. All other parameter values must be identical to the ones specified in the initial request.
If no
NextToken
is specified, the first page is retrieved.
-
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<DescribeEnvironmentsRequest.Builder,
DescribeEnvironmentsRequest> - 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
-