Interface SearchResponse.Builder

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

  • Method Details

    • count

      SearchResponse.Builder count(ResourceCount count)

      The number of resources that match the query.

      Parameters:
      count - The number of resources that match the query.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • count

      default SearchResponse.Builder count(Consumer<ResourceCount.Builder> count)

      The number of resources that match the query.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to count(ResourceCount).

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

    • nextToken

      SearchResponse.Builder nextToken(String nextToken)

      If present, indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null. The pagination tokens expire after 24 hours.

      Parameters:
      nextToken - If present, indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null. The pagination tokens expire after 24 hours.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • resources

      SearchResponse.Builder resources(Collection<Resource> resources)

      The list of structures that describe the resources that match the query.

      Parameters:
      resources - The list of structures that describe the resources that match the query.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • resources

      SearchResponse.Builder resources(Resource... resources)

      The list of structures that describe the resources that match the query.

      Parameters:
      resources - The list of structures that describe the resources that match the query.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • resources

      SearchResponse.Builder resources(Consumer<Resource.Builder>... resources)

      The list of structures that describe the resources that match the query.

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

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

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

    • viewArn

      SearchResponse.Builder viewArn(String viewArn)

      The Amazon resource name (ARN) of the view that this operation used to perform the search.

      Parameters:
      viewArn - The Amazon resource name (ARN) of the view that this operation used to perform the search.
      Returns:
      Returns a reference to this object so that method calls can be chained together.