Interface SearchAllRelatedItemsRequest.Builder
- All Superinterfaces:
AwsRequest.Builder,Buildable,ConnectCasesRequest.Builder,CopyableBuilder<SearchAllRelatedItemsRequest.Builder,,SearchAllRelatedItemsRequest> SdkBuilder<SearchAllRelatedItemsRequest.Builder,,SearchAllRelatedItemsRequest> SdkPojo,SdkRequest.Builder
- Enclosing class:
SearchAllRelatedItemsRequest
-
Method Summary
Modifier and TypeMethodDescriptionThe unique identifier of the Cases domain.filters(Collection<RelatedItemTypeFilter> filters) The list of types of related items and their parameters to use for filtering.filters(Consumer<RelatedItemTypeFilter.Builder>... filters) The list of types of related items and their parameters to use for filtering.filters(RelatedItemTypeFilter... filters) The list of types of related items and their parameters to use for filtering.maxResults(Integer maxResults) The maximum number of results to return per page.The token for the next set of results.overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.sorts(Collection<SearchAllRelatedItemsSort> sorts) A structured set of sort terms to specify the order in which related items should be returned.sorts(Consumer<SearchAllRelatedItemsSort.Builder>... sorts) A structured set of sort terms to specify the order in which related items should be returned.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
overrideConfigurationMethods inherited from interface software.amazon.awssdk.services.connectcases.model.ConnectCasesRequest.Builder
buildMethods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copyMethods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, buildMethods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
-
Method Details
-
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
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
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
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
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
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 theRelatedItemTypeFilter.Builderavoiding the need to create one manually viaRelatedItemTypeFilter.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tofilters(List<RelatedItemTypeFilter>).- Parameters:
filters- a consumer that will call methods onRelatedItemTypeFilter.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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
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 theSearchAllRelatedItemsSort.Builderavoiding the need to create one manually viaSearchAllRelatedItemsSort.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tosorts(List<SearchAllRelatedItemsSort>).- Parameters:
sorts- a consumer that will call methods onSearchAllRelatedItemsSort.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
overrideConfiguration
SearchAllRelatedItemsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.BuilderAdd an optional request override configuration.- Specified by:
overrideConfigurationin interfaceAwsRequest.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.BuilderAdd an optional request override configuration.- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder- Parameters:
builderConsumer- AConsumerto which an emptyAwsRequestOverrideConfiguration.Builderwill be given.- Returns:
- This object for method chaining.
-