software.amazon.awssdk.services.kendra.model

Interface ListFaqsRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<ListFaqsRequest.Builder,ListFaqsRequest>, KendraRequest.Builder, SdkBuilder<ListFaqsRequest.Builder,ListFaqsRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

ListFaqsRequest

public static interface ListFaqsRequest.Builder
extends KendraRequest.Builder, SdkPojo, CopyableBuilder<ListFaqsRequest.Builder,ListFaqsRequest>

Method Summary

Modifier and Type	Method and Description
ListFaqsRequest.Builder	indexId(String indexId) The index that contains the FAQ lists.
ListFaqsRequest.Builder	maxResults(Integer maxResults) The maximum number of FAQs to return in the response.
ListFaqsRequest.Builder	nextToken(String nextToken) If the previous response was incomplete (because there is more data to retrieve), Amazon Kendra returns a pagination token in the response.
ListFaqsRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.
ListFaqsRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.

Methods inherited from interface software.amazon.awssdk.services.kendra.model.KendraRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

indexId

ListFaqsRequest.Builder indexId(String indexId)

The index that contains the FAQ lists.

Parameters:

indexId - The index that contains the FAQ lists.

Returns:

Returns a reference to this object so that method calls can be chained together.

nextToken

ListFaqsRequest.Builder nextToken(String nextToken)

If the previous response was incomplete (because there is more data to retrieve), Amazon Kendra returns a pagination token in the response. You can use this pagination token to retrieve the next set of FAQs.

Parameters:

nextToken - If the previous response was incomplete (because there is more data to retrieve), Amazon Kendra returns a pagination token in the response. You can use this pagination token to retrieve the next set of FAQs.

Returns:

Returns a reference to this object so that method calls can be chained together.

maxResults

ListFaqsRequest.Builder maxResults(Integer maxResults)

The maximum number of FAQs to return in the response. If there are fewer results in the list, this response contains only the actual results.

Parameters:

maxResults - The maximum number of FAQs to return in the response. If there are fewer results in the list, this response contains only the actual results.

Returns:

Returns a reference to this object so that method calls can be chained together.

overrideConfiguration

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

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