software.amazon.awssdk.services.elasticbeanstalk.model

Class DescribeEnvironmentsRequest

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

All Implemented Interfaces:

ToCopyableBuilder<DescribeEnvironmentsRequest.Builder,DescribeEnvironmentsRequest>

@Generated(value="software.amazon.awssdk:codegen")
public class DescribeEnvironmentsRequest
extends ElasticBeanstalkRequest
implements ToCopyableBuilder<DescribeEnvironmentsRequest.Builder,DescribeEnvironmentsRequest>

Request to describe one or more environments.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DescribeEnvironmentsRequest.Builder

Method Summary

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.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

requestOverrideConfig

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

applicationName

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

public String 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.

environmentIds

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.

Returns:

If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified IDs.

environmentNames

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.

Returns:

If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified names.

includeDeleted

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.

Returns:

Indicates whether to include deleted environments:

true: Environments that have been deleted after IncludedDeletedBackTo are displayed.

false: Do not include deleted environments.

includedDeletedBackTo

public Instant includedDeletedBackTo()

If specified when IncludeDeleted is set to true, then environments deleted after this date are displayed.

Returns:

If specified when IncludeDeleted is set to true, then environments deleted after this date are displayed.

maxRecords

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.

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

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.

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

public DescribeEnvironmentsRequest.Builder 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 interface ToCopyableBuilder<DescribeEnvironmentsRequest.Builder,DescribeEnvironmentsRequest>

Specified by:

toBuilder in class ElasticBeanstalkRequest

Returns:

a builder for type T

builder

public static DescribeEnvironmentsRequest.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends 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.

Overrides:

getValueForField in class SdkRequest

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