software.amazon.awssdk.services.connectcases.model

Class SearchCasesRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.connectcases.model.ConnectCasesRequest

software.amazon.awssdk.services.connectcases.model.SearchCasesRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<SearchCasesRequest.Builder,SearchCasesRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SearchCasesRequest.Builder

Method Summary

Modifier and Type	Method and Description
static SearchCasesRequest.Builder	builder()
String	domainId() The unique identifier of the Cases domain.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<FieldIdentifier>	fields() The list of field identifiers to be returned as part of the response.
CaseFilter	filter() A list of filter objects.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasFields() For responses, this returns true if the service returned a value for the Fields property.
int	hashCode()
boolean	hasSorts() For responses, this returns true if the service returned a value for the Sorts property.
Integer	maxResults() The maximum number of cases to return.
String	nextToken() The token for the next set of results.
List<SdkField<?>>	sdkFields()
String	searchTerm() A word or phrase used to perform a quick search.
static Class<? extends SearchCasesRequest.Builder>	serializableBuilderClass()
List<Sort>	sorts() A list of sorts where each sort specifies a field and their sort order to be applied to the results.
SearchCasesRequest.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

domainId

public final String domainId()

The unique identifier of the Cases domain.

Returns:

The unique identifier of the Cases domain.

hasFields

public final boolean hasFields()

For responses, this returns true if the service returned a value for the Fields property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

fields

public final List<FieldIdentifier> fields()

The list of field identifiers to be returned as part of the response.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasFields() method.

Returns:

The list of field identifiers to be returned as part of the response.

filter

public final CaseFilter filter()

A list of filter objects.

Returns:

A list of filter objects.

maxResults

public final Integer maxResults()

The maximum number of cases to return. The current maximum supported value is 25. This is also the default value when no other value is provided.

Returns:

The maximum number of cases to return. The current maximum supported value is 25. This is also the default value when no other value is provided.

nextToken

public final String nextToken()

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Returns:

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

searchTerm

public final String searchTerm()

A word or phrase used to perform a quick search.

Returns:

A word or phrase used to perform a quick search.

hasSorts

public final boolean hasSorts()

For responses, this returns true if the service returned a value for the Sorts property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

sorts

public final List<Sort> sorts()

A list of sorts where each sort specifies a field and their sort order to be applied to the results.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSorts() method.

Returns:

A list of sorts where each sort specifies a field and their sort order to be applied to the results.

toBuilder

public SearchCasesRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SearchCasesRequest.Builder,SearchCasesRequest>

Specified by:

toBuilder in class ConnectCasesRequest

builder

public static SearchCasesRequest.Builder builder()

serializableBuilderClass

public static Class<? extends SearchCasesRequest.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