Class DescribeEnvironmentsRequest
- All Implemented Interfaces:
ReadLimitInfo
,Serializable
,Cloneable
Request to describe one or more environments.
- See Also:
-
Field Summary
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
Creates a shallow clone of this request.boolean
If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application.If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified IDs.If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified names.If specified whenIncludeDeleted
is set totrue
, then environments deleted after this date are displayed.Indicates whether to include deleted environments:If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application version.int
hashCode()
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.toString()
Returns a string representation of this object; useful for testing and debugging.withApplicationName
(String applicationName) If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application.withEnvironmentIds
(String... environmentIds) If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified IDs.withEnvironmentIds
(Collection<String> environmentIds) If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified IDs.withEnvironmentNames
(String... environmentNames) If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified names.withEnvironmentNames
(Collection<String> environmentNames) If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified names.withIncludedDeletedBackTo
(Date includedDeletedBackTo) If specified whenIncludeDeleted
is set totrue
, then environments deleted after this date are displayed.withIncludeDeleted
(Boolean includeDeleted) Indicates whether to include deleted environments: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
-
Constructor Details
-
DescribeEnvironmentsRequest
public DescribeEnvironmentsRequest()
-
-
Method Details
-
setApplicationName
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
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:
-