* Request to describe one or more environments. *
* * @see AWS API Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class DescribeEnvironmentsRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable { /** ** If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated * with this application. *
*/ private String applicationName; /** ** If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated * with this application version. *
*/ private String versionLabel; /** ** If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the * specified IDs. *
*/ private com.amazonaws.internal.SdkInternalList* If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the * specified names. *
*/ private com.amazonaws.internal.SdkInternalList* Indicates whether to include deleted environments: *
*
* true: Environments that have been deleted after IncludedDeletedBackTo are displayed.
*
* false: Do not include deleted environments.
*
* If specified when IncludeDeleted is set to true, then environments deleted after this
* date are displayed.
*
* For a paginated request. Specify a maximum number of environments to include in each response. *
*
* If no MaxRecords is specified, all available environments are retrieved in a single response.
*
* For a paginated request. Specify a token from a previous response page to retrieve the next response page. All * other parameter values must be identical to the ones specified in the initial request. *
*
* If no NextToken is specified, the first page is retrieved.
*
* If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated * with this application. *
* * @param applicationName * If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are * associated with this application. */ public void setApplicationName(String applicationName) { this.applicationName = applicationName; } /** ** If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated * with this application. *
* * @return If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are * associated with this application. */ public String getApplicationName() { return this.applicationName; } /** ** If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated * with this application. *
* * @param applicationName * If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are * associated with this application. * @return Returns a reference to this object so that method calls can be chained together. */ public DescribeEnvironmentsRequest withApplicationName(String applicationName) { setApplicationName(applicationName); return this; } /** ** If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated * with this application version. *
* * @param versionLabel * If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are * associated with this application version. */ public void setVersionLabel(String versionLabel) { this.versionLabel = versionLabel; } /** ** If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated * with this application version. *
* * @return If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are * associated with this application version. */ public String getVersionLabel() { return this.versionLabel; } /** ** If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated * with this application version. *
* * @param versionLabel * If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are * associated with this application version. * @return Returns a reference to this object so that method calls can be chained together. */ public DescribeEnvironmentsRequest withVersionLabel(String versionLabel) { setVersionLabel(versionLabel); return this; } /** ** If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the * specified IDs. *
* * @return If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have * the specified IDs. */ public java.util.List* If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the * specified IDs. *
* * @param environmentIds * If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have * the specified IDs. */ public void setEnvironmentIds(java.util.Collection* 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 * {@link #setEnvironmentIds(java.util.Collection)} or {@link #withEnvironmentIds(java.util.Collection)} if you want * to override the existing values. *
* * @param environmentIds * If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have * the specified IDs. * @return Returns a reference to this object so that method calls can be chained together. */ public DescribeEnvironmentsRequest withEnvironmentIds(String... environmentIds) { if (this.environmentIds == null) { setEnvironmentIds(new com.amazonaws.internal.SdkInternalList* If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the * specified IDs. *
* * @param environmentIds * If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have * the specified IDs. * @return Returns a reference to this object so that method calls can be chained together. */ public DescribeEnvironmentsRequest withEnvironmentIds(java.util.Collection* If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the * specified names. *
* * @return If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have * the specified names. */ public java.util.List* If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the * specified names. *
* * @param environmentNames * If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have * the specified names. */ public void setEnvironmentNames(java.util.Collection* 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 * {@link #setEnvironmentNames(java.util.Collection)} or {@link #withEnvironmentNames(java.util.Collection)} if you * want to override the existing values. *
* * @param environmentNames * If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have * the specified names. * @return Returns a reference to this object so that method calls can be chained together. */ public DescribeEnvironmentsRequest withEnvironmentNames(String... environmentNames) { if (this.environmentNames == null) { setEnvironmentNames(new com.amazonaws.internal.SdkInternalList* If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the * specified names. *
* * @param environmentNames * If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have * the specified names. * @return Returns a reference to this object so that method calls can be chained together. */ public DescribeEnvironmentsRequest withEnvironmentNames(java.util.Collection* 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 setIncludeDeleted(Boolean includeDeleted) {
this.includeDeleted = includeDeleted;
}
/**
*
* 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 Boolean getIncludeDeleted() {
return this.includeDeleted;
}
/**
*
* 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeEnvironmentsRequest withIncludeDeleted(Boolean includeDeleted) {
setIncludeDeleted(includeDeleted);
return this;
}
/**
*
* 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 Boolean isIncludeDeleted() {
return this.includeDeleted;
}
/**
*
* 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 void setIncludedDeletedBackTo(java.util.Date includedDeletedBackTo) {
this.includedDeletedBackTo = includedDeletedBackTo;
}
/**
*
* 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 java.util.Date getIncludedDeletedBackTo() {
return this.includedDeletedBackTo;
}
/**
*
* 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeEnvironmentsRequest withIncludedDeletedBackTo(java.util.Date includedDeletedBackTo) {
setIncludedDeletedBackTo(includedDeletedBackTo);
return this;
}
/**
* * For a paginated request. Specify a maximum number of environments to include in each response. *
*
* If no MaxRecords is specified, all available environments are retrieved in a single response.
*
* If no MaxRecords is specified, all available environments are retrieved in a single response.
*/
public void setMaxRecords(Integer maxRecords) {
this.maxRecords = maxRecords;
}
/**
*
* For a paginated request. Specify a maximum number of environments to include in each response. *
*
* If no MaxRecords is specified, all available environments are retrieved in a single response.
*
* If no MaxRecords is specified, all available environments are retrieved in a single
* response.
*/
public Integer getMaxRecords() {
return this.maxRecords;
}
/**
*
* For a paginated request. Specify a maximum number of environments to include in each response. *
*
* If no MaxRecords is specified, all available environments are retrieved in a single response.
*
* If no MaxRecords is specified, all available environments are retrieved in a single response.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeEnvironmentsRequest withMaxRecords(Integer maxRecords) {
setMaxRecords(maxRecords);
return this;
}
/**
*
* For a paginated request. Specify a token from a previous response page to retrieve the next response page. All * other parameter values must be identical to the ones specified in the initial request. *
*
* If no NextToken is specified, the first page is retrieved.
*
* If no NextToken is specified, the first page is retrieved.
*/
public void setNextToken(String nextToken) {
this.nextToken = nextToken;
}
/**
*
* For a paginated request. Specify a token from a previous response page to retrieve the next response page. All * other parameter values must be identical to the ones specified in the initial request. *
*
* If no NextToken is specified, the first page is retrieved.
*
* If no NextToken is specified, the first page is retrieved.
*/
public String getNextToken() {
return this.nextToken;
}
/**
*
* For a paginated request. Specify a token from a previous response page to retrieve the next response page. All * other parameter values must be identical to the ones specified in the initial request. *
*
* If no NextToken is specified, the first page is retrieved.
*
* If no NextToken is specified, the first page is retrieved.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeEnvironmentsRequest withNextToken(String nextToken) {
setNextToken(nextToken);
return this;
}
/**
* Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be
* redacted from this string using a placeholder value.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getApplicationName() != null)
sb.append("ApplicationName: ").append(getApplicationName()).append(",");
if (getVersionLabel() != null)
sb.append("VersionLabel: ").append(getVersionLabel()).append(",");
if (getEnvironmentIds() != null)
sb.append("EnvironmentIds: ").append(getEnvironmentIds()).append(",");
if (getEnvironmentNames() != null)
sb.append("EnvironmentNames: ").append(getEnvironmentNames()).append(",");
if (getIncludeDeleted() != null)
sb.append("IncludeDeleted: ").append(getIncludeDeleted()).append(",");
if (getIncludedDeletedBackTo() != null)
sb.append("IncludedDeletedBackTo: ").append(getIncludedDeletedBackTo()).append(",");
if (getMaxRecords() != null)
sb.append("MaxRecords: ").append(getMaxRecords()).append(",");
if (getNextToken() != null)
sb.append("NextToken: ").append(getNextToken());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof DescribeEnvironmentsRequest == false)
return false;
DescribeEnvironmentsRequest other = (DescribeEnvironmentsRequest) obj;
if (other.getApplicationName() == null ^ this.getApplicationName() == null)
return false;
if (other.getApplicationName() != null && other.getApplicationName().equals(this.getApplicationName()) == false)
return false;
if (other.getVersionLabel() == null ^ this.getVersionLabel() == null)
return false;
if (other.getVersionLabel() != null && other.getVersionLabel().equals(this.getVersionLabel()) == false)
return false;
if (other.getEnvironmentIds() == null ^ this.getEnvironmentIds() == null)
return false;
if (other.getEnvironmentIds() != null && other.getEnvironmentIds().equals(this.getEnvironmentIds()) == false)
return false;
if (other.getEnvironmentNames() == null ^ this.getEnvironmentNames() == null)
return false;
if (other.getEnvironmentNames() != null && other.getEnvironmentNames().equals(this.getEnvironmentNames()) == false)
return false;
if (other.getIncludeDeleted() == null ^ this.getIncludeDeleted() == null)
return false;
if (other.getIncludeDeleted() != null && other.getIncludeDeleted().equals(this.getIncludeDeleted()) == false)
return false;
if (other.getIncludedDeletedBackTo() == null ^ this.getIncludedDeletedBackTo() == null)
return false;
if (other.getIncludedDeletedBackTo() != null && other.getIncludedDeletedBackTo().equals(this.getIncludedDeletedBackTo()) == false)
return false;
if (other.getMaxRecords() == null ^ this.getMaxRecords() == null)
return false;
if (other.getMaxRecords() != null && other.getMaxRecords().equals(this.getMaxRecords()) == false)
return false;
if (other.getNextToken() == null ^ this.getNextToken() == null)
return false;
if (other.getNextToken() != null && other.getNextToken().equals(this.getNextToken()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getApplicationName() == null) ? 0 : getApplicationName().hashCode());
hashCode = prime * hashCode + ((getVersionLabel() == null) ? 0 : getVersionLabel().hashCode());
hashCode = prime * hashCode + ((getEnvironmentIds() == null) ? 0 : getEnvironmentIds().hashCode());
hashCode = prime * hashCode + ((getEnvironmentNames() == null) ? 0 : getEnvironmentNames().hashCode());
hashCode = prime * hashCode + ((getIncludeDeleted() == null) ? 0 : getIncludeDeleted().hashCode());
hashCode = prime * hashCode + ((getIncludedDeletedBackTo() == null) ? 0 : getIncludedDeletedBackTo().hashCode());
hashCode = prime * hashCode + ((getMaxRecords() == null) ? 0 : getMaxRecords().hashCode());
hashCode = prime * hashCode + ((getNextToken() == null) ? 0 : getNextToken().hashCode());
return hashCode;
}
@Override
public DescribeEnvironmentsRequest clone() {
return (DescribeEnvironmentsRequest) super.clone();
}
}