Interface SearchRelatedItemsRequest.Builder

All Superinterfaces:

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

Enclosing class:

SearchRelatedItemsRequest

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

Method Summary

Modifier and Type	Method	Description
SearchRelatedItemsRequest.Builder	caseId(String caseId)	A unique identifier of the case.
SearchRelatedItemsRequest.Builder	domainId(String domainId)	The unique identifier of the Cases domain.
SearchRelatedItemsRequest.Builder	filters(Collection<RelatedItemTypeFilter> filters)	The list of types of related items and their parameters to use for filtering.
SearchRelatedItemsRequest.Builder	filters(Consumer<RelatedItemTypeFilter.Builder>... filters)	The list of types of related items and their parameters to use for filtering.
SearchRelatedItemsRequest.Builder	filters(RelatedItemTypeFilter... filters)	The list of types of related items and their parameters to use for filtering.
SearchRelatedItemsRequest.Builder	maxResults(Integer maxResults)	The maximum number of results to return per page.
SearchRelatedItemsRequest.Builder	nextToken(String nextToken)	The token for the next set of results.
SearchRelatedItemsRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
SearchRelatedItemsRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.

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

caseId

SearchRelatedItemsRequest.Builder caseId(String caseId)

A unique identifier of the case.

Parameters:

caseId - A unique identifier of the case.

Returns:

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

domainId

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

filters

SearchRelatedItemsRequest.Builder filters(Collection<RelatedItemTypeFilter> filters)

The list of types of related items and their parameters to use for filtering.

Parameters:

filters - The list of types of related items and their parameters to use for filtering.

Returns:

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

filters

SearchRelatedItemsRequest.Builder filters(RelatedItemTypeFilter... filters)

The list of types of related items and their parameters to use for filtering.

Parameters:

filters - The list of types of related items and their parameters to use for filtering.

Returns:

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

filters

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

The list of types of related items and their parameters to use for filtering.

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>)

maxResults

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

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

overrideConfiguration

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

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