Interface SearchListingsRequest.Builder
-
- All Superinterfaces:
AwsRequest.Builder,Buildable,CopyableBuilder<SearchListingsRequest.Builder,SearchListingsRequest>,DataZoneRequest.Builder,SdkBuilder<SearchListingsRequest.Builder,SearchListingsRequest>,SdkPojo,SdkRequest.Builder
- Enclosing class:
- SearchListingsRequest
public static interface SearchListingsRequest.Builder extends DataZoneRequest.Builder, SdkPojo, CopyableBuilder<SearchListingsRequest.Builder,SearchListingsRequest>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description SearchListingsRequest.BuilderadditionalAttributes(Collection<SearchOutputAdditionalAttribute> additionalAttributes)Specifies additional attributes for the search.SearchListingsRequest.BuilderadditionalAttributes(SearchOutputAdditionalAttribute... additionalAttributes)Specifies additional attributes for the search.SearchListingsRequest.BuilderadditionalAttributesWithStrings(String... additionalAttributes)Specifies additional attributes for the search.SearchListingsRequest.BuilderadditionalAttributesWithStrings(Collection<String> additionalAttributes)Specifies additional attributes for the search.SearchListingsRequest.BuilderdomainIdentifier(String domainIdentifier)The identifier of the domain in which to search listings.default SearchListingsRequest.Builderfilters(Consumer<FilterClause.Builder> filters)Specifies the filters for the search of listings.SearchListingsRequest.Builderfilters(FilterClause filters)Specifies the filters for the search of listings.SearchListingsRequest.BuildermaxResults(Integer maxResults)The maximum number of results to return in a single call toSearchListings.SearchListingsRequest.BuildernextToken(String nextToken)When the number of results is greater than the default value for theMaxResultsparameter, or if you explicitly specify a value forMaxResultsthat is less than the number of results, the response includes a pagination token namedNextToken.SearchListingsRequest.BuilderoverrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)SearchListingsRequest.BuilderoverrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)SearchListingsRequest.BuildersearchIn(Collection<SearchInItem> searchIn)SearchListingsRequest.BuildersearchIn(Consumer<SearchInItem.Builder>... searchIn)This is a convenience method that creates an instance of theSearchInItem.Builderavoiding the need to create one manually viaSearchInItem.builder().SearchListingsRequest.BuildersearchIn(SearchInItem... searchIn)SearchListingsRequest.BuildersearchText(String searchText)Specifies the text for which to search.default SearchListingsRequest.Buildersort(Consumer<SearchSort.Builder> sort)Specifies the way for sorting the search results.SearchListingsRequest.Buildersort(SearchSort sort)Specifies the way for sorting the search results.-
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
SearchListingsRequest.Builder additionalAttributesWithStrings(Collection<String> additionalAttributes)
Specifies additional attributes for the search.
- Parameters:
additionalAttributes- Specifies additional attributes for the search.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
additionalAttributesWithStrings
SearchListingsRequest.Builder additionalAttributesWithStrings(String... additionalAttributes)
Specifies additional attributes for the search.
- Parameters:
additionalAttributes- Specifies additional attributes for the search.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
additionalAttributes
SearchListingsRequest.Builder additionalAttributes(Collection<SearchOutputAdditionalAttribute> additionalAttributes)
Specifies additional attributes for the search.
- Parameters:
additionalAttributes- Specifies additional attributes for the search.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
additionalAttributes
SearchListingsRequest.Builder additionalAttributes(SearchOutputAdditionalAttribute... additionalAttributes)
Specifies additional attributes for the search.
- Parameters:
additionalAttributes- Specifies additional attributes for the search.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
domainIdentifier
SearchListingsRequest.Builder domainIdentifier(String domainIdentifier)
The identifier of the domain in which to search listings.
- Parameters:
domainIdentifier- The identifier of the domain in which to search listings.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
filters
SearchListingsRequest.Builder filters(FilterClause filters)
Specifies the filters for the search of listings.
- Parameters:
filters- Specifies the filters for the search of listings.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
filters
default SearchListingsRequest.Builder filters(Consumer<FilterClause.Builder> filters)
Specifies the filters for the search of listings.
This is a convenience method that creates an instance of theFilterClause.Builderavoiding the need to create one manually viaFilterClause.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tofilters(FilterClause).- Parameters:
filters- a consumer that will call methods onFilterClause.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
filters(FilterClause)
-
maxResults
SearchListingsRequest.Builder maxResults(Integer maxResults)
The maximum number of results to return in a single call to
SearchListings. When the number of results to be listed is greater than the value ofMaxResults, the response contains aNextTokenvalue that you can use in a subsequent call toSearchListingsto list the next set of results.- Parameters:
maxResults- The maximum number of results to return in a single call toSearchListings. When the number of results to be listed is greater than the value ofMaxResults, the response contains aNextTokenvalue that you can use in a subsequent call toSearchListingsto list the next set of results.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
nextToken
SearchListingsRequest.Builder nextToken(String nextToken)
When the number of results is greater than the default value for the
MaxResultsparameter, or if you explicitly specify a value forMaxResultsthat is less than the number of results, the response includes a pagination token namedNextToken. You can specify thisNextTokenvalue in a subsequent call toSearchListingsto list the next set of results.- Parameters:
nextToken- When the number of results is greater than the default value for theMaxResultsparameter, or if you explicitly specify a value forMaxResultsthat is less than the number of results, the response includes a pagination token namedNextToken. You can specify thisNextTokenvalue in a subsequent call toSearchListingsto list the next set of results.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
searchIn
SearchListingsRequest.Builder searchIn(Collection<SearchInItem> searchIn)
- Parameters:
searchIn-- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
searchIn
SearchListingsRequest.Builder searchIn(SearchInItem... searchIn)
- Parameters:
searchIn-- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
searchIn
SearchListingsRequest.Builder searchIn(Consumer<SearchInItem.Builder>... searchIn)
This is a convenience method that creates an instance of theSearchInItem.Builderavoiding the need to create one manually viaSearchInItem.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed to#searchIn(List.) - Parameters:
searchIn- a consumer that will call methods onSearchInItem.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
#searchIn(java.util.Collection)
-
searchText
SearchListingsRequest.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
SearchListingsRequest.Builder sort(SearchSort sort)
Specifies the way for sorting the search results.
- Parameters:
sort- Specifies the way for sorting the search results.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
sort
default SearchListingsRequest.Builder sort(Consumer<SearchSort.Builder> sort)
Specifies the way for sorting the search results.
This is a convenience method that creates an instance of theSearchSort.Builderavoiding the need to create one manually viaSearchSort.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tosort(SearchSort).- Parameters:
sort- a consumer that will call methods onSearchSort.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
sort(SearchSort)
-
overrideConfiguration
SearchListingsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder
-
overrideConfiguration
SearchListingsRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder
-
-