Interface SearchCasesRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, ConnectCasesRequest.Builder, CopyableBuilder<SearchCasesRequest.Builder,SearchCasesRequest>, SdkBuilder<SearchCasesRequest.Builder,SearchCasesRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

SearchCasesRequest

@Mutable
@NotThreadSafe
public static interface SearchCasesRequest.Builder
extends ConnectCasesRequest.Builder, SdkPojo, CopyableBuilder<SearchCasesRequest.Builder,SearchCasesRequest>

Method Summary

Modifier and Type	Method	Description
SearchCasesRequest.Builder	domainId(String domainId)	The unique identifier of the Cases domain.
SearchCasesRequest.Builder	fields(Collection<FieldIdentifier> fields)	The list of field identifiers to be returned as part of the response.
SearchCasesRequest.Builder	fields(Consumer<FieldIdentifier.Builder>... fields)	The list of field identifiers to be returned as part of the response.
SearchCasesRequest.Builder	fields(FieldIdentifier... fields)	The list of field identifiers to be returned as part of the response.
default SearchCasesRequest.Builder	filter(Consumer<CaseFilter.Builder> filter)	A list of filter objects.
SearchCasesRequest.Builder	filter(CaseFilter filter)	A list of filter objects.
SearchCasesRequest.Builder	maxResults(Integer maxResults)	The maximum number of cases to return.
SearchCasesRequest.Builder	nextToken(String nextToken)	The token for the next set of results.
SearchCasesRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
SearchCasesRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
SearchCasesRequest.Builder	searchTerm(String searchTerm)	A word or phrase used to perform a quick search.
SearchCasesRequest.Builder	sorts(Collection<Sort> sorts)	A list of sorts where each sort specifies a field and their sort order to be applied to the results.
SearchCasesRequest.Builder	sorts(Consumer<Sort.Builder>... sorts)	A list of sorts where each sort specifies a field and their sort order to be applied to the results.
SearchCasesRequest.Builder	sorts(Sort... sorts)	A list of sorts where each sort specifies a field and their sort order to be applied to the results.

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.services.connectcases.model.ConnectCasesRequest.Builder

build

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

copy

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

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Details

domainId

SearchCasesRequest.Builder domainId(String domainId)

The unique identifier of the Cases domain.

Parameters:

domainId - The unique identifier of the Cases domain.

Returns:

Returns a reference to this object so that method calls can be chained together.

maxResults

SearchCasesRequest.Builder maxResults(Integer maxResults)

The maximum number of cases to return. When no value is provided, 25 is the default.

Parameters:

maxResults - The maximum number of cases to return. When no value is provided, 25 is the default.

Returns:

Returns a reference to this object so that method calls can be chained together.

nextToken

SearchCasesRequest.Builder nextToken(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

searchTerm

SearchCasesRequest.Builder searchTerm(String searchTerm)

A word or phrase used to perform a quick search.

Parameters:

searchTerm - A word or phrase used to perform a quick search.

Returns:

Returns a reference to this object so that method calls can be chained together.

filter

SearchCasesRequest.Builder filter(CaseFilter filter)

A list of filter objects.

Parameters:

filter - A list of filter objects.

Returns:

Returns a reference to this object so that method calls can be chained together.

filter

default SearchCasesRequest.Builder filter(Consumer<CaseFilter.Builder> filter)

A list of filter objects.

This is a convenience method that creates an instance of the CaseFilter.Builder avoiding the need to create one manually via CaseFilter.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to filter(CaseFilter).

Parameters:

filter - a consumer that will call methods on CaseFilter.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• filter(CaseFilter)

sorts

SearchCasesRequest.Builder sorts(Collection<Sort> sorts)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

sorts

SearchCasesRequest.Builder sorts(Sort... sorts)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

sorts

SearchCasesRequest.Builder sorts(Consumer<Sort.Builder>... sorts)

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

This is a convenience method that creates an instance of the Sort.Builder avoiding the need to create one manually via Sort.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to sorts(List<Sort>).

Parameters:

sorts - a consumer that will call methods on Sort.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• sorts(java.util.Collection<Sort>)

fields

SearchCasesRequest.Builder fields(Collection<FieldIdentifier> fields)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

fields

SearchCasesRequest.Builder fields(FieldIdentifier... fields)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

fields

SearchCasesRequest.Builder fields(Consumer<FieldIdentifier.Builder>... fields)

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

This is a convenience method that creates an instance of the FieldIdentifier.Builder avoiding the need to create one manually via FieldIdentifier.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to fields(List<FieldIdentifier>).

Parameters:

fields - a consumer that will call methods on FieldIdentifier.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• fields(java.util.Collection<FieldIdentifier>)

overrideConfiguration

SearchCasesRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

SearchCasesRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.