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.

This action returns a list of cases that you specify by passing one or more CaseIds. 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 objects, strings that specifies where to paginate the returned records represented by CaseDetails .

See Also:

AWSSupport.describeCases(DescribeCasesRequest), Serialized Form

Constructor Summary

DescribeCasesRequest()

Method Summary

boolean	equals(Object obj)
String	getAfterTime() Start date for a filtered date search on support case communications.
String	getBeforeTime() End date for a filtered date search on support case communications.
List<String>	getCaseIdList() A list of Strings comprising ID numbers for support cases you want returned.
String	getDisplayId() String that corresponds to the ID value displayed for a case in the AWS Support Center user interface.
Boolean	getIncludeResolvedCases() Boolean that indicates whether or not resolved support cases should be listed in the DescribeCases search.
String	getLanguage() Specifies the ISO 639-1 code for the language in which AWS provides support.
Integer	getMaxResults() Integer that sets the maximum number of results to return before paginating.
String	getNextToken() Defines a resumption point for pagination.
int	hashCode()
Boolean	isIncludeResolvedCases() Boolean that indicates whether or not resolved support cases should be listed in the DescribeCases search.
void	setAfterTime(String afterTime) Start date for a filtered date search on support case communications.
void	setBeforeTime(String beforeTime) End date for a filtered date search on support case communications.
void	setCaseIdList(Collection<String> caseIdList) A list of Strings comprising ID numbers for support cases you want returned.
void	setDisplayId(String displayId) String that corresponds to the ID value displayed for a case in the AWS Support Center user interface.
void	setIncludeResolvedCases(Boolean includeResolvedCases) Boolean that indicates whether or not resolved support cases should be listed in the DescribeCases search.
void	setLanguage(String language) Specifies the ISO 639-1 code for the language in which AWS provides support.
void	setMaxResults(Integer maxResults) Integer that sets the maximum number of results to return before paginating.
void	setNextToken(String nextToken) Defines a resumption point for pagination.
String	toString() Returns a string representation of this object; useful for testing and debugging.
DescribeCasesRequest	withAfterTime(String afterTime) Start date for a filtered date search on support case communications.
DescribeCasesRequest	withBeforeTime(String beforeTime) End date for a filtered date search on support case communications.
DescribeCasesRequest	withCaseIdList(Collection<String> caseIdList) A list of Strings comprising ID numbers for support cases you want returned.
DescribeCasesRequest	withCaseIdList(String... caseIdList) A list of Strings comprising ID numbers for support cases you want returned.
DescribeCasesRequest	withDisplayId(String displayId) String that corresponds to the ID value displayed for a case in the AWS Support Center user interface.
DescribeCasesRequest	withIncludeResolvedCases(Boolean includeResolvedCases) Boolean that indicates whether or not resolved support cases should be listed in the DescribeCases search.
DescribeCasesRequest	withLanguage(String language) Specifies the ISO 639-1 code for the language in which AWS provides support.
DescribeCasesRequest	withMaxResults(Integer maxResults) Integer that sets the maximum number of results to return before paginating.
DescribeCasesRequest	withNextToken(String nextToken) Defines a resumption point for pagination.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, setRequestCredentials

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DescribeCasesRequest

public DescribeCasesRequest()

Method Detail

getCaseIdList

public List<String> getCaseIdList()

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

Constraints:
Length: 0 - 100

Returns:

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

setCaseIdList

public void setCaseIdList(Collection<String> caseIdList)

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

Constraints:
Length: 0 - 100

Parameters:

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

withCaseIdList

public DescribeCasesRequest withCaseIdList(String... caseIdList)

A list of Strings comprising ID numbers for 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 Strings comprising ID numbers for 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 Strings comprising ID numbers for 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 Strings comprising ID numbers for 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()

String that corresponds to the ID value displayed for a case in the AWS Support Center user interface.

Returns:

String that corresponds to the ID value displayed for a case in the AWS Support Center user interface.

setDisplayId

