Class DescribeEnvironmentsRequest
- java.lang.Object
-
- com.amazonaws.AmazonWebServiceRequest
-
- com.amazonaws.services.elasticbeanstalk.model.DescribeEnvironmentsRequest
-
- All Implemented Interfaces:
ReadLimitInfo
,Serializable
,Cloneable
public class DescribeEnvironmentsRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
Request to describe one or more environments.
- See Also:
- Serialized Form
-
-
Field Summary
-
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
-
Constructor Summary
Constructors Constructor Description DescribeEnvironmentsRequest()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description DescribeEnvironmentsRequest
clone()
Creates a shallow clone of this request.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 whenIncludeDeleted
is set totrue
, 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 whenIncludeDeleted
is set totrue
, 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(String... environmentIds)
If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified IDs.DescribeEnvironmentsRequest
withEnvironmentIds(Collection<String> environmentIds)
If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified IDs.DescribeEnvironmentsRequest
withEnvironmentNames(String... environmentNames)
If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified names.DescribeEnvironmentsRequest
withEnvironmentNames(Collection<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 whenIncludeDeleted
is set totrue
, 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
copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
-
-
-
-
Method Detail
-
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.
- Parameters:
applicationName
- If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application.
-
getApplicationName
public String getApplicationName()
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.
-
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.
- Parameters:
applicationName
- If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
versionLabel
- If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application version.
-
getVersionLabel
public String getVersionLabel()
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.
-
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.
- Parameters:
versionLabel
- If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application version.- Returns:
- Returns a reference to this 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.
NOTE: This method appends the values to the existing list (if any). Use
setEnvironmentIds(java.util.Collection)
orwithEnvironmentIds(java.util.Collection)
if you want to override the existing values.- Parameters:
environmentIds
- If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified IDs.- Returns:
- Returns a reference to this 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.
- Parameters:
environmentIds
- If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified IDs.- Returns:
- Returns a reference to this 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.
NOTE: This method appends the values to the existing list (if any). Use
setEnvironmentNames(java.util.Collection)
orwithEnvironmentNames(java.util.Collection)
if you want to override the existing values.- Parameters:
environmentNames
- If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified names.- Returns:
- Returns a reference to this 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.
- Parameters:
environmentNames
- If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified names.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setIncludeDeleted
public void setIncludeDeleted(Boolean includeDeleted)
Indicates whether to include deleted environments:
true
: Environments that have been deleted afterIncludedDeletedBackTo
are displayed.false
: Do not include deleted environments.- Parameters:
includeDeleted
- Indicates whether to include deleted environments:true
: Environments that have been deleted afterIncludedDeletedBackTo
are displayed.false
: Do not include deleted environments.
-
getIncludeDeleted
public Boolean getIncludeDeleted()
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.
-
withIncludeDeleted
public DescribeEnvironmentsRequest withIncludeDeleted(Boolean includeDeleted)
Indicates whether to include deleted environments:
true
: Environments that have been deleted afterIncludedDeletedBackTo
are displayed.false
: Do not include deleted environments.- Parameters:
includeDeleted
- Indicates whether to include deleted environments:true
: Environments that have been deleted afterIncludedDeletedBackTo
are displayed.false
: Do not include deleted environments.- Returns:
- Returns a reference to this 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 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.
-
setIncludedDeletedBackTo
public void setIncludedDeletedBackTo(Date includedDeletedBackTo)
If specified when
IncludeDeleted
is set totrue
, then environments deleted after this date are displayed.- Parameters:
includedDeletedBackTo
- If specified whenIncludeDeleted
is set totrue
, then environments deleted after this date are displayed.
-
getIncludedDeletedBackTo
public Date getIncludedDeletedBackTo()
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.
-
withIncludedDeletedBackTo
public DescribeEnvironmentsRequest withIncludedDeletedBackTo(Date includedDeletedBackTo)
If specified when
IncludeDeleted
is set totrue
, then environments deleted after this date are displayed.- Parameters:
includedDeletedBackTo
- If specified whenIncludeDeleted
is set totrue
, then environments deleted after this date are displayed.- Returns:
- Returns a reference to this 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 classObject
- Returns:
- A string representation of this object.
- See Also:
Object.toString()
-
clone
public DescribeEnvironmentsRequest clone()
Description copied from class:AmazonWebServiceRequest
Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.- Overrides:
clone
in classAmazonWebServiceRequest
- See Also:
Object.clone()
-
-