Package software.amazon.awssdk.services.servicecatalog.model

Interface SearchProductsRequest.Builder

All Superinterfaces:

CopyableBuilder<SearchProductsRequest.Builder,SearchProductsRequest>, SdkBuilder<SearchProductsRequest.Builder,SearchProductsRequest>

Enclosing class:

SearchProductsRequest

public static interface SearchProductsRequest.Builder
extends CopyableBuilder<SearchProductsRequest.Builder,SearchProductsRequest>

Method Summary

Modifier and Type	Method	Description
SearchProductsRequest.Builder	acceptLanguage(String acceptLanguage)	The language code to use for this operation.
SearchProductsRequest.Builder	filters(Map<String,? extends Collection<String>> filters)	The list of filters with which to limit search results.
SearchProductsRequest.Builder	pageSize(Integer pageSize)	The maximum number of items to return in the results.
SearchProductsRequest.Builder	pageToken(String pageToken)	The page token of the first page retrieved.
SearchProductsRequest.Builder	sortBy(String sortBy)	The sort field specifier.
SearchProductsRequest.Builder	sortBy(ProductViewSortBy sortBy)	The sort field specifier.
SearchProductsRequest.Builder	sortOrder(String sortOrder)	The sort order specifier.
SearchProductsRequest.Builder	sortOrder(SortOrder sortOrder)	The sort order specifier.

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

copy

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

apply, build

Method Detail

acceptLanguage

SearchProductsRequest.Builder acceptLanguage(String acceptLanguage)

The language code to use for this operation. Supported language codes are as follows:

"en" (English)

"jp" (Japanese)

"zh" (Chinese)

If no code is specified, "en" is used as the default.

Parameters:

acceptLanguage - The language code to use for this operation. Supported language codes are as follows:

"en" (English)

"jp" (Japanese)

"zh" (Chinese)

If no code is specified, "en" is used as the default.

Returns:

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

filters

SearchProductsRequest.Builder filters(Map<String,? extends Collection<String>> filters)

The list of filters with which to limit search results. If no search filters are specified, the output is all the products to which the calling user has access.

Parameters:

filters - The list of filters with which to limit search results. If no search filters are specified, the output is all the products to which the calling user has access.

Returns:

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

pageSize

SearchProductsRequest.Builder pageSize(Integer pageSize)

The maximum number of items to return in the results. If more results exist than fit in the specified PageSize, the value of NextPageToken in the response is non-null.

Parameters:

pageSize - The maximum number of items to return in the results. If more results exist than fit in the specified PageSize, the value of NextPageToken in the response is non-null.

Returns:

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

sortBy

SearchProductsRequest.Builder sortBy(String sortBy)

The sort field specifier. If no value is specified, results are not sorted.

Parameters:

sortBy - The sort field specifier. If no value is specified, results are not sorted.

Returns:

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

See Also:

ProductViewSortBy

sortBy

SearchProductsRequest.Builder sortBy(ProductViewSortBy sortBy)

The sort field specifier. If no value is specified, results are not sorted.

Parameters:

sortBy - The sort field specifier. If no value is specified, results are not sorted.

Returns:

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

See Also:

ProductViewSortBy

sortOrder

SearchProductsRequest.Builder sortOrder(String sortOrder)

The sort order specifier. If no value is specified, results are not sorted.

Parameters:

sortOrder - The sort order specifier. If no value is specified, results are not sorted.

Returns:

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

See Also:

SortOrder

sortOrder

SearchProductsRequest.Builder sortOrder(SortOrder sortOrder)

The sort order specifier. If no value is specified, results are not sorted.

Parameters:

sortOrder - The sort order specifier. If no value is specified, results are not sorted.

Returns:

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

See Also:

SortOrder

pageToken

SearchProductsRequest.Builder pageToken(String pageToken)

The page token of the first page retrieved. If null, this retrieves the first page of size PageSize.

Parameters:

pageToken - The page token of the first page retrieved. If null, this retrieves the first page of size PageSize.

Returns:

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