com.amazonaws.services.kendra.model

Class CreateFaqRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.kendra.model.CreateFaqRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateFaqRequest
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
CreateFaqRequest()

Method Summary

Modifier and Type	Method and Description
CreateFaqRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getClientToken() A token that you provide to identify the request to create a FAQ.
String	getDescription() A description for the FAQ.
String	getFileFormat() The format of the FAQ input file.
String	getIndexId() The identifier of the index for the FAQ.
String	getLanguageCode() The code for a language.
String	getName() A name for the FAQ.
String	getRoleArn() The Amazon Resource Name (ARN) of an IAM role with permission to access the S3 bucket that contains the FAQs.
S3Path	getS3Path() The path to the FAQ file in S3.
List<Tag>	getTags() A list of key-value pairs that identify the FAQ.
int	hashCode()
void	setClientToken(String clientToken) A token that you provide to identify the request to create a FAQ.
void	setDescription(String description) A description for the FAQ.
void	setFileFormat(String fileFormat) The format of the FAQ input file.
void	setIndexId(String indexId) The identifier of the index for the FAQ.
void	setLanguageCode(String languageCode) The code for a language.
void	setName(String name) A name for the FAQ.
void	setRoleArn(String roleArn) The Amazon Resource Name (ARN) of an IAM role with permission to access the S3 bucket that contains the FAQs.
void	setS3Path(S3Path s3Path) The path to the FAQ file in S3.
void	setTags(Collection<Tag> tags) A list of key-value pairs that identify the FAQ.
String	toString() Returns a string representation of this object.
CreateFaqRequest	withClientToken(String clientToken) A token that you provide to identify the request to create a FAQ.
CreateFaqRequest	withDescription(String description) A description for the FAQ.
CreateFaqRequest	withFileFormat(FaqFileFormat fileFormat) The format of the FAQ input file.
CreateFaqRequest	withFileFormat(String fileFormat) The format of the FAQ input file.
CreateFaqRequest	withIndexId(String indexId) The identifier of the index for the FAQ.
CreateFaqRequest	withLanguageCode(String languageCode) The code for a language.
CreateFaqRequest	withName(String name) A name for the FAQ.
CreateFaqRequest	withRoleArn(String roleArn) The Amazon Resource Name (ARN) of an IAM role with permission to access the S3 bucket that contains the FAQs.
CreateFaqRequest	withS3Path(S3Path s3Path) The path to the FAQ file in S3.
CreateFaqRequest	withTags(Collection<Tag> tags) A list of key-value pairs that identify the FAQ.
CreateFaqRequest	withTags(Tag... tags) A list of key-value pairs that identify the FAQ.

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

CreateFaqRequest

public CreateFaqRequest()

Method Detail

setIndexId

public void setIndexId(String indexId)

The identifier of the index for the FAQ.

Parameters:

indexId - The identifier of the index for the FAQ.

getIndexId

public String getIndexId()

The identifier of the index for the FAQ.

Returns:

The identifier of the index for the FAQ.

withIndexId

public CreateFaqRequest withIndexId(String indexId)

The identifier of the index for the FAQ.

Parameters:

indexId - The identifier of the index for the FAQ.

Returns:

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

setName

public void setName(String name)

A name for the FAQ.

Parameters:

name - A name for the FAQ.

getName

public String getName()

A name for the FAQ.

Returns:

A name for the FAQ.

withName

public CreateFaqRequest withName(String name)

A name for the FAQ.

Parameters:

name - A name for the FAQ.

Returns:

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

setDescription

public void setDescription(String description)

A description for the FAQ.

Parameters:

description - A description for the FAQ.

getDescription

public String getDescription()

A description for the FAQ.

Returns:

A description for the FAQ.

withDescription

public CreateFaqRequest withDescription(String description)

A description for the FAQ.

Parameters:

description - A description for the FAQ.

Returns:

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

setS3Path

public void setS3Path(S3Path s3Path)

The path to the FAQ file in S3.

Parameters:

