public class DescribeCasesRequest extends AmazonWebServiceRequest implements java.io.Serializable, java.lang.Cloneable
Modifier and Type | Field and Description |
---|---|
private java.lang.String |
afterTime
The start date for a filtered date search on support case communications.
|
private java.lang.String |
beforeTime
The end date for a filtered date search on support case communications.
|
private SdkInternalList<java.lang.String> |
caseIdList
A list of ID numbers of the support cases you want returned.
|
private java.lang.String |
displayId
The ID displayed for a case in the AWS Support Center user interface.
|
private java.lang.Boolean |
includeCommunications
Specifies whether communications should be included in the
DescribeCases results.
|
private java.lang.Boolean |
includeResolvedCases
Specifies whether resolved support cases should be included in the
DescribeCases results.
|
private java.lang.String |
language
The ISO 639-1 code for the language in which AWS provides support.
|
private java.lang.Integer |
maxResults
The maximum number of results to return before paginating.
|
private java.lang.String |
nextToken
A resumption point for pagination.
|
NOOP
Constructor and Description |
---|
DescribeCasesRequest() |
Modifier and Type | Method and Description |
---|---|
DescribeCasesRequest |
clone()
Creates a shallow clone of this request.
|
boolean |
equals(java.lang.Object obj) |
java.lang.String |
getAfterTime()
The start date for a filtered date search on support case communications.
|
java.lang.String |
getBeforeTime()
The end date for a filtered date search on support case communications.
|
java.util.List<java.lang.String> |
getCaseIdList()
A list of ID numbers of the support cases you want returned.
|
java.lang.String |
getDisplayId()
The ID displayed for a case in the AWS Support Center user interface.
|
java.lang.Boolean |
getIncludeCommunications()
Specifies whether communications should be included in the
DescribeCases results.
|
java.lang.Boolean |
getIncludeResolvedCases()
Specifies whether resolved support cases should be included in the
DescribeCases results.
|
java.lang.String |
getLanguage()
The ISO 639-1 code for the language in which AWS provides support.
|
java.lang.Integer |
getMaxResults()
The maximum number of results to return before paginating.
|
java.lang.String |
getNextToken()
A resumption point for pagination.
|
int |
hashCode() |
java.lang.Boolean |
isIncludeCommunications()
Specifies whether communications should be included in the
DescribeCases results.
|
java.lang.Boolean |
isIncludeResolvedCases()
Specifies whether resolved support cases should be included in the
DescribeCases results.
|
void |
setAfterTime(java.lang.String afterTime)
The start date for a filtered date search on support case communications.
|
void |
setBeforeTime(java.lang.String beforeTime)
The end date for a filtered date search on support case communications.
|
void |
setCaseIdList(java.util.Collection<java.lang.String> caseIdList)
A list of ID numbers of the support cases you want returned.
|
void |
setDisplayId(java.lang.String displayId)
The ID displayed for a case in the AWS Support Center user interface.
|
void |
setIncludeCommunications(java.lang.Boolean includeCommunications)
Specifies whether communications should be included in the
DescribeCases results.
|
void |
setIncludeResolvedCases(java.lang.Boolean includeResolvedCases)
Specifies whether resolved support cases should be included in the
DescribeCases results.
|
void |
setLanguage(java.lang.String language)
The ISO 639-1 code for the language in which AWS provides support.
|
void |
setMaxResults(java.lang.Integer maxResults)
The maximum number of results to return before paginating.
|
void |
setNextToken(java.lang.String nextToken)
A resumption point for pagination.
|
java.lang.String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
DescribeCasesRequest |
withAfterTime(java.lang.String afterTime)
The start date for a filtered date search on support case communications.
|
DescribeCasesRequest |
withBeforeTime(java.lang.String beforeTime)
The end date for a filtered date search on support case communications.
|
DescribeCasesRequest |
withCaseIdList(java.util.Collection<java.lang.String> caseIdList)
A list of ID numbers of the support cases you want returned.
|
DescribeCasesRequest |
withCaseIdList(java.lang.String... caseIdList)
A list of ID numbers of the support cases you want returned.
|
DescribeCasesRequest |
withDisplayId(java.lang.String displayId)
The ID displayed for a case in the AWS Support Center user interface.
|
DescribeCasesRequest |
withIncludeCommunications(java.lang.Boolean includeCommunications)
Specifies whether communications should be included in the
DescribeCases results.
|
DescribeCasesRequest |
withIncludeResolvedCases(java.lang.Boolean includeResolvedCases)
Specifies whether resolved support cases should be included in the
DescribeCases results.
|
DescribeCasesRequest |
withLanguage(java.lang.String language)
The ISO 639-1 code for the language in which AWS provides support.
|
DescribeCasesRequest |
withMaxResults(java.lang.Integer maxResults)
The maximum number of results to return before paginating.
|
DescribeCasesRequest |
withNextToken(java.lang.String nextToken)
A resumption point for pagination.
|
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
private SdkInternalList<java.lang.String> caseIdList
A list of ID numbers of the support cases you want returned. The maximum number of cases is 100.
private java.lang.String displayId
The ID displayed for a case in the AWS Support Center user interface.
private java.lang.String afterTime
The start date for a filtered date search on support case communications. Case communications are available for 12 months after creation.
private java.lang.String beforeTime
The end date for a filtered date search on support case communications. Case communications are available for 12 months after creation.
private java.lang.Boolean includeResolvedCases
Specifies whether resolved support cases should be included in the DescribeCases results. The default is false.
private java.lang.String nextToken
A resumption point for pagination.
private java.lang.Integer maxResults
The maximum number of results to return before paginating.
private java.lang.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.
private java.lang.Boolean includeCommunications
Specifies whether communications should be included in the DescribeCases results. The default is true.
public java.util.List<java.lang.String> getCaseIdList()
A list of ID numbers of the support cases you want returned. The maximum number of cases is 100.
public void setCaseIdList(java.util.Collection<java.lang.String> caseIdList)
A list of ID numbers of the support cases you want returned. The maximum number of cases is 100.
caseIdList
- A list of ID numbers of the support cases you want returned. The
maximum number of cases is 100.public DescribeCasesRequest withCaseIdList(java.lang.String... caseIdList)
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)
or
withCaseIdList(java.util.Collection)
if you want to override the
existing values.
caseIdList
- A list of ID numbers of the support cases you want returned. The
maximum number of cases is 100.public DescribeCasesRequest withCaseIdList(java.util.Collection<java.lang.String> caseIdList)
A list of ID numbers of the support cases you want returned. The maximum number of cases is 100.
caseIdList
- A list of ID numbers of the support cases you want returned. The
maximum number of cases is 100.public void setDisplayId(java.lang.String displayId)
The ID displayed for a case in the AWS Support Center user interface.
displayId
- The ID displayed for a case in the AWS Support Center user
interface.public java.lang.String getDisplayId()
The ID displayed for a case in the AWS Support Center user interface.
public DescribeCasesRequest withDisplayId(java.lang.String displayId)
The ID displayed for a case in the AWS Support Center user interface.
displayId
- The ID displayed for a case in the AWS Support Center user
interface.public void setAfterTime(java.lang.String afterTime)
The start date for a filtered date search on support case communications. Case communications are available for 12 months after creation.
afterTime
- The start date for a filtered date search on support case
communications. Case communications are available for 12 months
after creation.public java.lang.String getAfterTime()
The start date for a filtered date search on support case communications. Case communications are available for 12 months after creation.
public DescribeCasesRequest withAfterTime(java.lang.String afterTime)
The start date for a filtered date search on support case communications. Case communications are available for 12 months after creation.
afterTime
- The start date for a filtered date search on support case
communications. Case communications are available for 12 months
after creation.public void setBeforeTime(java.lang.String beforeTime)
The end date for a filtered date search on support case communications. Case communications are available for 12 months after creation.
beforeTime
- The end date for a filtered date search on support case
communications. Case communications are available for 12 months
after creation.public java.lang.String getBeforeTime()
The end date for a filtered date search on support case communications. Case communications are available for 12 months after creation.
public DescribeCasesRequest withBeforeTime(java.lang.String beforeTime)
The end date for a filtered date search on support case communications. Case communications are available for 12 months after creation.
beforeTime
- The end date for a filtered date search on support case
communications. Case communications are available for 12 months
after creation.public void setIncludeResolvedCases(java.lang.Boolean includeResolvedCases)
Specifies whether resolved support cases should be included in the DescribeCases results. The default is false.
includeResolvedCases
- Specifies whether resolved support cases should be included in the
DescribeCases results. The default is false.public java.lang.Boolean getIncludeResolvedCases()
Specifies whether resolved support cases should be included in the DescribeCases results. The default is false.
public DescribeCasesRequest withIncludeResolvedCases(java.lang.Boolean includeResolvedCases)
Specifies whether resolved support cases should be included in the DescribeCases results. The default is false.
includeResolvedCases
- Specifies whether resolved support cases should be included in the
DescribeCases results. The default is false.public java.lang.Boolean isIncludeResolvedCases()
Specifies whether resolved support cases should be included in the DescribeCases results. The default is false.
public void setNextToken(java.lang.String nextToken)
A resumption point for pagination.
nextToken
- A resumption point for pagination.public java.lang.String getNextToken()
A resumption point for pagination.
public DescribeCasesRequest withNextToken(java.lang.String nextToken)
A resumption point for pagination.
nextToken
- A resumption point for pagination.public void setMaxResults(java.lang.Integer maxResults)
The maximum number of results to return before paginating.
maxResults
- The maximum number of results to return before paginating.public java.lang.Integer getMaxResults()
The maximum number of results to return before paginating.
public DescribeCasesRequest withMaxResults(java.lang.Integer maxResults)
The maximum number of results to return before paginating.
maxResults
- The maximum number of results to return before paginating.public void setLanguage(java.lang.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.
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.public java.lang.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.
public DescribeCasesRequest withLanguage(java.lang.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.
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.public void setIncludeCommunications(java.lang.Boolean includeCommunications)
Specifies whether communications should be included in the DescribeCases results. The default is true.
includeCommunications
- Specifies whether communications should be included in the
DescribeCases results. The default is true.public java.lang.Boolean getIncludeCommunications()
Specifies whether communications should be included in the DescribeCases results. The default is true.
public DescribeCasesRequest withIncludeCommunications(java.lang.Boolean includeCommunications)
Specifies whether communications should be included in the DescribeCases results. The default is true.
includeCommunications
- Specifies whether communications should be included in the
DescribeCases results. The default is true.public java.lang.Boolean isIncludeCommunications()
Specifies whether communications should be included in the DescribeCases results. The default is true.
public java.lang.String toString()
toString
in class java.lang.Object
Object.toString()
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public DescribeCasesRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()