com.amazonaws.services.support.model.DescribeCommunicationsRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk Show documentation
/*
* 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#describeCommunications(DescribeCommunicationsRequest) DescribeCommunications operation}.
*
* Returns communications regarding the support case. You can use the
* AfterTime and BeforeTime parameters to
* filter by date. The CaseId parameter enables you to
* identify a specific case by its CaseId value.
*
*
* The MaxResults and NextToken parameters
* enable you to control the pagination of the result set. Set
* MaxResults to the number of cases you want displayed on
* each page, and use NextToken to specify the resumption of
* pagination.
*
*
* @see com.amazonaws.services.support.AWSSupport#describeCommunications(DescribeCommunicationsRequest)
*/
public class DescribeCommunicationsRequest extends AmazonWebServiceRequest implements Serializable {
/**
* The AWS Support case ID requested or returned in the call. The case ID
* is an alphanumeric string formatted as shown in this example:
* case-12345678910-2013-c4c1d2bf33c5cf47
*/
private String caseId;
/**
* The end date for a filtered date search on support case
* communications.
*/
private String beforeTime;
/**
* The start date for a filtered date search on support case
* communications.
*/
private String afterTime;
/**
* 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 AWS Support case ID requested or returned in the call. The case ID
* is an alphanumeric string formatted as shown in this example:
* case-12345678910-2013-c4c1d2bf33c5cf47
*
* @return The AWS Support case ID requested or returned in the call. The case ID
* is an alphanumeric string formatted as shown in this example:
* case-12345678910-2013-c4c1d2bf33c5cf47
*/
public String getCaseId() {
return caseId;
}
/**
* The AWS Support case ID requested or returned in the call. The case ID
* is an alphanumeric string formatted as shown in this example:
* case-12345678910-2013-c4c1d2bf33c5cf47
*
* @param caseId The AWS Support case ID requested or returned in the call. The case ID
* is an alphanumeric string formatted as shown in this example:
* case-12345678910-2013-c4c1d2bf33c5cf47
*/
public void setCaseId(String caseId) {
this.caseId = caseId;
}
/**
* The AWS Support case ID requested or returned in the call. The case ID
* is an alphanumeric string formatted as shown in this example:
* case-12345678910-2013-c4c1d2bf33c5cf47
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param caseId The AWS Support case ID requested or returned in the call. The case ID
* is an alphanumeric string formatted as shown in this example:
* case-12345678910-2013-c4c1d2bf33c5cf47
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeCommunicationsRequest withCaseId(String caseId) {
this.caseId = caseId;
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 DescribeCommunicationsRequest withBeforeTime(String beforeTime) {
this.beforeTime = beforeTime;
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 DescribeCommunicationsRequest withAfterTime(String afterTime) {
this.afterTime = afterTime;
return this;
}
/**
* 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 DescribeCommunicationsRequest 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 DescribeCommunicationsRequest withMaxResults(Integer maxResults) {
this.maxResults = maxResults;
return this;
}
/**
* 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 (getCaseId() != null) sb.append("CaseId: " + getCaseId() + ",");
if (getBeforeTime() != null) sb.append("BeforeTime: " + getBeforeTime() + ",");
if (getAfterTime() != null) sb.append("AfterTime: " + getAfterTime() + ",");
if (getNextToken() != null) sb.append("NextToken: " + getNextToken() + ",");
if (getMaxResults() != null) sb.append("MaxResults: " + getMaxResults() );
sb.append("}");
return sb.toString();
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getCaseId() == null) ? 0 : getCaseId().hashCode());
hashCode = prime * hashCode + ((getBeforeTime() == null) ? 0 : getBeforeTime().hashCode());
hashCode = prime * hashCode + ((getAfterTime() == null) ? 0 : getAfterTime().hashCode());
hashCode = prime * hashCode + ((getNextToken() == null) ? 0 : getNextToken().hashCode());
hashCode = prime * hashCode + ((getMaxResults() == null) ? 0 : getMaxResults().hashCode());
return hashCode;
}
@Override
public boolean equals(Object obj) {
if (this == obj) return true;
if (obj == null) return false;
if (obj instanceof DescribeCommunicationsRequest == false) return false;
DescribeCommunicationsRequest other = (DescribeCommunicationsRequest)obj;
if (other.getCaseId() == null ^ this.getCaseId() == null) return false;
if (other.getCaseId() != null && other.getCaseId().equals(this.getCaseId()) == 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.getAfterTime() == null ^ this.getAfterTime() == null) return false;
if (other.getAfterTime() != null && other.getAfterTime().equals(this.getAfterTime()) == 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;
return true;
}
}