s3Path - The path to the FAQ file in S3.

getS3Path

public S3Path getS3Path()

The path to the FAQ file in S3.

Returns:

The path to the FAQ file in S3.

withS3Path

public CreateFaqRequest withS3Path(S3Path s3Path)

The path to the FAQ file in S3.

Parameters:

s3Path - The path to the FAQ file in S3.

Returns:

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

setRoleArn

public void setRoleArn(String roleArn)

The Amazon Resource Name (ARN) of an IAM role with permission to access the S3 bucket that contains the FAQs. For more information, see IAM access roles for Amazon Kendra.

Parameters:

roleArn - The Amazon Resource Name (ARN) of an IAM role with permission to access the S3 bucket that contains the FAQs. For more information, see IAM access roles for Amazon Kendra.

getRoleArn

public String getRoleArn()

The Amazon Resource Name (ARN) of an IAM role with permission to access the S3 bucket that contains the FAQs. For more information, see IAM access roles for Amazon Kendra.

Returns:

The Amazon Resource Name (ARN) of an IAM role with permission to access the S3 bucket that contains the FAQs. For more information, see IAM access roles for Amazon Kendra.

withRoleArn

public CreateFaqRequest withRoleArn(String roleArn)

The Amazon Resource Name (ARN) of an IAM role with permission to access the S3 bucket that contains the FAQs. For more information, see IAM access roles for Amazon Kendra.

Parameters:

roleArn - The Amazon Resource Name (ARN) of an IAM role with permission to access the S3 bucket that contains the FAQs. For more information, see IAM access roles for Amazon Kendra.

Returns:

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

getTags

public List<Tag> getTags()

A list of key-value pairs that identify the FAQ. You can use the tags to identify and organize your resources and to control access to resources.

Returns:

A list of key-value pairs that identify the FAQ. You can use the tags to identify and organize your resources and to control access to resources.

setTags

public void setTags(Collection<Tag> tags)

A list of key-value pairs that identify the FAQ. You can use the tags to identify and organize your resources and to control access to resources.

Parameters:

tags - A list of key-value pairs that identify the FAQ. You can use the tags to identify and organize your resources and to control access to resources.

withTags

public CreateFaqRequest withTags(Tag... tags)

A list of key-value pairs that identify the FAQ. You can use the tags to identify and organize your resources and to control access to resources.

NOTE: This method appends the values to the existing list (if any). Use setTags(java.util.Collection) or withTags(java.util.Collection) if you want to override the existing values.

Parameters:

tags - A list of key-value pairs that identify the FAQ. You can use the tags to identify and organize your resources and to control access to resources.

Returns:

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

withTags

public CreateFaqRequest withTags(Collection<Tag> tags)

A list of key-value pairs that identify the FAQ. You can use the tags to identify and organize your resources and to control access to resources.

Parameters:

tags - A list of key-value pairs that identify the FAQ. You can use the tags to identify and organize your resources and to control access to resources.

Returns:

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

setFileFormat

public void setFileFormat(String fileFormat)

The format of the FAQ input file. You can choose between a basic CSV format, a CSV format that includes customs attributes in a header, and a JSON format that includes custom attributes.

The default format is CSV.

The format must match the format of the file stored in the S3 bucket identified in the S3Path parameter.

For more information, see Adding questions and answers.

Parameters:

fileFormat - The format of the FAQ input file. You can choose between a basic CSV format, a CSV format that includes customs attributes in a header, and a JSON format that includes custom attributes.

The default format is CSV.

The format must match the format of the file stored in the S3 bucket identified in the S3Path parameter.

For more information, see Adding questions and answers.

See Also:

FaqFileFormat

getFileFormat

public String getFileFormat()

The format of the FAQ input file. You can choose between a basic CSV format, a CSV format that includes customs attributes in a header, and a JSON format that includes custom attributes.

The default format is CSV.

The format must match the format of the file stored in the S3 bucket identified in the S3Path parameter.

For more information, see Adding questions and answers.

Returns:

