Interface SearchIndexRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<SearchIndexRequest.Builder,SearchIndexRequest>, IotRequest.Builder, SdkBuilder<SearchIndexRequest.Builder,SearchIndexRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
SearchIndexRequest
public static interface SearchIndexRequest.Builder extends IotRequest.Builder, SdkPojo, CopyableBuilder<SearchIndexRequest.Builder,SearchIndexRequest>

  • Method Details

    • indexName

      SearchIndexRequest.Builder indexName(String indexName)

      The search index name.

      Parameters:
      indexName - The search index name.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • queryString

      SearchIndexRequest.Builder queryString(String queryString)

      The search query string. For more information about the search query syntax, see Query syntax.

      Parameters:
      queryString - The search query string. For more information about the search query syntax, see Query syntax.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • nextToken

      SearchIndexRequest.Builder nextToken(String nextToken)

      The token used to get the next set of results, or null if there are no additional results.

      Parameters:
      nextToken - The token used to get the next set of results, or null if there are no additional results.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • maxResults

      SearchIndexRequest.Builder maxResults(Integer maxResults)

      The maximum number of results to return per page at one time. This maximum number cannot exceed 100. The response might contain fewer results but will never contain more. You can use nextToken to retrieve the next set of results until nextToken returns NULL.

      Parameters:
      maxResults - The maximum number of results to return per page at one time. This maximum number cannot exceed 100. The response might contain fewer results but will never contain more. You can use nextToken to retrieve the next set of results until nextToken returns NULL.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • queryVersion

      SearchIndexRequest.Builder queryVersion(String queryVersion)

      The query version.

      Parameters:
      queryVersion - The query version.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

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

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