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	getDescription() A description of the FAQ.
String	getIndexId() The identifier of the index that contains the FAQ.
String	getName() The name that should be associated with the FAQ.
String	getRoleArn() The Amazon Resource Name (ARN) of a role with permission to access the S3 bucket that contains the FAQs.
S3Path	getS3Path() The S3 location of the FAQ input data.
List<Tag>	getTags() A list of key-value pairs that identify the FAQ.
int	hashCode()
void	setDescription(String description) A description of the FAQ.
void	setIndexId(String indexId) The identifier of the index that contains the FAQ.
void	setName(String name) The name that should be associated with the FAQ.
void	setRoleArn(String roleArn) The Amazon Resource Name (ARN) of a role with permission to access the S3 bucket that contains the FAQs.
void	setS3Path(S3Path s3Path) The S3 location of the FAQ input data.
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	withDescription(String description) A description of the FAQ.
CreateFaqRequest	withIndexId(String indexId) The identifier of the index that contains the FAQ.
CreateFaqRequest	withName(String name) The name that should be associated with the FAQ.
CreateFaqRequest	withRoleArn(String roleArn) The Amazon Resource Name (ARN) of a role with permission to access the S3 bucket that contains the FAQs.
CreateFaqRequest	withS3Path(S3Path s3Path) The S3 location of the FAQ input data.
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 that contains the FAQ.

Parameters:

indexId - The identifier of the index that contains the FAQ.

getIndexId

public String getIndexId()

The identifier of the index that contains the FAQ.

Returns:

The identifier of the index that contains the FAQ.

withIndexId

public CreateFaqRequest withIndexId(String indexId)

The identifier of the index that contains the FAQ.

Parameters:

indexId - The identifier of the index that contains the FAQ.

Returns:

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

setName

public void setName(String name)

The name that should be associated with the FAQ.

Parameters:

name - The name that should be associated with the FAQ.

getName

public String getName()

The name that should be associated with the FAQ.

Returns:

The name that should be associated with the FAQ.

withName

public CreateFaqRequest withName(String name)

The name that should be associated with the FAQ.

Parameters:

name - The name that should be associated with 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 of the FAQ.

Parameters:

description - A description of the FAQ.

getDescription

public String getDescription()

A description of the FAQ.

Returns:

A description of the FAQ.

withDescription

public CreateFaqRequest withDescription(String description)

A description of the FAQ.

Parameters:

description - A description of the FAQ.

Returns:

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

setS3Path

public void setS3Path(S3Path s3Path)

The S3 location of the FAQ input data.

Parameters:

s3Path - The S3 location of the FAQ input data.

getS3Path

public S3Path getS3Path()

The S3 location of the FAQ input data.

Returns:

The S3 location of the FAQ input data.

withS3Path

public CreateFaqRequest withS3Path(S3Path s3Path)

The S3 location of the FAQ input data.

Parameters:

s3Path - The S3 location of the FAQ input data.

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 a role with permission to access the S3 bucket that contains the FAQs. For more information, see IAM Roles for Amazon Kendra.

Parameters:

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

getRoleArn

public String getRoleArn()

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

Returns:

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

withRoleArn

public CreateFaqRequest withRoleArn(String roleArn)

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

Parameters:

roleArn - The Amazon Resource Name (ARN) of a role with permission to access the S3 bucket that contains the FAQs. For more information, see IAM 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.

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