Interface SearchFacetsRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<SearchFacetsRequest.Builder,SearchFacetsRequest>, MarketplaceDiscoveryRequest.Builder, SdkBuilder<SearchFacetsRequest.Builder,SearchFacetsRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
SearchFacetsRequest
@Mutable @NotThreadSafe public static interface SearchFacetsRequest.Builder extends MarketplaceDiscoveryRequest.Builder, SdkPojo, CopyableBuilder<SearchFacetsRequest.Builder,SearchFacetsRequest>

  • Method Details

    • locale

      SearchFacetsRequest.Builder locale(String locale)

      A BCP 47 language tag or comma-separated priority list specifying the preferred locale for response content. See Locale for supported values, constraints, fallback behavior, and the default locale. If omitted, the service returns content in the default locale.

      Parameters:
      locale - A BCP 47 language tag or comma-separated priority list specifying the preferred locale for response content. See Locale for supported values, constraints, fallback behavior, and the default locale. If omitted, the service returns content in the default locale.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • searchText

      SearchFacetsRequest.Builder searchText(String searchText)

      The search query text to filter listings before retrieving facets.

      Parameters:
      searchText - The search query text to filter listings before retrieving facets.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • filters

      SearchFacetsRequest.Builder filters(Collection<SearchFilter> filters)

      Filters to apply before retrieving facets. Multiple filters are combined with AND logic. Multiple values within the same filter are combined with OR logic.

      Parameters:
      filters - Filters to apply before retrieving facets. Multiple filters are combined with AND logic. Multiple values within the same filter are combined with OR logic.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • filters

      SearchFacetsRequest.Builder filters(SearchFilter... filters)

      Filters to apply before retrieving facets. Multiple filters are combined with AND logic. Multiple values within the same filter are combined with OR logic.

      Parameters:
      filters - Filters to apply before retrieving facets. Multiple filters are combined with AND logic. Multiple values within the same filter are combined with OR logic.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • filters

      SearchFacetsRequest.Builder filters(Consumer<SearchFilter.Builder>... filters)

      Filters to apply before retrieving facets. Multiple filters are combined with AND logic. Multiple values within the same filter are combined with OR logic.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to filters(List<SearchFilter>).

      Parameters:
      filters - a consumer that will call methods on SearchFilter.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • facetTypesWithStrings

      SearchFacetsRequest.Builder facetTypesWithStrings(Collection<String> facetTypes)

      A list of specific facet types to retrieve. If empty or null, all available facets are returned.

      Parameters:
      facetTypes - A list of specific facet types to retrieve. If empty or null, all available facets are returned.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • facetTypesWithStrings

      SearchFacetsRequest.Builder facetTypesWithStrings(String... facetTypes)

      A list of specific facet types to retrieve. If empty or null, all available facets are returned.

      Parameters:
      facetTypes - A list of specific facet types to retrieve. If empty or null, all available facets are returned.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • facetTypes

      SearchFacetsRequest.Builder facetTypes(Collection<SearchFacetType> facetTypes)

      A list of specific facet types to retrieve. If empty or null, all available facets are returned.

      Parameters:
      facetTypes - A list of specific facet types to retrieve. If empty or null, all available facets are returned.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • facetTypes

      SearchFacetsRequest.Builder facetTypes(SearchFacetType... facetTypes)

      A list of specific facet types to retrieve. If empty or null, all available facets are returned.

      Parameters:
      facetTypes - A list of specific facet types to retrieve. If empty or null, all available facets are returned.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • nextToken

      SearchFacetsRequest.Builder nextToken(String nextToken)

      If nextToken is returned, there are more results available. Make the call again using the returned token to retrieve the next page.

      Parameters:
      nextToken - If nextToken is returned, there are more results available. Make the call again using the returned token to retrieve the next page.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

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

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