com.amazonaws.services.support.model

Class DescribeCommunicationsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.support.model.DescribeCommunicationsRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class DescribeCommunicationsRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the DescribeCommunications operation.

Returns communications (and attachments) for one or more support cases. You can use the AfterTime and BeforeTime parameters to filter by date. You can use the CaseId parameter to restrict the results to a particular case.

Case data is available for 12 months after creation. If a case was created more than 12 months ago, a request for data might cause an error.

You can use the MaxResults and NextToken parameters 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 Also:

AWSSupport.describeCommunications(DescribeCommunicationsRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
DescribeCommunicationsRequest()

Method Summary

Methods

Modifier and Type	Method and Description
DescribeCommunicationsRequest	clone()
boolean	equals(Object obj)
String	getAfterTime() The start date for a filtered date search on support case communications.
String	getBeforeTime() The end date for a filtered date search on support case communications.
String	getCaseId() The AWS Support case ID requested or returned in the call.
Integer	getMaxResults() The maximum number of results to return before paginating.
String	getNextToken() A resumption point for pagination.
int	hashCode()
void	setAfterTime(String afterTime) The start date for a filtered date search on support case communications.
void	setBeforeTime(String beforeTime) The end date for a filtered date search on support case communications.
void	setCaseId(String caseId) The AWS Support case ID requested or returned in the call.
void	setMaxResults(Integer maxResults) The maximum number of results to return before paginating.
void	setNextToken(String nextToken) A resumption point for pagination.
String	toString() Returns a string representation of this object; useful for testing and debugging.
DescribeCommunicationsRequest	withAfterTime(String afterTime) The start date for a filtered date search on support case communications.
DescribeCommunicationsRequest	withBeforeTime(String beforeTime) The end date for a filtered date search on support case communications.
DescribeCommunicationsRequest	withCaseId(String caseId) The AWS Support case ID requested or returned in the call.
DescribeCommunicationsRequest	withMaxResults(Integer maxResults) The maximum number of results to return before paginating.
DescribeCommunicationsRequest	withNextToken(String nextToken) A resumption point for pagination.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DescribeCommunicationsRequest

public DescribeCommunicationsRequest()

Method Detail

getCaseId

public String getCaseId()

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:

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

setCaseId

public void setCaseId(String 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

Parameters:

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

withCaseId

public DescribeCommunicationsRequest withCaseId(String 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.

Parameters:

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 updated object so that method calls can be chained together.

getBeforeTime

public String getBeforeTime()

The end date for a filtered date search on support case communications. Case communications are available for 12 months after creation.

Returns:

The end date for a filtered date search on support case communications. Case communications are available for 12 months after creation.

setBeforeTime

public void setBeforeTime(String beforeTime)

The end date for a filtered date search on support case communications. Case communications are available for 12 months after creation.

Parameters:

beforeTime - The end date for a filtered date search on support case communications. Case communications are available for 12 months after creation.

withBeforeTime

public DescribeCommunicationsRequest withBeforeTime(String beforeTime)

The end date for a filtered date search on support case communications. Case communications are available for 12 months after creation.

Returns a reference to this object so that method calls can be chained together.

Parameters:

beforeTime - The end date for a filtered date search on support case communications. Case communications are available for 12 months after creation.

Returns:

A reference to this updated object so that method calls can be chained together.

getAfterTime

public String getAfterTime()

The start date for a filtered date search on support case communications. Case communications are available for 12 months after creation.

Returns:

The start date for a filtered date search on support case communications. Case communications are available for 12 months after creation.

setAfterTime

public void setAfterTime(String afterTime)

The start date for a filtered date search on support case communications. Case communications are available for 12 months after creation.

Parameters:

afterTime - The start date for a filtered date search on support case communications. Case communications are available for 12 months after creation.

withAfterTime

public DescribeCommunicationsRequest withAfterTime(String afterTime)

The start date for a filtered date search on support case communications. Case communications are available for 12 months after creation.

Returns a reference to this object so that method calls can be chained together.

Parameters:

afterTime - The start date for a filtered date search on support case communications. Case communications are available for 12 months after creation.

Returns:

A reference to this updated object so that method calls can be chained together.

getNextToken

public String getNextToken()

A resumption point for pagination.

Returns:

A resumption point for pagination.

setNextToken

public void setNextToken(String nextToken)

A resumption point for pagination.

Parameters:

nextToken - A resumption point for pagination.

withNextToken

public DescribeCommunicationsRequest withNextToken(String nextToken)

A resumption point for pagination.

Returns a reference to this object so that method calls can be chained together.

Parameters:

nextToken - A resumption point for pagination.

Returns:

A reference to this updated object so that method calls can be chained together.

getMaxResults

public Integer getMaxResults()

The maximum number of results to return before paginating.

Constraints:
Range: 10 - 100

Returns:

The maximum number of results to return before paginating.

setMaxResults

public void setMaxResults(Integer maxResults)

The maximum number of results to return before paginating.

Constraints:
Range: 10 - 100

Parameters:

maxResults - The maximum number of results to return before paginating.

withMaxResults

public DescribeCommunicationsRequest withMaxResults(Integer 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

Parameters:

maxResults - The maximum number of results to return before paginating.

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

clone

public DescribeCommunicationsRequest clone()

Overrides:

clone in class AmazonWebServiceRequest