DescribeCasesRequest (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.support.model.SupportRequest
    - - software.amazon.awssdk.services.support.model.DescribeCasesRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<DescribeCasesRequest.Builder,DescribeCasesRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class DescribeCasesRequest
extends SupportRequest
implements ToCopyableBuilder<DescribeCasesRequest.Builder,DescribeCasesRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface DescribeCasesRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`DescribeCasesRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`afterTime()` The start date for a filtered date search on support case communications.
`String`	`beforeTime()` The end date for a filtered date search on support case communications.
`static DescribeCasesRequest.Builder`	`builder()`
`List<String>`	`caseIdList()` A list of ID numbers of the support cases you want returned.
`String`	`displayId()` The ID displayed for a case in the AWS Support Center user interface.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasCaseIdList()` Returns true if the CaseIdList property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`int`	`hashCode()`
`Boolean`	`includeCommunications()` Specifies whether to include communications in the `DescribeCases` response.
`Boolean`	`includeResolvedCases()` Specifies whether to include resolved support cases in the `DescribeCases` response.
`String`	`language()` The ISO 639-1 code for the language in which AWS provides support.
`Integer`	`maxResults()` The maximum number of results to return before paginating.
`String`	`nextToken()` A resumption point for pagination.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends DescribeCasesRequest.Builder>`	`serializableBuilderClass()`
`DescribeCasesRequest.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - hasCaseIdList
```
public final boolean hasCaseIdList()
```
    Returns true if the CaseIdList property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - caseIdList
```
public final List<String> caseIdList()
```
    A list of ID numbers of the support cases you want returned. The maximum number of cases is 100.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasCaseIdList() to see if a value was sent in this field.
    
    Returns:
    
    A list of ID numbers of the support cases you want returned. The maximum number of cases is 100.
  - displayId
```
public final String displayId()
```
    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.
  - afterTime
```
public final String afterTime()
```
    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.
  - beforeTime
```
public final String beforeTime()
```
    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.
  - includeResolvedCases
```
public final Boolean includeResolvedCases()
```
    Specifies whether to include resolved support cases in the DescribeCases response. By default, resolved cases aren't included.
    
    Returns:
    
    Specifies whether to include resolved support cases in the DescribeCases response. By default, resolved cases aren't included.
  - nextToken
```
public final String nextToken()
```
    A resumption point for pagination.
    
    Returns:
    
    A resumption point for pagination.
  - maxResults
```
public final Integer maxResults()
```
    The maximum number of results to return before paginating.
    
    Returns:
    
    The maximum number of results to return before paginating.
  - language
```
public final 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:
    
    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.
  - includeCommunications
```
public final Boolean includeCommunications()
```
    Specifies whether to include communications in the DescribeCases response. By default, communications are incuded.
    
    Returns:
    
    Specifies whether to include communications in the DescribeCases response. By default, communications are incuded.
  - toBuilder
```
public DescribeCasesRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<DescribeCasesRequest.Builder,DescribeCasesRequest>
    
    Specified by:
    
    toBuilder in class SupportRequest
  - builder
```
public static DescribeCasesRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends DescribeCasesRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class DescribeCasesRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

hasCaseIdList

caseIdList

displayId

afterTime

beforeTime

includeResolvedCases

nextToken

maxResults

language

includeCommunications

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields