Class DescribeCasesRequest
- All Implemented Interfaces:
ReadLimitInfo
,Serializable
,Cloneable
- See Also:
-
Field Summary
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
Creates a shallow clone of this request.boolean
The start date for a filtered date search on support case communications.The end date for a filtered date search on support case communications.A list of ID numbers of the support cases you want returned.The ID displayed for a case in the AWS Support Center user interface.Specifies whether communications should be included in the DescribeCases results.Specifies whether resolved support cases should be included in the DescribeCases results.The ISO 639-1 code for the language in which AWS provides support.The maximum number of results to return before paginating.A resumption point for pagination.int
hashCode()
Specifies whether communications should be included in the DescribeCases results.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) Specifies whether communications should be included in the DescribeCases results.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.toString()
Returns a string representation of this object; useful for testing and debugging.withAfterTime
(String afterTime) The start date for a filtered date search on support case communications.withBeforeTime
(String beforeTime) The end date for a filtered date search on support case communications.withCaseIdList
(String... caseIdList) A list of ID numbers of the support cases you want returned.withCaseIdList
(Collection<String> caseIdList) A list of ID numbers of the support cases you want returned.withDisplayId
(String displayId) The ID displayed for a case in the AWS Support Center user interface.withIncludeCommunications
(Boolean includeCommunications) Specifies whether communications should be included in the DescribeCases results.withIncludeResolvedCases
(Boolean includeResolvedCases) Specifies whether resolved support cases should be included in the DescribeCases results.withLanguage
(String language) The ISO 639-1 code for the language in which AWS provides support.withMaxResults
(Integer maxResults) The maximum number of results to return before paginating.withNextToken
(String nextToken) A resumption point for pagination.Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
-
Constructor Details
-
DescribeCasesRequest
public DescribeCasesRequest()
-
-
Method Details
-
getCaseIdList
A list of ID numbers of the support cases you want returned. The maximum number of cases is 100.
- Returns:
- A list of ID numbers of the support cases you want returned. The maximum number of cases is 100.
-
setCaseIdList
A list of ID numbers of the support cases you want returned. The maximum number of cases is 100.
- Parameters:
caseIdList
- A list of ID numbers of the support cases you want returned. The maximum number of cases is 100.
-
withCaseIdList
A list of ID numbers of the support cases you want returned. The maximum number of cases is 100.
NOTE: This method appends the values to the existing list (if any). Use
setCaseIdList(java.util.Collection)
orwithCaseIdList(java.util.Collection)
if you want to override the existing values.- Parameters:
caseIdList
- A list of ID numbers of the support cases you want returned. The maximum number of cases is 100.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withCaseIdList
A list of ID numbers of the support cases you want returned. The maximum number of cases is 100.
- Parameters:
caseIdList
- A list of ID numbers of the support cases you want returned. The maximum number of cases is 100.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setDisplayId
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.
-
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.
-
withDisplayId
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setAfterTime
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.
-
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.
-
withAfterTime
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setBeforeTime
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.
-
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.
-
withBeforeTime
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setIncludeResolvedCases
Specifies whether resolved support cases should be included in the DescribeCases results. The default is false.
- Parameters:
includeResolvedCases
- Specifies whether resolved support cases should be included in the DescribeCases results. The default is false.
-
getIncludeResolvedCases
Specifies whether resolved support cases should be included in the DescribeCases results. The default is false.
- Returns:
- Specifies whether resolved support cases should be included in the DescribeCases results. The default is false.
-
withIncludeResolvedCases
Specifies whether resolved support cases should be included in the DescribeCases results. The default is false.
- Parameters:
includeResolvedCases
- Specifies whether resolved support cases should be included in the DescribeCases results. The default is false.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
isIncludeResolvedCases
Specifies whether resolved support cases should be included in the DescribeCases results. The default is false.
- Returns:
- Specifies whether resolved support cases should be included in the DescribeCases results. The default is false.
-
setNextToken
A resumption point for pagination.
- Parameters:
nextToken
- A resumption point for pagination.
-
getNextToken
A resumption point for pagination.
- Returns:
- A resumption point for pagination.
-
withNextToken
A resumption point for pagination.
- Parameters:
nextToken
- A resumption point for pagination.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setMaxResults
The maximum number of results to return before paginating.
- Parameters:
maxResults
- The maximum number of results to return before paginating.
-
getMaxResults
The maximum number of results to return before paginating.
- Returns:
- The maximum number of results to return before paginating.
-
withMaxResults
The maximum number of results to return before paginating.
- Parameters:
maxResults
- The maximum number of results to return before paginating.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setLanguage
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.
-
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.
-
withLanguage
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setIncludeCommunications
Specifies whether communications should be included in the DescribeCases results. The default is true.
- Parameters:
includeCommunications
- Specifies whether communications should be included in the DescribeCases results. The default is true.
-
getIncludeCommunications
Specifies whether communications should be included in the DescribeCases results. The default is true.
- Returns:
- Specifies whether communications should be included in the DescribeCases results. The default is true.
-
withIncludeCommunications
Specifies whether communications should be included in the DescribeCases results. The default is true.
- Parameters:
includeCommunications
- Specifies whether communications should be included in the DescribeCases results. The default is true.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
isIncludeCommunications
Specifies whether communications should be included in the DescribeCases results. The default is true.
- Returns:
- Specifies whether communications should be included in the DescribeCases results. The default is true.
-
toString
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
clone
Description copied from class:AmazonWebServiceRequest
Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.- Overrides:
clone
in classAmazonWebServiceRequest
- See Also:
-