software.amazon.awssdk.services.kendra.model

Class ListFaqsRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.kendra.model.KendraRequest

software.amazon.awssdk.services.kendra.model.ListFaqsRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListFaqsRequest.Builder,ListFaqsRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class ListFaqsRequest
extends KendraRequest
implements ToCopyableBuilder<ListFaqsRequest.Builder,ListFaqsRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ListFaqsRequest.Builder

Method Summary

Modifier and Type	Method and Description
static ListFaqsRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	indexId() The index that contains the FAQ lists.
Integer	maxResults() The maximum number of FAQs to return in the response.
String	nextToken() If the previous response was incomplete (because there is more data to retrieve), Amazon Kendra returns a pagination token in the response.
List<SdkField<?>>	sdkFields()
static Class<? extends ListFaqsRequest.Builder>	serializableBuilderClass()
ListFaqsRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

indexId

public final String indexId()

The index that contains the FAQ lists.

Returns:

The index that contains the FAQ lists.

nextToken

public final 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.

Returns:

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.

maxResults

public final 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.

Returns:

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.

toBuilder

public ListFaqsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ListFaqsRequest.Builder,ListFaqsRequest>

Specified by:

toBuilder in class KendraRequest

builder

public static ListFaqsRequest.Builder builder()

serializableBuilderClass

public static Class<? extends ListFaqsRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo