@Generated(value="software.amazon.awssdk:codegen") public class DescribeEnvironmentsRequest extends ElasticBeanstalkRequest implements ToCopyableBuilder<DescribeEnvironmentsRequest.Builder,DescribeEnvironmentsRequest>
Request to describe one or more environments.
Modifier and Type | Class and Description |
---|---|
static interface |
DescribeEnvironmentsRequest.Builder |
Modifier and Type | Method and Description |
---|---|
String |
applicationName()
If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated
with this application.
|
static DescribeEnvironmentsRequest.Builder |
builder() |
List<String> |
environmentIds()
If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the
specified IDs.
|
List<String> |
environmentNames()
If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the
specified names.
|
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() |
Instant |
includedDeletedBackTo()
If specified when
IncludeDeleted is set to true , then environments deleted after this
date are displayed. |
Boolean |
includeDeleted()
Indicates whether to include deleted environments:
|
Integer |
maxRecords()
For a paginated request.
|
String |
nextToken()
For a paginated request.
|
static Class<? extends DescribeEnvironmentsRequest.Builder> |
serializableBuilderClass() |
DescribeEnvironmentsRequest.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
String |
versionLabel()
If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated
with this application version.
|
requestOverrideConfig
copy
public String applicationName()
If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application.
public String versionLabel()
If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application version.
public List<String> 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.
public List<String> 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.
public Boolean includeDeleted()
Indicates whether to include deleted environments:
true
: Environments that have been deleted after IncludedDeletedBackTo
are displayed.
false
: Do not include deleted environments.
true
: Environments that have been deleted after IncludedDeletedBackTo
are
displayed.
false
: Do not include deleted environments.
public Instant includedDeletedBackTo()
If specified when IncludeDeleted
is set to true
, then environments deleted after this
date are displayed.
IncludeDeleted
is set to true
, then environments deleted
after this date are displayed.public Integer 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.
If no MaxRecords
is specified, all available environments are retrieved in a single
response.
public String 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.
If no NextToken
is specified, the first page is retrieved.
public DescribeEnvironmentsRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<DescribeEnvironmentsRequest.Builder,DescribeEnvironmentsRequest>
toBuilder
in class ElasticBeanstalkRequest
public static DescribeEnvironmentsRequest.Builder builder()
public static Class<? extends DescribeEnvironmentsRequest.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
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.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.