Interface SearchAllRelatedItemsRequest.Builder

All Superinterfaces:

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

Enclosing class:

SearchAllRelatedItemsRequest

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

Method Summary

Modifier and Type	Method	Description
SearchAllRelatedItemsRequest.Builder	domainId(String domainId)	The unique identifier of the Cases domain.
SearchAllRelatedItemsRequest.Builder	filters(Collection<RelatedItemTypeFilter> filters)	The list of types of related items and their parameters to use for filtering.
SearchAllRelatedItemsRequest.Builder	filters(Consumer<RelatedItemTypeFilter.Builder>... filters)	The list of types of related items and their parameters to use for filtering.
SearchAllRelatedItemsRequest.Builder	filters(RelatedItemTypeFilter... filters)	The list of types of related items and their parameters to use for filtering.
SearchAllRelatedItemsRequest.Builder	maxResults(Integer maxResults)	The maximum number of results to return per page.
SearchAllRelatedItemsRequest.Builder	nextToken(String nextToken)	The token for the next set of results.
SearchAllRelatedItemsRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
SearchAllRelatedItemsRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
SearchAllRelatedItemsRequest.Builder	sorts(Collection<SearchAllRelatedItemsSort> sorts)	A structured set of sort terms to specify the order in which related items should be returned.
SearchAllRelatedItemsRequest.Builder	sorts(Consumer<SearchAllRelatedItemsSort.Builder>... sorts)	A structured set of sort terms to specify the order in which related items should be returned.
SearchAllRelatedItemsRequest.Builder	sorts(SearchAllRelatedItemsSort... sorts)	A structured set of sort terms to specify the order in which related items should be returned.

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

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

SearchAllRelatedItemsRequest.Builder maxResults(Integer maxResults)

The maximum number of results to return per page.

Parameters:

maxResults - The maximum number of results to return per page.

Returns:

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

nextToken

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

filters

SearchAllRelatedItemsRequest.Builder filters(Collection<RelatedItemTypeFilter> filters)

The list of types of related items and their parameters to use for filtering. The filters work as an OR condition: caller gets back related items that match any of the specified filter types.

Parameters:

filters - The list of types of related items and their parameters to use for filtering. The filters work as an OR condition: caller gets back related items that match any of the specified filter types.

Returns:

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

filters

SearchAllRelatedItemsRequest.Builder filters(RelatedItemTypeFilter... filters)

The list of types of related items and their parameters to use for filtering. The filters work as an OR condition: caller gets back related items that match any of the specified filter types.

Parameters:

filters - The list of types of related items and their parameters to use for filtering. The filters work as an OR condition: caller gets back related items that match any of the specified filter types.

Returns:

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

filters

SearchAllRelatedItemsRequest.Builder filters(Consumer<RelatedItemTypeFilter.Builder>... filters)

The list of types of related items and their parameters to use for filtering. The filters work as an OR condition: caller gets back related items that match any of the specified filter types.

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

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

Parameters:

filters - a consumer that will call methods on RelatedItemTypeFilter.Builder

Returns:

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

See Also:

• filters(java.util.Collection<RelatedItemTypeFilter>)

sorts

SearchAllRelatedItemsRequest.Builder sorts(Collection<SearchAllRelatedItemsSort> sorts)

A structured set of sort terms to specify the order in which related items should be returned. Supports sorting by association time or case ID. The sorts work in the order specified: first sort term takes precedence over subsequent terms.

Parameters:

sorts - A structured set of sort terms to specify the order in which related items should be returned. Supports sorting by association time or case ID. The sorts work in the order specified: first sort term takes precedence over subsequent terms.

Returns:

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

sorts

SearchAllRelatedItemsRequest.Builder sorts(SearchAllRelatedItemsSort... sorts)

A structured set of sort terms to specify the order in which related items should be returned. Supports sorting by association time or case ID. The sorts work in the order specified: first sort term takes precedence over subsequent terms.

Parameters:

sorts - A structured set of sort terms to specify the order in which related items should be returned. Supports sorting by association time or case ID. The sorts work in the order specified: first sort term takes precedence over subsequent terms.

Returns:

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

sorts

SearchAllRelatedItemsRequest.Builder sorts(Consumer<SearchAllRelatedItemsSort.Builder>... sorts)

A structured set of sort terms to specify the order in which related items should be returned. Supports sorting by association time or case ID. The sorts work in the order specified: first sort term takes precedence over subsequent terms.

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

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

Parameters:

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

Returns:

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

See Also:

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

overrideConfiguration

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

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