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 Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description SearchIndexRequest.BuilderindexName(String indexName)The search index name.SearchIndexRequest.BuildermaxResults(Integer maxResults)The maximum number of results to return per page at one time.SearchIndexRequest.BuildernextToken(String nextToken)The token used to get the next set of results, ornullif there are no additional results.SearchIndexRequest.BuilderoverrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)SearchIndexRequest.BuilderoverrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)SearchIndexRequest.BuilderqueryString(String queryString)The search query string.SearchIndexRequest.BuilderqueryVersion(String queryVersion)The query version.-
Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
-
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
-
Methods inherited from interface software.amazon.awssdk.services.iot.model.IotRequest.Builder
build
-
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
-
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
-
-
-
Method Detail
-
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
nullif there are no additional results.- Parameters:
nextToken- The token used to get the next set of results, ornullif 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
nextTokento retrieve the next set of results untilnextTokenreturnsNULL.- 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 usenextTokento retrieve the next set of results untilnextTokenreturnsNULL.- 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)
- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder
-
overrideConfiguration
SearchIndexRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder
-
-