public class DescribeEnvironmentsRequest extends AmazonWebServiceRequest implements java.io.Serializable, java.lang.Cloneable
Request to describe one or more environments.
Modifier and Type | Field and Description |
---|---|
private java.lang.String |
applicationName
If specified, AWS Elastic Beanstalk restricts the returned descriptions
to include only those that are associated with this application.
|
private SdkInternalList<java.lang.String> |
environmentIds
If specified, AWS Elastic Beanstalk restricts the returned descriptions
to include only those that have the specified IDs.
|
private SdkInternalList<java.lang.String> |
environmentNames
If specified, AWS Elastic Beanstalk restricts the returned descriptions
to include only those that have the specified names.
|
private java.util.Date |
includedDeletedBackTo
If specified when
IncludeDeleted is set to true
, then environments deleted after this date are displayed. |
private java.lang.Boolean |
includeDeleted
Indicates whether to include deleted environments:
|
private java.lang.String |
versionLabel
If specified, AWS Elastic Beanstalk restricts the returned descriptions
to include only those that are associated with this application version.
|
NOOP
Constructor and Description |
---|
DescribeEnvironmentsRequest() |
Modifier and Type | Method and Description |
---|---|
DescribeEnvironmentsRequest |
clone()
Creates a shallow clone of this request.
|
boolean |
equals(java.lang.Object obj) |
java.lang.String |
getApplicationName()
If specified, AWS Elastic Beanstalk restricts the returned descriptions
to include only those that are associated with this application.
|
java.util.List<java.lang.String> |
getEnvironmentIds()
If specified, AWS Elastic Beanstalk restricts the returned descriptions
to include only those that have the specified IDs.
|
java.util.List<java.lang.String> |
getEnvironmentNames()
If specified, AWS Elastic Beanstalk restricts the returned descriptions
to include only those that have the specified names.
|
java.util.Date |
getIncludedDeletedBackTo()
If specified when
IncludeDeleted is set to true
, then environments deleted after this date are displayed. |
java.lang.Boolean |
getIncludeDeleted()
Indicates whether to include deleted environments:
|
java.lang.String |
getVersionLabel()
If specified, AWS Elastic Beanstalk restricts the returned descriptions
to include only those that are associated with this application version.
|
int |
hashCode() |
java.lang.Boolean |
isIncludeDeleted()
Indicates whether to include deleted environments:
|
void |
setApplicationName(java.lang.String applicationName)
If specified, AWS Elastic Beanstalk restricts the returned descriptions
to include only those that are associated with this application.
|
void |
setEnvironmentIds(java.util.Collection<java.lang.String> environmentIds)
If specified, AWS Elastic Beanstalk restricts the returned descriptions
to include only those that have the specified IDs.
|
void |
setEnvironmentNames(java.util.Collection<java.lang.String> environmentNames)
If specified, AWS Elastic Beanstalk restricts the returned descriptions
to include only those that have the specified names.
|
void |
setIncludedDeletedBackTo(java.util.Date includedDeletedBackTo)
If specified when
IncludeDeleted is set to true
, then environments deleted after this date are displayed. |
void |
setIncludeDeleted(java.lang.Boolean includeDeleted)
Indicates whether to include deleted environments:
|
void |
setVersionLabel(java.lang.String versionLabel)
If specified, AWS Elastic Beanstalk restricts the returned descriptions
to include only those that are associated with this application version.
|
java.lang.String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
DescribeEnvironmentsRequest |
withApplicationName(java.lang.String applicationName)
If specified, AWS Elastic Beanstalk restricts the returned descriptions
to include only those that are associated with this application.
|
DescribeEnvironmentsRequest |
withEnvironmentIds(java.util.Collection<java.lang.String> environmentIds)
If specified, AWS Elastic Beanstalk restricts the returned descriptions
to include only those that have the specified IDs.
|
DescribeEnvironmentsRequest |
withEnvironmentIds(java.lang.String... environmentIds)
If specified, AWS Elastic Beanstalk restricts the returned descriptions
to include only those that have the specified IDs.
|
DescribeEnvironmentsRequest |
withEnvironmentNames(java.util.Collection<java.lang.String> environmentNames)
If specified, AWS Elastic Beanstalk restricts the returned descriptions
to include only those that have the specified names.
|
DescribeEnvironmentsRequest |
withEnvironmentNames(java.lang.String... environmentNames)
If specified, AWS Elastic Beanstalk restricts the returned descriptions
to include only those that have the specified names.
|
DescribeEnvironmentsRequest |
withIncludedDeletedBackTo(java.util.Date includedDeletedBackTo)
If specified when
IncludeDeleted is set to true
, then environments deleted after this date are displayed. |
DescribeEnvironmentsRequest |
withIncludeDeleted(java.lang.Boolean includeDeleted)
Indicates whether to include deleted environments:
|
DescribeEnvironmentsRequest |
withVersionLabel(java.lang.String versionLabel)
If specified, AWS Elastic Beanstalk restricts the returned descriptions
to include only those that are associated with this application version.
|
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
private java.lang.String applicationName
If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application.
private java.lang.String versionLabel
If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application version.
private SdkInternalList<java.lang.String> environmentIds
If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified IDs.
private SdkInternalList<java.lang.String> environmentNames
If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified names.
private java.lang.Boolean includeDeleted
Indicates whether to include deleted environments:
true
: Environments that have been deleted after
IncludedDeletedBackTo
are displayed.
false
: Do not include deleted environments.
private java.util.Date includedDeletedBackTo
If specified when IncludeDeleted
is set to true
, then environments deleted after this date are displayed.
public void setApplicationName(java.lang.String applicationName)
If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application.
applicationName
- If specified, AWS Elastic Beanstalk restricts the returned
descriptions to include only those that are associated with this
application.public java.lang.String getApplicationName()
If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application.
public DescribeEnvironmentsRequest withApplicationName(java.lang.String applicationName)
If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application.
applicationName
- If specified, AWS Elastic Beanstalk restricts the returned
descriptions to include only those that are associated with this
application.public void setVersionLabel(java.lang.String versionLabel)
If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application version.
versionLabel
- If specified, AWS Elastic Beanstalk restricts the returned
descriptions to include only those that are associated with this
application version.public java.lang.String getVersionLabel()
If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application version.
public DescribeEnvironmentsRequest withVersionLabel(java.lang.String versionLabel)
If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application version.
versionLabel
- If specified, AWS Elastic Beanstalk restricts the returned
descriptions to include only those that are associated with this
application version.public java.util.List<java.lang.String> getEnvironmentIds()
If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified IDs.
public void setEnvironmentIds(java.util.Collection<java.lang.String> environmentIds)
If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified IDs.
environmentIds
- If specified, AWS Elastic Beanstalk restricts the returned
descriptions to include only those that have the specified IDs.public DescribeEnvironmentsRequest withEnvironmentIds(java.lang.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)
or
withEnvironmentIds(java.util.Collection)
if you want to override
the existing values.
environmentIds
- If specified, AWS Elastic Beanstalk restricts the returned
descriptions to include only those that have the specified IDs.public DescribeEnvironmentsRequest withEnvironmentIds(java.util.Collection<java.lang.String> environmentIds)
If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified IDs.
environmentIds
- If specified, AWS Elastic Beanstalk restricts the returned
descriptions to include only those that have the specified IDs.public java.util.List<java.lang.String> getEnvironmentNames()
If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified names.
public void setEnvironmentNames(java.util.Collection<java.lang.String> environmentNames)
If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified names.
environmentNames
- If specified, AWS Elastic Beanstalk restricts the returned
descriptions to include only those that have the specified names.public DescribeEnvironmentsRequest withEnvironmentNames(java.lang.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)
or
withEnvironmentNames(java.util.Collection)
if you want to
override the existing values.
environmentNames
- If specified, AWS Elastic Beanstalk restricts the returned
descriptions to include only those that have the specified names.public DescribeEnvironmentsRequest withEnvironmentNames(java.util.Collection<java.lang.String> environmentNames)
If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified names.
environmentNames
- If specified, AWS Elastic Beanstalk restricts the returned
descriptions to include only those that have the specified names.public void setIncludeDeleted(java.lang.Boolean includeDeleted)
Indicates whether to include deleted environments:
true
: Environments that have been deleted after
IncludedDeletedBackTo
are displayed.
false
: Do not include deleted environments.
includeDeleted
- Indicates whether to include deleted environments:
true
: Environments that have been deleted after
IncludedDeletedBackTo
are displayed.
false
: Do not include deleted environments.
public java.lang.Boolean getIncludeDeleted()
Indicates whether to include deleted environments:
true
: Environments that have been deleted after
IncludedDeletedBackTo
are displayed.
false
: Do not include deleted environments.
true
: Environments that have been deleted after
IncludedDeletedBackTo
are displayed.
false
: Do not include deleted environments.
public DescribeEnvironmentsRequest withIncludeDeleted(java.lang.Boolean includeDeleted)
Indicates whether to include deleted environments:
true
: Environments that have been deleted after
IncludedDeletedBackTo
are displayed.
false
: Do not include deleted environments.
includeDeleted
- Indicates whether to include deleted environments:
true
: Environments that have been deleted after
IncludedDeletedBackTo
are displayed.
false
: Do not include deleted environments.
public java.lang.Boolean isIncludeDeleted()
Indicates whether to include deleted environments:
true
: Environments that have been deleted after
IncludedDeletedBackTo
are displayed.
false
: Do not include deleted environments.
true
: Environments that have been deleted after
IncludedDeletedBackTo
are displayed.
false
: Do not include deleted environments.
public void setIncludedDeletedBackTo(java.util.Date includedDeletedBackTo)
If specified when IncludeDeleted
is set to true
, then environments deleted after this date are displayed.
includedDeletedBackTo
- If specified when IncludeDeleted
is set to
true
, then environments deleted after this date are
displayed.public java.util.Date getIncludedDeletedBackTo()
If specified when IncludeDeleted
is set to true
, then environments deleted after this date are displayed.
IncludeDeleted
is set to
true
, then environments deleted after this date are
displayed.public DescribeEnvironmentsRequest withIncludedDeletedBackTo(java.util.Date includedDeletedBackTo)
If specified when IncludeDeleted
is set to true
, then environments deleted after this date are displayed.
includedDeletedBackTo
- If specified when IncludeDeleted
is set to
true
, then environments deleted after this date are
displayed.public java.lang.String toString()
toString
in class java.lang.Object
Object.toString()
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public DescribeEnvironmentsRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()