com.amazonaws.services.kendra.model

Class CreateQuerySuggestionsBlockListRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.kendra.model.CreateQuerySuggestionsBlockListRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

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

Method Summary

Modifier and Type	Method and Description
CreateQuerySuggestionsBlockListRequest	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 query suggestions block list.
String	getDescription() A user-friendly description for the block list.
String	getIndexId() The identifier of the index you want to create a query suggestions block list for.
String	getName() A user friendly name for the block list.
String	getRoleArn() The IAM (Identity and Access Management) role used by Amazon Kendra to access the block list text file in your S3 bucket.
S3Path	getSourceS3Path() The S3 path to your block list text file in your S3 bucket.
List<Tag>	getTags() A tag that you can assign to a block list that categorizes the block list.
int	hashCode()
void	setClientToken(String clientToken) A token that you provide to identify the request to create a query suggestions block list.
void	setDescription(String description) A user-friendly description for the block list.
void	setIndexId(String indexId) The identifier of the index you want to create a query suggestions block list for.
void	setName(String name) A user friendly name for the block list.
void	setRoleArn(String roleArn) The IAM (Identity and Access Management) role used by Amazon Kendra to access the block list text file in your S3 bucket.
void	setSourceS3Path(S3Path sourceS3Path) The S3 path to your block list text file in your S3 bucket.
void	setTags(Collection<Tag> tags) A tag that you can assign to a block list that categorizes the block list.
String	toString() Returns a string representation of this object.
CreateQuerySuggestionsBlockListRequest	withClientToken(String clientToken) A token that you provide to identify the request to create a query suggestions block list.
CreateQuerySuggestionsBlockListRequest	withDescription(String description) A user-friendly description for the block list.
CreateQuerySuggestionsBlockListRequest	withIndexId(String indexId) The identifier of the index you want to create a query suggestions block list for.
CreateQuerySuggestionsBlockListRequest	withName(String name) A user friendly name for the block list.
CreateQuerySuggestionsBlockListRequest	withRoleArn(String roleArn) The IAM (Identity and Access Management) role used by Amazon Kendra to access the block list text file in your S3 bucket.
CreateQuerySuggestionsBlockListRequest	withSourceS3Path(S3Path sourceS3Path) The S3 path to your block list text file in your S3 bucket.
CreateQuerySuggestionsBlockListRequest	withTags(Collection<Tag> tags) A tag that you can assign to a block list that categorizes the block list.
CreateQuerySuggestionsBlockListRequest	withTags(Tag... tags) A tag that you can assign to a block list that categorizes the block list.

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

CreateQuerySuggestionsBlockListRequest

public CreateQuerySuggestionsBlockListRequest()

Method Detail

setIndexId

public void setIndexId(String indexId)

The identifier of the index you want to create a query suggestions block list for.

Parameters:

indexId - The identifier of the index you want to create a query suggestions block list for.

getIndexId

public String getIndexId()

The identifier of the index you want to create a query suggestions block list for.

Returns:

The identifier of the index you want to create a query suggestions block list for.

withIndexId

public CreateQuerySuggestionsBlockListRequest withIndexId(String indexId)

The identifier of the index you want to create a query suggestions block list for.

Parameters:

indexId - The identifier of the index you want to create a query suggestions block list for.

Returns:

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

setName

public void setName(String name)

A user friendly name for the block list.

For example, the block list named 'offensive-words' includes all offensive words that could appear in user queries and need to be blocked from suggestions.

Parameters:

name - A user friendly name for the block list.

For example, the block list named 'offensive-words' includes all offensive words that could appear in user queries and need to be blocked from suggestions.

getName

public String getName()

A user friendly name for the block list.

For example, the block list named 'offensive-words' includes all offensive words that could appear in user queries and need to be blocked from suggestions.

Returns:

A user friendly name for the block list.

For example, the block list named 'offensive-words' includes all offensive words that could appear in user queries and need to be blocked from suggestions.

withName

public CreateQuerySuggestionsBlockListRequest withName(String name)

A user friendly name for the block list.

For example, the block list named 'offensive-words' includes all offensive words that could appear in user queries and need to be blocked from suggestions.

Parameters:

name - A user friendly name for the block list.

For example, the block list named 'offensive-words' includes all offensive words that could appear in user queries and need to be blocked from suggestions.

Returns:

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

setDescription

public void setDescription(String description)

A user-friendly description for the block list.

For example, the description "List of all offensive words that can appear in user queries and need to be blocked from suggestions."

Parameters:

description - A user-friendly description for the block list.

For example, the description "List of all offensive words that can appear in user queries and need to be blocked from suggestions."

getDescription

public String getDescription()

A user-friendly description for the block list.

For example, the description "List of all offensive words that can appear in user queries and need to be blocked from suggestions."

Returns:

A user-friendly description for the block list.

For example, the description "List of all offensive words that can appear in user queries and need to be blocked from suggestions."

withDescription

public CreateQuerySuggestionsBlockListRequest withDescription(String description)

A user-friendly description for the block list.

