Interface SearchListingsResponse.Builder

All Superinterfaces:
AwsResponse.Builder, Buildable, CopyableBuilder<SearchListingsResponse.Builder,SearchListingsResponse>, DataZoneResponse.Builder, SdkBuilder<SearchListingsResponse.Builder,SearchListingsResponse>, SdkPojo, SdkResponse.Builder
Enclosing class:
SearchListingsResponse
@Mutable @NotThreadSafe public static interface SearchListingsResponse.Builder extends DataZoneResponse.Builder, SdkPojo, CopyableBuilder<SearchListingsResponse.Builder,SearchListingsResponse>

  • Method Details

    • aggregates

      SearchListingsResponse.Builder aggregates(Collection<AggregationOutput> aggregates)

      Contains computed counts grouped by field values based on the requested aggregation attributes for the matching listings.

      Parameters:
      aggregates - Contains computed counts grouped by field values based on the requested aggregation attributes for the matching listings.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • aggregates

      SearchListingsResponse.Builder aggregates(AggregationOutput... aggregates)

      Contains computed counts grouped by field values based on the requested aggregation attributes for the matching listings.

      Parameters:
      aggregates - Contains computed counts grouped by field values based on the requested aggregation attributes for the matching listings.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • aggregates

      SearchListingsResponse.Builder aggregates(Consumer<AggregationOutput.Builder>... aggregates)

      Contains computed counts grouped by field values based on the requested aggregation attributes for the matching listings.

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

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

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

    • items

      SearchListingsResponse.Builder items(Collection<SearchResultItem> items)

      The results of the SearchListings action.

      Parameters:
      items - The results of the SearchListings action.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • items

      SearchListingsResponse.Builder items(SearchResultItem... items)

      The results of the SearchListings action.

      Parameters:
      items - The results of the SearchListings action.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • items

      SearchListingsResponse.Builder items(Consumer<SearchResultItem.Builder>... items)

      The results of the SearchListings action.

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

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

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

    • nextToken

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

    • totalMatchCount

      SearchListingsResponse.Builder totalMatchCount(Integer totalMatchCount)

      Total number of search results.

      Parameters:
      totalMatchCount - Total number of search results.
      Returns:
      Returns a reference to this object so that method calls can be chained together.