com.amazonaws.services.support.model

Class DescribeCasesRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.support.model.DescribeCasesRequest

All Implemented Interfaces:

Serializable

public class DescribeCasesRequest
extends AmazonWebServiceRequest
implements Serializable

Container for the parameters to the 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:

1. One or more CaseDetails data types.
2. One or more NextToken values, which specify where to paginate the returned records represented by the CaseDetails objects.

See Also:

AWSSupport.describeCases(DescribeCasesRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
DescribeCasesRequest()

Method Summary

Methods

Modifier and Type	Method and Description
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.
List<String>	getCaseIdList() A list of ID numbers of the support cases you want returned.
String	getDisplayId() The ID displayed for a case in the AWS Support Center user interface.
Boolean	getIncludeCommunications() Returns the value of the IncludeCommunications property for this object.
Boolean	getIncludeResolvedCases() Specifies whether resolved support cases should be included in the DescribeCases results.
String	getLanguage() The ISO 639-1 code for the language in which AWS provides support.
Integer	getMaxResults() The maximum number of results to return before paginating.
String	getNextToken() A resumption point for pagination.
int	hashCode()
Boolean	isIncludeCommunications() Returns the value of the IncludeCommunications property for this object.
Boolean	isIncludeResolvedCases() Specifies whether resolved support cases should be included in the DescribeCases results.
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	setCaseIdList(Collection<String> caseIdList) A list of ID numbers of the support cases you want returned.
void	setDisplayId(String displayId) The ID displayed for a case in the AWS Support Center user interface.
void	setIncludeCommunications(Boolean includeCommunications) Sets the value of the IncludeCommunications property for this object.
void	setIncludeResolvedCases(Boolean includeResolvedCases) Specifies whether resolved support cases should be included in the DescribeCases results.
void	setLanguage(String language) The ISO 639-1 code for the language in which AWS provides support.
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.
DescribeCasesRequest	withAfterTime(String afterTime) The start date for a filtered date search on support case communications.
DescribeCasesRequest	withBeforeTime(String beforeTime) The end date for a filtered date search on support case communications.
DescribeCasesRequest	withCaseIdList(Collection<String> caseIdList) A list of ID numbers of the support cases you want returned.
DescribeCasesRequest	withCaseIdList(String... caseIdList) A list of ID numbers of the support cases you want returned.
DescribeCasesRequest	withDisplayId(String displayId) The ID displayed for a case in the AWS Support Center user interface.
DescribeCasesRequest	withIncludeCommunications(Boolean includeCommunications) Sets the value of the IncludeCommunications property for this object.
DescribeCasesRequest	withIncludeResolvedCases(Boolean includeResolvedCases) Specifies whether resolved support cases should be included in the DescribeCases results.
DescribeCasesRequest	withLanguage(String language) The ISO 639-1 code for the language in which AWS provides support.
DescribeCasesRequest	withMaxResults(Integer maxResults) The maximum number of results to return before paginating.
DescribeCasesRequest	withNextToken(String nextToken) A resumption point for pagination.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyPrivateRequestParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

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

Constructor Detail

DescribeCasesRequest

public DescribeCasesRequest()

Method Detail

getCaseIdList

public List<String> getCaseIdList()

A list of ID numbers of the support cases you want returned. The maximum number of cases is 100.

Constraints:
Length: 0 - 100

Returns:

A list of ID numbers of the support cases you want returned. The maximum number of cases is 100.

setCaseIdList

public void setCaseIdList(Collection<String> caseIdList)

A list of ID numbers of the support cases you want returned. The maximum number of cases is 100.

Constraints:
Length: 0 - 100

Parameters:

caseIdList - A list of ID numbers of the support cases you want returned. The maximum number of cases is 100.

withCaseIdList

public DescribeCasesRequest withCaseIdList(String... caseIdList)

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

Parameters:

caseIdList - A list of ID numbers of the support cases you want returned. The maximum number of cases is 100.

Returns:

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

withCaseIdList

public DescribeCasesRequest withCaseIdList(Collection<String> caseIdList)

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

Parameters:

caseIdList - A list of ID numbers of the support cases you want returned. The maximum number of cases is 100.

Returns:

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

getDisplayId

public String getDisplayId()

The ID displayed for a case in the AWS Support Center user interface.

Returns:

The ID displayed for a case in the AWS Support Center user interface.

setDisplayId

public void setDisplayId(String displayId)

The ID displayed for a case in the AWS Support Center user interface.

Parameters:

displayId - The ID displayed for a case in the AWS Support Center user interface.

withDisplayId

public DescribeCasesRequest withDisplayId(String 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.

Parameters:

displayId - The ID displayed for a case in the AWS Support Center user interface.

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.

Returns:

The start date for a filtered date search on support case communications.

setAfterTime

public void setAfterTime(String afterTime)

The start date for a filtered date search on support case communications.

Parameters:

afterTime - The start date for a filtered date search on support case communications.

withAfterTime

public DescribeCasesRequest withAfterTime(String 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.

Parameters:

afterTime - The start date for a filtered date search on support case communications.

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.

Returns:

The end date for a filtered date search on support case communications.

setBeforeTime

public void setBeforeTime(String beforeTime)

The end date for a filtered date search on support case communications.

Parameters:

beforeTime - The end date for a filtered date search on support case communications.

withBeforeTime

public DescribeCasesRequest withBeforeTime(String 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.

Parameters:

beforeTime - The end date for a filtered date search on support case communications.

Returns:

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

isIncludeResolvedCases

public Boolean isIncludeResolvedCases()

Specifies whether resolved support cases should be included in the DescribeCases results.

Returns:

Specifies whether resolved support cases should be included in the DescribeCases results.

setIncludeResolvedCases

public void setIncludeResolvedCases(Boolean includeResolvedCases)

Specifies whether resolved support cases should be included in the DescribeCases results.

Parameters:

includeResolvedCases - Specifies whether resolved support cases should be included in the DescribeCases results.

withIncludeResolvedCases

public DescribeCasesRequest withIncludeResolvedCases(Boolean 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.

Parameters:

includeResolvedCases - Specifies whether resolved support cases should be included in the DescribeCases results.

Returns:

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

getIncludeResolvedCases

public Boolean getIncludeResolvedCases()

Specifies whether resolved support cases should be included in the DescribeCases results.

Returns:

Specifies whether resolved support cases should be included in the DescribeCases results.

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 DescribeCasesRequest 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 DescribeCasesRequest 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.

getLanguage

public String getLanguage()

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:

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.

setLanguage

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

Parameters:

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.

withLanguage

public DescribeCasesRequest withLanguage(String 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.

Parameters:

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

isIncludeCommunications

public Boolean isIncludeCommunications()

Returns the value of the IncludeCommunications property for this object.

Returns:

The value of the IncludeCommunications property for this object.

setIncludeCommunications

public void setIncludeCommunications(Boolean includeCommunications)

Sets the value of the IncludeCommunications property for this object.

Parameters:

includeCommunications - The new value for the IncludeCommunications property for this object.

withIncludeCommunications

public DescribeCasesRequest withIncludeCommunications(Boolean 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.

Parameters:

includeCommunications - The new value for the IncludeCommunications property for this object.

Returns:

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

getIncludeCommunications

public Boolean getIncludeCommunications()

Returns the value of the IncludeCommunications property for this object.

Returns:

The value of the IncludeCommunications property for this object.

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