For example, the description "List of all offensive words that can appear in user queries and need to be blocked from suggestions."

Parameters:

description - A user-friendly description for the block list.

For example, the description "List of all offensive words that can appear in user queries and need to be blocked from suggestions."

Returns:

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

setSourceS3Path

public void setSourceS3Path(S3Path sourceS3Path)

The S3 path to your block list text file in your S3 bucket.

Each block word or phrase should be on a separate line in a text file.

For information on the current quota limits for block lists, see Quotas for Amazon Kendra.

Parameters:

sourceS3Path - The S3 path to your block list text file in your S3 bucket.

Each block word or phrase should be on a separate line in a text file.

For information on the current quota limits for block lists, see Quotas for Amazon Kendra.

getSourceS3Path

public S3Path getSourceS3Path()

The S3 path to your block list text file in your S3 bucket.

Each block word or phrase should be on a separate line in a text file.

For information on the current quota limits for block lists, see Quotas for Amazon Kendra.

Returns:

The S3 path to your block list text file in your S3 bucket.

Each block word or phrase should be on a separate line in a text file.

For information on the current quota limits for block lists, see Quotas for Amazon Kendra.

withSourceS3Path

public CreateQuerySuggestionsBlockListRequest withSourceS3Path(S3Path sourceS3Path)

The S3 path to your block list text file in your S3 bucket.

Each block word or phrase should be on a separate line in a text file.

For information on the current quota limits for block lists, see Quotas for Amazon Kendra.

Parameters:

sourceS3Path - The S3 path to your block list text file in your S3 bucket.

Each block word or phrase should be on a separate line in a text file.

For information on the current quota limits for block lists, see Quotas for Amazon Kendra.

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 query suggestions block list.

Parameters:

clientToken - A token that you provide to identify the request to create a query suggestions block list.

getClientToken

public String getClientToken()

A token that you provide to identify the request to create a query suggestions block list.

Returns:

A token that you provide to identify the request to create a query suggestions block list.

withClientToken

public CreateQuerySuggestionsBlockListRequest withClientToken(String clientToken)

A token that you provide to identify the request to create a query suggestions block list.

Parameters:

clientToken - A token that you provide to identify the request to create a query suggestions block list.

Returns:

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

setRoleArn

public void setRoleArn(String roleArn)

The IAM (Identity and Access Management) role used by Amazon Kendra to access the block list text file in your S3 bucket.

You need permissions to the role ARN (Amazon Web Services Resource Name). The role needs S3 read permissions to your file in S3 and needs to give STS (Security Token Service) assume role permissions to Amazon Kendra.

Parameters:

roleArn - The IAM (Identity and Access Management) role used by Amazon Kendra to access the block list text file in your S3 bucket.

You need permissions to the role ARN (Amazon Web Services Resource Name). The role needs S3 read permissions to your file in S3 and needs to give STS (Security Token Service) assume role permissions to Amazon Kendra.

getRoleArn

public String getRoleArn()

The IAM (Identity and Access Management) role used by Amazon Kendra to access the block list text file in your S3 bucket.

You need permissions to the role ARN (Amazon Web Services Resource Name). The role needs S3 read permissions to your file in S3 and needs to give STS (Security Token Service) assume role permissions to Amazon Kendra.

Returns:

The IAM (Identity and Access Management) role used by Amazon Kendra to access the block list text file in your S3 bucket.

You need permissions to the role ARN (Amazon Web Services Resource Name). The role needs S3 read permissions to your file in S3 and needs to give STS (Security Token Service) assume role permissions to Amazon Kendra.

withRoleArn

public CreateQuerySuggestionsBlockListRequest withRoleArn(String roleArn)

The IAM (Identity and Access Management) role used by Amazon Kendra to access the block list text file in your S3 bucket.

You need permissions to the role ARN (Amazon Web Services Resource Name). The role needs S3 read permissions to your file in S3 and needs to give STS (Security Token Service) assume role permissions to Amazon Kendra.

Parameters:

roleArn - The IAM (Identity and Access Management) role used by Amazon Kendra to access the block list text file in your S3 bucket.

You need permissions to the role ARN (Amazon Web Services Resource Name). The role needs S3 read permissions to your file in S3 and needs to give STS (Security Token Service) assume role permissions to Amazon Kendra.

Returns:

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

getTags

public List<Tag> getTags()

A tag that you can assign to a block list that categorizes the block list.

Returns:

A tag that you can assign to a block list that categorizes the block list.

setTags

public void setTags(Collection<Tag> tags)

A tag that you can assign to a block list that categorizes the block list.

Parameters:

tags - A tag that you can assign to a block list that categorizes the block list.

withTags

public CreateQuerySuggestionsBlockListRequest withTags(Tag... tags)

A tag that you can assign to a block list that categorizes the block list.

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 tag that you can assign to a block list that categorizes the block list.

Returns:

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

withTags

public CreateQuerySuggestionsBlockListRequest withTags(Collection<Tag> tags)

A tag that you can assign to a block list that categorizes the block list.

Parameters:

tags - A tag that you can assign to a block list that categorizes the block list.

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