Interface SearchListingsRequest.Builder

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

  • Method Details

    • searchText

      SearchListingsRequest.Builder searchText(String searchText)

      The search query text to find relevant listings.

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

    • filters

      SearchListingsRequest.Builder filters(Collection<SearchFilter> filters)

      Filters to narrow search results. Multiple filters are combined with AND logic. Multiple values within the same filter are combined with OR logic.

      Parameters:
      filters - Filters to narrow search results. 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

      SearchListingsRequest.Builder filters(SearchFilter... filters)

      Filters to narrow search results. Multiple filters are combined with AND logic. Multiple values within the same filter are combined with OR logic.

      Parameters:
      filters - Filters to narrow search results. 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

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

      Filters to narrow search results. 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:

    • maxResults

      SearchListingsRequest.Builder maxResults(Integer maxResults)

      The maximum number of results that are returned per call. You can use nextToken to get more results.

      Parameters:
      maxResults - The maximum number of results that are returned per call. You can use nextToken to get more results.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sortBy

      SearchListingsRequest.Builder sortBy(String sortBy)

      The field to sort results by. Valid values are RELEVANCE and AVERAGE_CUSTOMER_RATING.

      Parameters:
      sortBy - The field to sort results by. Valid values are RELEVANCE and AVERAGE_CUSTOMER_RATING.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • sortBy

      SearchListingsRequest.Builder sortBy(SearchListingsSortBy sortBy)

      The field to sort results by. Valid values are RELEVANCE and AVERAGE_CUSTOMER_RATING.

      Parameters:
      sortBy - The field to sort results by. Valid values are RELEVANCE and AVERAGE_CUSTOMER_RATING.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • sortOrder

      SearchListingsRequest.Builder sortOrder(String sortOrder)

      The sort direction. Valid values are DESCENDING and ASCENDING.

      Parameters:
      sortOrder - The sort direction. Valid values are DESCENDING and ASCENDING.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • sortOrder

      SearchListingsRequest.Builder sortOrder(SearchListingsSortOrder sortOrder)

      The sort direction. Valid values are DESCENDING and ASCENDING.

      Parameters:
      sortOrder - The sort direction. Valid values are DESCENDING and ASCENDING.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • nextToken

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

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

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