Package software.amazon.awssdk.services.datazone.model

Interface SearchRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<SearchRequest.Builder,SearchRequest>, DataZoneRequest.Builder, SdkBuilder<SearchRequest.Builder,SearchRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

SearchRequest

public static interface SearchRequest.Builder
extends DataZoneRequest.Builder, SdkPojo, CopyableBuilder<SearchRequest.Builder,SearchRequest>

Method Summary

Modifier and Type	Method	Description
SearchRequest.Builder	additionalAttributes(Collection<SearchOutputAdditionalAttribute> additionalAttributes)	Specifies additional attributes for the Search action.
SearchRequest.Builder	additionalAttributes(SearchOutputAdditionalAttribute... additionalAttributes)	Specifies additional attributes for the Search action.
SearchRequest.Builder	additionalAttributesWithStrings(String... additionalAttributes)	Specifies additional attributes for the Search action.
SearchRequest.Builder	additionalAttributesWithStrings(Collection<String> additionalAttributes)	Specifies additional attributes for the Search action.
SearchRequest.Builder	domainIdentifier(String domainIdentifier)	The identifier of the Amazon DataZone domain.
default SearchRequest.Builder	filters(Consumer<FilterClause.Builder> filters)	Specifies the search filters.
SearchRequest.Builder	filters(FilterClause filters)	Specifies the search filters.
SearchRequest.Builder	maxResults(Integer maxResults)	The maximum number of results to return in a single call to Search.
SearchRequest.Builder	nextToken(String nextToken)	When the number of results is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of results, the response includes a pagination token named NextToken.
SearchRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
SearchRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
SearchRequest.Builder	owningProjectIdentifier(String owningProjectIdentifier)	The identifier of the owning project specified for the search.
SearchRequest.Builder	searchIn(Collection<SearchInItem> searchIn)
SearchRequest.Builder	searchIn(Consumer<SearchInItem.Builder>... searchIn)	This is a convenience method that creates an instance of the SearchInItem.Builder avoiding the need to create one manually via SearchInItem.builder().
SearchRequest.Builder	searchIn(SearchInItem... searchIn)
SearchRequest.Builder	searchScope(String searchScope)	The scope of the search.
SearchRequest.Builder	searchScope(InventorySearchScope searchScope)	The scope of the search.
SearchRequest.Builder	searchText(String searchText)	Specifies the text for which to search.
default SearchRequest.Builder	sort(Consumer<SearchSort.Builder> sort)	Specifies the way in which the search results are to be sorted.
SearchRequest.Builder	sort(SearchSort sort)	Specifies the way in which the search results are to be sorted.

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

overrideConfiguration

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

copy

Methods inherited from interface software.amazon.awssdk.services.datazone.model.DataZoneRequest.Builder

build

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

applyMutation, build

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

equalsBySdkFields, sdkFields

Method Detail

additionalAttributesWithStrings

SearchRequest.Builder additionalAttributesWithStrings(Collection<String> additionalAttributes)

Specifies additional attributes for the Search action.

Parameters:

additionalAttributes - Specifies additional attributes for the Search action.

Returns:

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

additionalAttributesWithStrings

SearchRequest.Builder additionalAttributesWithStrings(String... additionalAttributes)

Specifies additional attributes for the Search action.

Parameters:

additionalAttributes - Specifies additional attributes for the Search action.

Returns:

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

additionalAttributes

SearchRequest.Builder additionalAttributes(Collection<SearchOutputAdditionalAttribute> additionalAttributes)

Specifies additional attributes for the Search action.

Parameters:

additionalAttributes - Specifies additional attributes for the Search action.

Returns:

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

additionalAttributes

SearchRequest.Builder additionalAttributes(SearchOutputAdditionalAttribute... additionalAttributes)

Specifies additional attributes for the Search action.

Parameters:

additionalAttributes - Specifies additional attributes for the Search action.

Returns:

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

domainIdentifier

SearchRequest.Builder domainIdentifier(String domainIdentifier)

The identifier of the Amazon DataZone domain.

Parameters:

domainIdentifier - The identifier of the Amazon DataZone domain.

Returns:

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

filters

SearchRequest.Builder filters(FilterClause filters)

Specifies the search filters.

Parameters:

filters - Specifies the search filters.

Returns:

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

filters

default SearchRequest.Builder filters(Consumer<FilterClause.Builder> filters)

Specifies the search filters.

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

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

Parameters:

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

Returns:

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

See Also:

filters(FilterClause)

maxResults

SearchRequest.Builder maxResults(Integer maxResults)

The maximum number of results to return in a single call to Search. When the number of results to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to Search to list the next set of results.

Parameters:

maxResults - The maximum number of results to return in a single call to Search. When the number of results to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to Search to list the next set of results.

Returns:

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

nextToken

SearchRequest.Builder nextToken(String nextToken)

When the number of results is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of results, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to Search to list the next set of results.

Parameters:

nextToken - When the number of results is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of results, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to Search to list the next set of results.

Returns:

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

owningProjectIdentifier

SearchRequest.Builder owningProjectIdentifier(String owningProjectIdentifier)

The identifier of the owning project specified for the search.

Parameters:

owningProjectIdentifier - The identifier of the owning project specified for the search.

Returns:

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

searchIn

SearchRequest.Builder searchIn(Collection<SearchInItem> searchIn)

Parameters:

searchIn -

Returns:

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

searchIn

SearchRequest.Builder searchIn(SearchInItem... searchIn)

Parameters:

searchIn -

Returns:

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

searchIn

SearchRequest.Builder searchIn(Consumer<SearchInItem.Builder>... searchIn)

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #searchIn(List).

Parameters:

searchIn - a consumer that will call methods on SearchInItem.Builder

Returns:

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

See Also:

#searchIn(java.util.Collection)

searchScope

SearchRequest.Builder searchScope(String searchScope)

The scope of the search.

Parameters:

searchScope - The scope of the search.

Returns:

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

See Also:

InventorySearchScope, InventorySearchScope

searchScope

SearchRequest.Builder searchScope(InventorySearchScope searchScope)

The scope of the search.

Parameters:

searchScope - The scope of the search.

Returns:

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

See Also:

InventorySearchScope, InventorySearchScope

searchText

SearchRequest.Builder searchText(String searchText)

Specifies the text for which to search.

Parameters:

searchText - Specifies the text for which to search.

Returns:

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

sort

SearchRequest.Builder sort(SearchSort sort)

Specifies the way in which the search results are to be sorted.

Parameters:

sort - Specifies the way in which the search results are to be sorted.

Returns:

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

sort

default SearchRequest.Builder sort(Consumer<SearchSort.Builder> sort)

Specifies the way in which the search results are to be sorted.

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

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

Parameters:

sort - a consumer that will call methods on SearchSort.Builder

Returns:

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

See Also:

sort(SearchSort)

overrideConfiguration

SearchRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

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

Specified by:

overrideConfiguration in interface AwsRequest.Builder