com.amazonaws.services.elasticbeanstalk.model

Class DescribeEnvironmentsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.elasticbeanstalk.model.DescribeEnvironmentsRequest

All Implemented Interfaces:

Serializable

public class DescribeEnvironmentsRequest
extends AmazonWebServiceRequest
implements Serializable

Container for the parameters to the DescribeEnvironments operation.

Returns descriptions for existing environments.

See Also:

AWSElasticBeanstalk.describeEnvironments(DescribeEnvironmentsRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
DescribeEnvironmentsRequest() Default constructor for a new DescribeEnvironmentsRequest object.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getApplicationName() If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application.
List<String>	getEnvironmentIds() If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified IDs.
List<String>	getEnvironmentNames() If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified names.
Date	getIncludedDeletedBackTo() If specified when IncludeDeleted is set to true, then environments deleted after this date are displayed.
Boolean	getIncludeDeleted() Indicates whether to include deleted environments:
String	getVersionLabel() If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application version.
int	hashCode()
Boolean	isIncludeDeleted() Indicates whether to include deleted environments:
void	setApplicationName(String applicationName) If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application.
void	setEnvironmentIds(Collection<String> environmentIds) If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified IDs.
void	setEnvironmentNames(Collection<String> environmentNames) If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified names.
void	setIncludedDeletedBackTo(Date includedDeletedBackTo) If specified when IncludeDeleted is set to true, then environments deleted after this date are displayed.
void	setIncludeDeleted(Boolean includeDeleted) Indicates whether to include deleted environments:
void	setVersionLabel(String versionLabel) If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application version.
String	toString() Returns a string representation of this object; useful for testing and debugging.
DescribeEnvironmentsRequest	withApplicationName(String applicationName) If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application.
DescribeEnvironmentsRequest	withEnvironmentIds(Collection<String> environmentIds) If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified IDs.
DescribeEnvironmentsRequest	withEnvironmentIds(String... environmentIds) If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified IDs.
DescribeEnvironmentsRequest	withEnvironmentNames(Collection<String> environmentNames) If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified names.
DescribeEnvironmentsRequest	withEnvironmentNames(String... environmentNames) If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified names.
DescribeEnvironmentsRequest	withIncludedDeletedBackTo(Date includedDeletedBackTo) If specified when IncludeDeleted is set to true, then environments deleted after this date are displayed.
DescribeEnvironmentsRequest	withIncludeDeleted(Boolean includeDeleted) Indicates whether to include deleted environments:
DescribeEnvironmentsRequest	withVersionLabel(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 com.amazonaws.AmazonWebServiceRequest

copyPrivateRequestParameters, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DescribeEnvironmentsRequest

public DescribeEnvironmentsRequest()

Default constructor for a new DescribeEnvironmentsRequest object. Callers should use the setter or fluent setter (with...) methods to initialize this object after creating it.

Method Detail

getApplicationName

public String getApplicationName()

If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application.

Constraints:
Length: 1 - 100

Returns:

If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application.

setApplicationName

public void setApplicationName(String applicationName)

If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application.

Constraints:
Length: 1 - 100

Parameters:

applicationName - If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application.

withApplicationName

public DescribeEnvironmentsRequest withApplicationName(String applicationName)

If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 100

Parameters:

applicationName - If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application.

Returns:

A reference to this updated object so that method calls can be chained together.

getVersionLabel

public String getVersionLabel()

If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application version.

Constraints:
Length: 1 - 100

Returns:

If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application version.

setVersionLabel

public void setVersionLabel(String versionLabel)

If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application version.

Constraints:
Length: 1 - 100

Parameters:

versionLabel - If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application version.

withVersionLabel

public DescribeEnvironmentsRequest withVersionLabel(String versionLabel)

If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application version.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 100

Parameters:

versionLabel - If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application version.

Returns:

A reference to this updated object so that method calls can be chained together.

getEnvironmentIds

public List<String> getEnvironmentIds()

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.

setEnvironmentIds

public void setEnvironmentIds(Collection<String> environmentIds)

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

Parameters:

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

withEnvironmentIds

public DescribeEnvironmentsRequest withEnvironmentIds(String... environmentIds)

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

Returns a reference to this object so that method calls can be chained together.

Parameters:

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

Returns:

A reference to this updated object so that method calls can be chained together.

withEnvironmentIds

public DescribeEnvironmentsRequest withEnvironmentIds(Collection<String> environmentIds)

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

Returns a reference to this object so that method calls can be chained together.

Parameters:

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

Returns:

A reference to this updated object so that method calls can be chained together.

getEnvironmentNames

public List<String> getEnvironmentNames()

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.

setEnvironmentNames

public void setEnvironmentNames(Collection<String> environmentNames)

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

Parameters:

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

withEnvironmentNames

public DescribeEnvironmentsRequest withEnvironmentNames(String... environmentNames)

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

Returns a reference to this object so that method calls can be chained together.

Parameters:

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

Returns:

A reference to this updated object so that method calls can be chained together.

withEnvironmentNames

public DescribeEnvironmentsRequest withEnvironmentNames(Collection<String> environmentNames)

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

Returns a reference to this object so that method calls can be chained together.

Parameters:

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

Returns:

A reference to this updated object so that method calls can be chained together.

isIncludeDeleted

public Boolean isIncludeDeleted()

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.

setIncludeDeleted

public void setIncludeDeleted(Boolean includeDeleted)

Indicates whether to include deleted environments:

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

false: Do not include deleted environments.

Parameters:

includeDeleted - Indicates whether to include deleted environments:

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

false: Do not include deleted environments.

withIncludeDeleted

public DescribeEnvironmentsRequest withIncludeDeleted(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 a reference to this object so that method calls can be chained together.

Parameters:

includeDeleted - Indicates whether to include deleted environments:

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

false: Do not include deleted environments.

Returns:

A reference to this updated object so that method calls can be chained together.

getIncludeDeleted

public Boolean getIncludeDeleted()

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.

getIncludedDeletedBackTo

public Date getIncludedDeletedBackTo()

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.

setIncludedDeletedBackTo

public void setIncludedDeletedBackTo(Date includedDeletedBackTo)

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

Parameters:

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

withIncludedDeletedBackTo

public DescribeEnvironmentsRequest withIncludedDeletedBackTo(Date includedDeletedBackTo)

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

Returns a reference to this object so that method calls can be chained together.

Parameters:

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

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object