The format of the FAQ input file. You can choose between a basic CSV format, a CSV format that includes customs attributes in a header, and a JSON format that includes custom attributes.

The default format is CSV.

The format must match the format of the file stored in the S3 bucket identified in the S3Path parameter.

For more information, see Adding questions and answers.

See Also:

FaqFileFormat

withFileFormat

public CreateFaqRequest withFileFormat(String fileFormat)

The format of the FAQ input file. You can choose between a basic CSV format, a CSV format that includes customs attributes in a header, and a JSON format that includes custom attributes.

The default format is CSV.

The format must match the format of the file stored in the S3 bucket identified in the S3Path parameter.

For more information, see Adding questions and answers.

Parameters:

fileFormat - The format of the FAQ input file. You can choose between a basic CSV format, a CSV format that includes customs attributes in a header, and a JSON format that includes custom attributes.

The default format is CSV.

The format must match the format of the file stored in the S3 bucket identified in the S3Path parameter.

For more information, see Adding questions and answers.

Returns:

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

See Also:

FaqFileFormat

withFileFormat

public CreateFaqRequest withFileFormat(FaqFileFormat fileFormat)

The format of the FAQ input file. You can choose between a basic CSV format, a CSV format that includes customs attributes in a header, and a JSON format that includes custom attributes.

The default format is CSV.

The format must match the format of the file stored in the S3 bucket identified in the S3Path parameter.

For more information, see Adding questions and answers.

Parameters:

fileFormat - The format of the FAQ input file. You can choose between a basic CSV format, a CSV format that includes customs attributes in a header, and a JSON format that includes custom attributes.

The default format is CSV.

The format must match the format of the file stored in the S3 bucket identified in the S3Path parameter.

For more information, see Adding questions and answers.

Returns:

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

See Also:

FaqFileFormat

setClientToken

public void setClientToken(String clientToken)

A token that you provide to identify the request to create a FAQ. Multiple calls to the CreateFaqRequest API with the same client token will create only one FAQ.

Parameters:

clientToken - A token that you provide to identify the request to create a FAQ. Multiple calls to the CreateFaqRequest API with the same client token will create only one FAQ.

getClientToken

public String getClientToken()

A token that you provide to identify the request to create a FAQ. Multiple calls to the CreateFaqRequest API with the same client token will create only one FAQ.

Returns:

A token that you provide to identify the request to create a FAQ. Multiple calls to the CreateFaqRequest API with the same client token will create only one FAQ.

withClientToken

public CreateFaqRequest withClientToken(String clientToken)

A token that you provide to identify the request to create a FAQ. Multiple calls to the CreateFaqRequest API with the same client token will create only one FAQ.

Parameters:

clientToken - A token that you provide to identify the request to create a FAQ. Multiple calls to the CreateFaqRequest API with the same client token will create only one FAQ.

Returns:

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

setLanguageCode

public void setLanguageCode(String languageCode)

The code for a language. This allows you to support a language for the FAQ document. English is supported by default. For more information on supported languages, including their codes, see Adding documents in languages other than English.

Parameters:

languageCode - The code for a language. This allows you to support a language for the FAQ document. English is supported by default. For more information on supported languages, including their codes, see Adding documents in languages other than English.

getLanguageCode

public String getLanguageCode()

The code for a language. This allows you to support a language for the FAQ document. English is supported by default. For more information on supported languages, including their codes, see Adding documents in languages other than English.

Returns:

The code for a language. This allows you to support a language for the FAQ document. English is supported by default. For more information on supported languages, including their codes, see Adding documents in languages other than English.

withLanguageCode

public CreateFaqRequest withLanguageCode(String languageCode)

The code for a language. This allows you to support a language for the FAQ document. English is supported by default. For more information on supported languages, including their codes, see Adding documents in languages other than English.

Parameters:

languageCode - The code for a language. This allows you to support a language for the FAQ document. English is supported by default. For more information on supported languages, including their codes, see Adding documents in languages other than English.

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 CreateFaqRequest 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()