Package software.amazon.awssdk.services.elasticbeanstalk.model

Class DescribeEnvironmentsRequest

java.lang.Object

software.amazon.awssdk.AmazonWebServiceRequest

software.amazon.awssdk.services.elasticbeanstalk.model.DescribeEnvironmentsRequest

All Implemented Interfaces:

Cloneable, ReadLimitInfo, ToCopyableBuilder<DescribeEnvironmentsRequest.Builder,DescribeEnvironmentsRequest>

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

Request to describe one or more environments.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DescribeEnvironmentsRequest.Builder

Field Summary

Fields inherited from class software.amazon.awssdk.AmazonWebServiceRequest

NOOP

Method Summary

Modifier and Type	Method	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)
int	hashCode()
Date	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:
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.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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.

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.

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

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>

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