Interface SearchListingsRequest.Builder

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

  • Method Details

    • 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 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:

    • 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 of MaxResults, the response contains a NextToken value that you can use in a subsequent call to SearchListings to list the next set of results.

      Parameters:
      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 of MaxResults, the response contains a NextToken value that you can use in a subsequent call to SearchListings to 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 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 SearchListings 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 SearchListings to 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)

      The details of the search.

      Parameters:
      searchIn - The details of the search.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • searchIn

      SearchListingsRequest.Builder searchIn(SearchInItem... searchIn)

      The details of the search.

      Parameters:
      searchIn - The details of the search.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • searchIn

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

      The details of the search.

      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<SearchInItem>).

      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:

    • 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 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:

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