public void setDisplayId(String displayId)

String that corresponds to the ID value displayed for a case in the AWS Support Center user interface.

Parameters:

displayId - String that corresponds to the ID value displayed for a case in the AWS Support Center user interface.

withDisplayId

public DescribeCasesRequest withDisplayId(String displayId)

String that corresponds to the ID value 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 - String that corresponds to the ID value 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()

Start date for a filtered date search on support case communications.

Returns:

Start date for a filtered date search on support case communications.

setAfterTime

public void setAfterTime(String afterTime)

Start date for a filtered date search on support case communications.

Parameters:

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

withAfterTime

public DescribeCasesRequest withAfterTime(String afterTime)

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 - 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()

End date for a filtered date search on support case communications.

Returns:

End date for a filtered date search on support case communications.

setBeforeTime

public void setBeforeTime(String beforeTime)

End date for a filtered date search on support case communications.

Parameters:

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

withBeforeTime

public DescribeCasesRequest withBeforeTime(String beforeTime)

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 - 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()

Boolean that indicates whether or not resolved support cases should be listed in the DescribeCases search.

Returns:

Boolean that indicates whether or not resolved support cases should be listed in the DescribeCases search.

setIncludeResolvedCases

public void setIncludeResolvedCases(Boolean includeResolvedCases)

Boolean that indicates whether or not resolved support cases should be listed in the DescribeCases search.

Parameters:

includeResolvedCases - Boolean that indicates whether or not resolved support cases should be listed in the DescribeCases search.

withIncludeResolvedCases

public DescribeCasesRequest withIncludeResolvedCases(Boolean includeResolvedCases)

Boolean that indicates whether or not resolved support cases should be listed in the DescribeCases search.

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

Parameters:

includeResolvedCases - Boolean that indicates whether or not resolved support cases should be listed in the DescribeCases search.

Returns:

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

getIncludeResolvedCases

public Boolean getIncludeResolvedCases()

Boolean that indicates whether or not resolved support cases should be listed in the DescribeCases search.

Returns:

Boolean that indicates whether or not resolved support cases should be listed in the DescribeCases search.

getNextToken

public String getNextToken()

Defines a resumption point for pagination.

Returns:

Defines a resumption point for pagination.

setNextToken

public void setNextToken(String nextToken)

Defines a resumption point for pagination.

Parameters:

nextToken - Defines a resumption point for pagination.

withNextToken

public DescribeCasesRequest withNextToken(String nextToken)

Defines a resumption point for pagination.

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

Parameters:

nextToken - Defines a resumption point for pagination.

Returns:

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

getMaxResults

public Integer getMaxResults()

Integer that sets the maximum number of results to return before paginating.

Constraints:
Range: 10 - 100

Returns:

Integer that sets the maximum number of results to return before paginating.

setMaxResults

public void setMaxResults(Integer maxResults)

Integer that sets the maximum number of results to return before paginating.

Constraints:
Range: 10 - 100

Parameters:

maxResults - Integer that sets the maximum number of results to return before paginating.

withMaxResults

public DescribeCasesRequest withMaxResults(Integer maxResults)

Integer that sets 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 - Integer that sets 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()

Specifies the ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English and Japanese, for which the codes are en and ja, respectively. Language parameters must be passed explicitly for operations that take them.

Returns:

Specifies the ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English and Japanese, for which the codes are en and ja, respectively. Language parameters must be passed explicitly for operations that take them.

setLanguage

public void setLanguage(String language)

Specifies the ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English and Japanese, for which the codes are en and ja, respectively. Language parameters must be passed explicitly for operations that take them.

Parameters:

language - Specifies the ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English and Japanese, for which the codes are en and ja, respectively. Language parameters must be passed explicitly for operations that take them.

withLanguage

public DescribeCasesRequest withLanguage(String language)

Specifies the ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English and Japanese, for which the codes are en and ja, respectively. 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 - Specifies the ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English and Japanese, for which the codes are en and ja, respectively. 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.

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