software.amazon.awssdk.services.support.model

Class DescribeCasesRequest

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:

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

Method Summary

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)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
Boolean	includeCommunications() Specifies whether communications should be included in the DescribeCases results.
Boolean	includeResolvedCases() Specifies whether resolved support cases should be included in the DescribeCases results.
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.
static Class<? extends DescribeCasesRequest.Builder>	serializableBuilderClass()
DescribeCasesRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

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

overrideConfiguration

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

caseIdList

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

Returns:

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

displayId

public 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 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 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 Boolean includeResolvedCases()

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.

nextToken

public String nextToken()

A resumption point for pagination.

Returns:

A resumption point for pagination.

maxResults

public Integer maxResults()

The maximum number of results to return before paginating.

Returns:

The maximum number of results to return before paginating.

language

public 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 Boolean includeCommunications()

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.

toBuilder

public DescribeCasesRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeCasesRequest.Builder,DescribeCasesRequest>

Specified by:

toBuilder in class SupportRequest

Returns:

a builder for type T

builder

public static DescribeCasesRequest.Builder builder()

serializableBuilderClass

public static Class<? extends DescribeCasesRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value