com.amazonaws.services.support.model.DescribeCasesRequest Maven / Gradle / Ivy
/*
* Copyright 2010-2014 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
package com.amazonaws.services.support.model;
import java.io.Serializable;
import com.amazonaws.AmazonWebServiceRequest;
/**
* Container for the parameters to the {@link com.amazonaws.services.support.AWSSupport#describeCases(DescribeCasesRequest) DescribeCases operation}.
*
* Returns a list of cases that you specify by passing one or more case
* IDs. In addition, you can filter the cases by date by setting values
* for the AfterTime and BeforeTime request
* parameters.
*
*
* The response returns the following in JSON format:
*
* - One or more CaseDetails data types.
* - One or more
NextToken values, which specify where to
* paginate the returned records represented by the
* CaseDetails objects.
*
*
* @see com.amazonaws.services.support.AWSSupport#describeCases(DescribeCasesRequest)
*/
public class DescribeCasesRequest extends AmazonWebServiceRequest implements Serializable {
/**
* A list of ID numbers of the support cases you want returned. The
* maximum number of cases is 100.
*
* Constraints:
* Length: 0 - 100
*/
private com.amazonaws.internal.ListWithAutoConstructFlag caseIdList;
/**
* The ID displayed for a case in the AWS Support Center user interface.
*/
private String displayId;
/**
* The start date for a filtered date search on support case
* communications.
*/
private String afterTime;
/**
* The end date for a filtered date search on support case
* communications.
*/
private String beforeTime;
/**
* Specifies whether resolved support cases should be included in the
* DescribeCases results.
*/
private Boolean includeResolvedCases;
/**
* A resumption point for pagination.
*/
private String nextToken;
/**
* The maximum number of results to return before paginating.
*
* Constraints:
* Range: 10 - 100
*/
private Integer maxResults;
/**
* The ISO 639-1 code for the language in which AWS provides support. AWS
* Support currently supports English ("en") and Japanese ("ja").
* Language parameters must be passed explicitly for operations that take
* them.
*/
private String language;
private Boolean includeCommunications;
/**
* A list of ID numbers of the support cases you want returned. The
* maximum number of cases is 100.
*
* Constraints:
* Length: 0 - 100
*
* @return A list of ID numbers of the support cases you want returned. The
* maximum number of cases is 100.
*/
public java.util.List getCaseIdList() {
if (caseIdList == null) {
caseIdList = new com.amazonaws.internal.ListWithAutoConstructFlag();
caseIdList.setAutoConstruct(true);
}
return caseIdList;
}
/**
* A list of ID numbers of the support cases you want returned. The
* maximum number of cases is 100.
*
* Constraints:
* Length: 0 - 100
*
* @param caseIdList A list of ID numbers of the support cases you want returned. The
* maximum number of cases is 100.
*/
public void setCaseIdList(java.util.Collection caseIdList) {
if (caseIdList == null) {
this.caseIdList = null;
return;
}
com.amazonaws.internal.ListWithAutoConstructFlag caseIdListCopy = new com.amazonaws.internal.ListWithAutoConstructFlag(caseIdList.size());
caseIdListCopy.addAll(caseIdList);
this.caseIdList = caseIdListCopy;
}
/**
* A list of ID numbers of the support cases you want returned. The
* maximum number of cases is 100.
*
* Returns a reference to this object so that method calls can be chained together.
*
* Constraints:
* Length: 0 - 100
*
* @param caseIdList A list of ID numbers of the support cases you want returned. The
* maximum number of cases is 100.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeCasesRequest withCaseIdList(String... caseIdList) {
if (getCaseIdList() == null) setCaseIdList(new java.util.ArrayList(caseIdList.length));
for (String value : caseIdList) {
getCaseIdList().add(value);
}
return this;
}
/**
* A list of ID numbers of the support cases you want returned. The
* maximum number of cases is 100.
*
* Returns a reference to this object so that method calls can be chained together.
*
* Constraints:
* Length: 0 - 100
*
* @param caseIdList A list of ID numbers of the support cases you want returned. The
* maximum number of cases is 100.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeCasesRequest withCaseIdList(java.util.Collection caseIdList) {
if (caseIdList == null) {
this.caseIdList = null;
} else {
com.amazonaws.internal.ListWithAutoConstructFlag caseIdListCopy = new com.amazonaws.internal.ListWithAutoConstructFlag(caseIdList.size());
caseIdListCopy.addAll(caseIdList);
this.caseIdList = caseIdListCopy;
}
return this;
}
/**
* The ID displayed for a case in the AWS Support Center user interface.
*
* @return The ID displayed for a case in the AWS Support Center user interface.
*/
public String getDisplayId() {
return displayId;
}
/**
* The ID displayed for a case in the AWS Support Center user interface.
*
* @param displayId The ID displayed for a case in the AWS Support Center user interface.
*/
public void setDisplayId(String displayId) {
this.displayId = displayId;
}
/**
* The ID displayed for a case in the AWS Support Center user interface.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param displayId The ID displayed for a case in the AWS Support Center user interface.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeCasesRequest withDisplayId(String displayId) {
this.displayId = displayId;
return this;
}
/**
* The start date for a filtered date search on support case
* communications.
*
* @return The start date for a filtered date search on support case
* communications.
*/
public String getAfterTime() {
return afterTime;
}
/**
* The start date for a filtered date search on support case
* communications.
*
* @param afterTime The start date for a filtered date search on support case
* communications.
*/
public void setAfterTime(String afterTime) {
this.afterTime = afterTime;
}
/**
* The start date for a filtered date search on support case
* communications.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param afterTime The start date for a filtered date search on support case
* communications.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeCasesRequest withAfterTime(String afterTime) {
this.afterTime = afterTime;
return this;
}
/**
* The end date for a filtered date search on support case
* communications.
*
* @return The end date for a filtered date search on support case
* communications.
*/
public String getBeforeTime() {
return beforeTime;
}
/**
* The end date for a filtered date search on support case
* communications.
*
* @param beforeTime The end date for a filtered date search on support case
* communications.
*/
public void setBeforeTime(String beforeTime) {
this.beforeTime = beforeTime;
}
/**
* The end date for a filtered date search on support case
* communications.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param beforeTime The end date for a filtered date search on support case
* communications.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeCasesRequest withBeforeTime(String beforeTime) {
this.beforeTime = beforeTime;
return this;
}
/**
* Specifies whether resolved support cases should be included in the
* DescribeCases results.
*
* @return Specifies whether resolved support cases should be included in the
* DescribeCases results.
*/
public Boolean isIncludeResolvedCases() {
return includeResolvedCases;
}
/**
* Specifies whether resolved support cases should be included in the
* DescribeCases results.
*
* @param includeResolvedCases Specifies whether resolved support cases should be included in the
* DescribeCases results.
*/
public void setIncludeResolvedCases(Boolean includeResolvedCases) {
this.includeResolvedCases = includeResolvedCases;
}
/**
* Specifies whether resolved support cases should be included in the
* DescribeCases results.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param includeResolvedCases Specifies whether resolved support cases should be included in the
* DescribeCases results.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeCasesRequest withIncludeResolvedCases(Boolean includeResolvedCases) {
this.includeResolvedCases = includeResolvedCases;
return this;
}
/**
* Specifies whether resolved support cases should be included in the
* DescribeCases results.
*
* @return Specifies whether resolved support cases should be included in the
* DescribeCases results.
*/
public Boolean getIncludeResolvedCases() {
return includeResolvedCases;
}
/**
* A resumption point for pagination.
*
* @return A resumption point for pagination.
*/
public String getNextToken() {
return nextToken;
}
/**
* A resumption point for pagination.
*
* @param nextToken A resumption point for pagination.
*/
public void setNextToken(String nextToken) {
this.nextToken = nextToken;
}
/**
* A resumption point for pagination.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param nextToken A resumption point for pagination.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeCasesRequest withNextToken(String nextToken) {
this.nextToken = nextToken;
return this;
}
/**
* The maximum number of results to return before paginating.
*
* Constraints:
* Range: 10 - 100
*
* @return The maximum number of results to return before paginating.
*/
public Integer getMaxResults() {
return maxResults;
}
/**
* The maximum number of results to return before paginating.
*
* Constraints:
* Range: 10 - 100
*
* @param maxResults The maximum number of results to return before paginating.
*/
public void setMaxResults(Integer maxResults) {
this.maxResults = maxResults;
}
/**
* The maximum number of results to return before paginating.
*
* Returns a reference to this object so that method calls can be chained together.
*
* Constraints:
* Range: 10 - 100
*
* @param maxResults The maximum number of results to return before paginating.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeCasesRequest withMaxResults(Integer maxResults) {
this.maxResults = maxResults;
return this;
}
/**
* The ISO 639-1 code for the language in which AWS provides support. AWS
* Support currently supports English ("en") and Japanese ("ja").
* Language parameters must be passed explicitly for operations that take
* them.
*
* @return The ISO 639-1 code for the language in which AWS provides support. AWS
* Support currently supports English ("en") and Japanese ("ja").
* Language parameters must be passed explicitly for operations that take
* them.
*/
public String getLanguage() {
return language;
}
/**
* The ISO 639-1 code for the language in which AWS provides support. AWS
* Support currently supports English ("en") and Japanese ("ja").
* Language parameters must be passed explicitly for operations that take
* them.
*
* @param language The ISO 639-1 code for the language in which AWS provides support. AWS
* Support currently supports English ("en") and Japanese ("ja").
* Language parameters must be passed explicitly for operations that take
* them.
*/
public void setLanguage(String language) {
this.language = language;
}
/**
* The ISO 639-1 code for the language in which AWS provides support. AWS
* Support currently supports English ("en") and Japanese ("ja").
* Language parameters must be passed explicitly for operations that take
* them.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param language The ISO 639-1 code for the language in which AWS provides support. AWS
* Support currently supports English ("en") and Japanese ("ja").
* Language parameters must be passed explicitly for operations that take
* them.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeCasesRequest withLanguage(String language) {
this.language = language;
return this;
}
/**
* Returns the value of the IncludeCommunications property for this
* object.
*
* @return The value of the IncludeCommunications property for this object.
*/
public Boolean isIncludeCommunications() {
return includeCommunications;
}
/**
* Sets the value of the IncludeCommunications property for this object.
*
* @param includeCommunications The new value for the IncludeCommunications property for this object.
*/
public void setIncludeCommunications(Boolean includeCommunications) {
this.includeCommunications = includeCommunications;
}
/**
* Sets the value of the IncludeCommunications property for this object.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param includeCommunications The new value for the IncludeCommunications property for this object.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeCasesRequest withIncludeCommunications(Boolean includeCommunications) {
this.includeCommunications = includeCommunications;
return this;
}
/**
* Returns the value of the IncludeCommunications property for this
* object.
*
* @return The value of the IncludeCommunications property for this object.
*/
public Boolean getIncludeCommunications() {
return includeCommunications;
}
/**
* Returns a string representation of this object; useful for testing and
* debugging.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getCaseIdList() != null) sb.append("CaseIdList: " + getCaseIdList() + ",");
if (getDisplayId() != null) sb.append("DisplayId: " + getDisplayId() + ",");
if (getAfterTime() != null) sb.append("AfterTime: " + getAfterTime() + ",");
if (getBeforeTime() != null) sb.append("BeforeTime: " + getBeforeTime() + ",");
if (isIncludeResolvedCases() != null) sb.append("IncludeResolvedCases: " + isIncludeResolvedCases() + ",");
if (getNextToken() != null) sb.append("NextToken: " + getNextToken() + ",");
if (getMaxResults() != null) sb.append("MaxResults: " + getMaxResults() + ",");
if (getLanguage() != null) sb.append("Language: " + getLanguage() + ",");
if (isIncludeCommunications() != null) sb.append("IncludeCommunications: " + isIncludeCommunications() );
sb.append("}");
return sb.toString();
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getCaseIdList() == null) ? 0 : getCaseIdList().hashCode());
hashCode = prime * hashCode + ((getDisplayId() == null) ? 0 : getDisplayId().hashCode());
hashCode = prime * hashCode + ((getAfterTime() == null) ? 0 : getAfterTime().hashCode());
hashCode = prime * hashCode + ((getBeforeTime() == null) ? 0 : getBeforeTime().hashCode());
hashCode = prime * hashCode + ((isIncludeResolvedCases() == null) ? 0 : isIncludeResolvedCases().hashCode());
hashCode = prime * hashCode + ((getNextToken() == null) ? 0 : getNextToken().hashCode());
hashCode = prime * hashCode + ((getMaxResults() == null) ? 0 : getMaxResults().hashCode());
hashCode = prime * hashCode + ((getLanguage() == null) ? 0 : getLanguage().hashCode());
hashCode = prime * hashCode + ((isIncludeCommunications() == null) ? 0 : isIncludeCommunications().hashCode());
return hashCode;
}
@Override
public boolean equals(Object obj) {
if (this == obj) return true;
if (obj == null) return false;
if (obj instanceof DescribeCasesRequest == false) return false;
DescribeCasesRequest other = (DescribeCasesRequest)obj;
if (other.getCaseIdList() == null ^ this.getCaseIdList() == null) return false;
if (other.getCaseIdList() != null && other.getCaseIdList().equals(this.getCaseIdList()) == false) return false;
if (other.getDisplayId() == null ^ this.getDisplayId() == null) return false;
if (other.getDisplayId() != null && other.getDisplayId().equals(this.getDisplayId()) == false) return false;
if (other.getAfterTime() == null ^ this.getAfterTime() == null) return false;
if (other.getAfterTime() != null && other.getAfterTime().equals(this.getAfterTime()) == false) return false;
if (other.getBeforeTime() == null ^ this.getBeforeTime() == null) return false;
if (other.getBeforeTime() != null && other.getBeforeTime().equals(this.getBeforeTime()) == false) return false;
if (other.isIncludeResolvedCases() == null ^ this.isIncludeResolvedCases() == null) return false;
if (other.isIncludeResolvedCases() != null && other.isIncludeResolvedCases().equals(this.isIncludeResolvedCases()) == false) return false;
if (other.getNextToken() == null ^ this.getNextToken() == null) return false;
if (other.getNextToken() != null && other.getNextToken().equals(this.getNextToken()) == false) return false;
if (other.getMaxResults() == null ^ this.getMaxResults() == null) return false;
if (other.getMaxResults() != null && other.getMaxResults().equals(this.getMaxResults()) == false) return false;
if (other.getLanguage() == null ^ this.getLanguage() == null) return false;
if (other.getLanguage() != null && other.getLanguage().equals(this.getLanguage()) == false) return false;
if (other.isIncludeCommunications() == null ^ this.isIncludeCommunications() == null) return false;
if (other.isIncludeCommunications() != null && other.isIncludeCommunications().equals(this.isIncludeCommunications()) == false) return false;
return true;
}
}