com.amazonaws.services.kendra.model

Class ListFaqsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.kendra.model.ListFaqsRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ListFaqsRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
ListFaqsRequest()

Method Summary

Modifier and Type	Method and Description
ListFaqsRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getIndexId() The index that contains the FAQ lists.
Integer	getMaxResults() The maximum number of FAQs to return in the response.
String	getNextToken() If the previous response was incomplete (because there is more data to retrieve), Amazon Kendra returns a pagination token in the response.
int	hashCode()
void	setIndexId(String indexId) The index that contains the FAQ lists.
void	setMaxResults(Integer maxResults) The maximum number of FAQs to return in the response.
void	setNextToken(String nextToken) If the previous response was incomplete (because there is more data to retrieve), Amazon Kendra returns a pagination token in the response.
String	toString() Returns a string representation of this object.
ListFaqsRequest	withIndexId(String indexId) The index that contains the FAQ lists.
ListFaqsRequest	withMaxResults(Integer maxResults) The maximum number of FAQs to return in the response.
ListFaqsRequest	withNextToken(String nextToken) If the previous response was incomplete (because there is more data to retrieve), Amazon Kendra returns a pagination token in the response.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ListFaqsRequest

public ListFaqsRequest()

Method Detail

setIndexId

public void setIndexId(String indexId)

The index that contains the FAQ lists.

Parameters:

indexId - The index that contains the FAQ lists.

getIndexId

public String getIndexId()

The index that contains the FAQ lists.

Returns:

The index that contains the FAQ lists.

withIndexId

public ListFaqsRequest withIndexId(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.

setNextToken

public void setNextToken(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.

getNextToken

public String getNextToken()

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.

withNextToken

public ListFaqsRequest withNextToken(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.

setMaxResults

public void setMaxResults(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.

getMaxResults

public Integer getMaxResults()

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.

withMaxResults

public ListFaqsRequest withMaxResults(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.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public ListFaqsRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()