com.amazonaws.services.kendra.model

Class CreateThesaurusRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.kendra.model.CreateThesaurusRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

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

Method Summary

Modifier and Type	Method and Description
CreateThesaurusRequest	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 thesaurus.
String	getDescription() The description for the new thesaurus.
String	getIndexId() The unique identifier of the index for the new thesaurus.
String	getName() The name for the new thesaurus.
String	getRoleArn() An AWS Identity and Access Management (IAM) role that gives Amazon Kendra permissions to access thesaurus file specified in SourceS3Path.
S3Path	getSourceS3Path() The thesaurus file Amazon S3 source path.
List<Tag>	getTags() A list of key-value pairs that identify the thesaurus.
int	hashCode()
void	setClientToken(String clientToken) A token that you provide to identify the request to create a thesaurus.
void	setDescription(String description) The description for the new thesaurus.
void	setIndexId(String indexId) The unique identifier of the index for the new thesaurus.
void	setName(String name) The name for the new thesaurus.
void	setRoleArn(String roleArn) An AWS Identity and Access Management (IAM) role that gives Amazon Kendra permissions to access thesaurus file specified in SourceS3Path.
void	setSourceS3Path(S3Path sourceS3Path) The thesaurus file Amazon S3 source path.
void	setTags(Collection<Tag> tags) A list of key-value pairs that identify the thesaurus.
String	toString() Returns a string representation of this object.
CreateThesaurusRequest	withClientToken(String clientToken) A token that you provide to identify the request to create a thesaurus.
CreateThesaurusRequest	withDescription(String description) The description for the new thesaurus.
CreateThesaurusRequest	withIndexId(String indexId) The unique identifier of the index for the new thesaurus.
CreateThesaurusRequest	withName(String name) The name for the new thesaurus.
CreateThesaurusRequest	withRoleArn(String roleArn) An AWS Identity and Access Management (IAM) role that gives Amazon Kendra permissions to access thesaurus file specified in SourceS3Path.
CreateThesaurusRequest	withSourceS3Path(S3Path sourceS3Path) The thesaurus file Amazon S3 source path.
CreateThesaurusRequest	withTags(Collection<Tag> tags) A list of key-value pairs that identify the thesaurus.
CreateThesaurusRequest	withTags(Tag... tags) A list of key-value pairs that identify the thesaurus.

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

CreateThesaurusRequest

public CreateThesaurusRequest()

Method Detail

setIndexId

public void setIndexId(String indexId)

The unique identifier of the index for the new thesaurus.

Parameters:

indexId - The unique identifier of the index for the new thesaurus.

getIndexId

public String getIndexId()

The unique identifier of the index for the new thesaurus.

Returns:

The unique identifier of the index for the new thesaurus.

withIndexId

public CreateThesaurusRequest withIndexId(String indexId)

The unique identifier of the index for the new thesaurus.

Parameters:

indexId - The unique identifier of the index for the new thesaurus.

Returns:

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

setName

public void setName(String name)

The name for the new thesaurus.

Parameters:

name - The name for the new thesaurus.

getName

public String getName()

The name for the new thesaurus.

Returns:

The name for the new thesaurus.

withName

public CreateThesaurusRequest withName(String name)

The name for the new thesaurus.

Parameters:

name - The name for the new thesaurus.

Returns:

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

setDescription

public void setDescription(String description)

The description for the new thesaurus.

Parameters:

description - The description for the new thesaurus.

getDescription

public String getDescription()

The description for the new thesaurus.

Returns:

The description for the new thesaurus.

withDescription

public CreateThesaurusRequest withDescription(String description)

The description for the new thesaurus.

Parameters:

description - The description for the new thesaurus.

Returns:

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

setRoleArn

public void setRoleArn(String roleArn)

An AWS Identity and Access Management (IAM) role that gives Amazon Kendra permissions to access thesaurus file specified in SourceS3Path.

Parameters:

roleArn - An AWS Identity and Access Management (IAM) role that gives Amazon Kendra permissions to access thesaurus file specified in SourceS3Path.

getRoleArn

public String getRoleArn()

An AWS Identity and Access Management (IAM) role that gives Amazon Kendra permissions to access thesaurus file specified in SourceS3Path.

Returns:

An AWS Identity and Access Management (IAM) role that gives Amazon Kendra permissions to access thesaurus file specified in SourceS3Path.

withRoleArn

public CreateThesaurusRequest withRoleArn(String roleArn)

An AWS Identity and Access Management (IAM) role that gives Amazon Kendra permissions to access thesaurus file specified in SourceS3Path.

Parameters:

roleArn - An AWS Identity and Access Management (IAM) role that gives Amazon Kendra permissions to access thesaurus file specified in SourceS3Path.

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 thesaurus. 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 thesaurus. 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 thesaurus. 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 thesaurus. You can use the tags to identify and organize your resources and to control access to resources.

withTags

public CreateThesaurusRequest withTags(Tag... tags)

A list of key-value pairs that identify the thesaurus. 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 thesaurus. 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 CreateThesaurusRequest withTags(Collection<Tag> tags)

A list of key-value pairs that identify the thesaurus. 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 thesaurus. 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.

setSourceS3Path

public void setSourceS3Path(S3Path sourceS3Path)

The thesaurus file Amazon S3 source path.

Parameters:

sourceS3Path - The thesaurus file Amazon S3 source path.

getSourceS3Path

public S3Path getSourceS3Path()

The thesaurus file Amazon S3 source path.

Returns:

The thesaurus file Amazon S3 source path.

withSourceS3Path

public CreateThesaurusRequest withSourceS3Path(S3Path sourceS3Path)

The thesaurus file Amazon S3 source path.

Parameters:

sourceS3Path - The thesaurus file Amazon S3 source path.

Returns:

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

setClientToken

public void setClientToken(String clientToken)

A token that you provide to identify the request to create a thesaurus. Multiple calls to the CreateThesaurus operation with the same client token will create only one index.

Parameters:

clientToken - A token that you provide to identify the request to create a thesaurus. Multiple calls to the CreateThesaurus operation with the same client token will create only one index.

getClientToken

public String getClientToken()

A token that you provide to identify the request to create a thesaurus. Multiple calls to the CreateThesaurus operation with the same client token will create only one index.

Returns:

A token that you provide to identify the request to create a thesaurus. Multiple calls to the CreateThesaurus operation with the same client token will create only one index.

withClientToken

public CreateThesaurusRequest withClientToken(String clientToken)

A token that you provide to identify the request to create a thesaurus. Multiple calls to the CreateThesaurus operation with the same client token will create only one index.

Parameters:

clientToken - A token that you provide to identify the request to create a thesaurus. Multiple calls to the CreateThesaurus operation with the same client token will create only one index.

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