com.amazonaws.services.kendra.model

Class UpdateQuerySuggestionsBlockListRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.kendra.model.UpdateQuerySuggestionsBlockListRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

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

Method Summary

Modifier and Type	Method and Description
UpdateQuerySuggestionsBlockListRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getDescription() A new description for the block list.
String	getId() The identifier of the block list you want to update.
String	getIndexId() The identifier of the index for the block list.
String	getName() A new name for the block list.
String	getRoleArn() The IAM (Identity and Access Management) role used to access the block list text file in S3.
S3Path	getSourceS3Path() The S3 path where your block list text file sits in S3.
int	hashCode()
void	setDescription(String description) A new description for the block list.
void	setId(String id) The identifier of the block list you want to update.
void	setIndexId(String indexId) The identifier of the index for the block list.
void	setName(String name) A new name for the block list.
void	setRoleArn(String roleArn) The IAM (Identity and Access Management) role used to access the block list text file in S3.
void	setSourceS3Path(S3Path sourceS3Path) The S3 path where your block list text file sits in S3.
String	toString() Returns a string representation of this object.
UpdateQuerySuggestionsBlockListRequest	withDescription(String description) A new description for the block list.
UpdateQuerySuggestionsBlockListRequest	withId(String id) The identifier of the block list you want to update.
UpdateQuerySuggestionsBlockListRequest	withIndexId(String indexId) The identifier of the index for the block list.
UpdateQuerySuggestionsBlockListRequest	withName(String name) A new name for the block list.
UpdateQuerySuggestionsBlockListRequest	withRoleArn(String roleArn) The IAM (Identity and Access Management) role used to access the block list text file in S3.
UpdateQuerySuggestionsBlockListRequest	withSourceS3Path(S3Path sourceS3Path) The S3 path where your block list text file sits in S3.

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

UpdateQuerySuggestionsBlockListRequest

public UpdateQuerySuggestionsBlockListRequest()

Method Detail

setIndexId

public void setIndexId(String indexId)

The identifier of the index for the block list.

Parameters:

indexId - The identifier of the index for the block list.

getIndexId

public String getIndexId()

The identifier of the index for the block list.

Returns:

The identifier of the index for the block list.

withIndexId

public UpdateQuerySuggestionsBlockListRequest withIndexId(String indexId)

The identifier of the index for the block list.

Parameters:

indexId - The identifier of the index for the block list.

Returns:

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

setId

public void setId(String id)

The identifier of the block list you want to update.

Parameters:

id - The identifier of the block list you want to update.

getId

public String getId()

The identifier of the block list you want to update.

Returns:

The identifier of the block list you want to update.

withId

public UpdateQuerySuggestionsBlockListRequest withId(String id)

The identifier of the block list you want to update.

Parameters:

id - The identifier of the block list you want to update.

Returns:

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

setName

public void setName(String name)

A new name for the block list.

Parameters:

name - A new name for the block list.

getName

public String getName()

A new name for the block list.

Returns:

A new name for the block list.

withName

public UpdateQuerySuggestionsBlockListRequest withName(String name)

A new name for the block list.

Parameters:

name - A new name for the block list.

Returns:

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

setDescription

public void setDescription(String description)

A new description for the block list.

Parameters:

description - A new description for the block list.

getDescription

public String getDescription()

A new description for the block list.

Returns:

A new description for the block list.

withDescription

public UpdateQuerySuggestionsBlockListRequest withDescription(String description)

A new description for the block list.

Parameters:

description - A new description for the block list.

Returns:

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

setSourceS3Path

public void setSourceS3Path(S3Path sourceS3Path)

The S3 path where your block list text file sits in S3.

If you update your block list and provide the same path to the block list text file in S3, then Amazon Kendra reloads the file to refresh the block list. Amazon Kendra does not automatically refresh your block list. You need to call the UpdateQuerySuggestionsBlockList API to refresh you block list.

If you update your block list, then Amazon Kendra asynchronously refreshes all query suggestions with the latest content in the S3 file. This means changes might not take effect immediately.

Parameters:

sourceS3Path - The S3 path where your block list text file sits in S3.

If you update your block list and provide the same path to the block list text file in S3, then Amazon Kendra reloads the file to refresh the block list. Amazon Kendra does not automatically refresh your block list. You need to call the UpdateQuerySuggestionsBlockList API to refresh you block list.

If you update your block list, then Amazon Kendra asynchronously refreshes all query suggestions with the latest content in the S3 file. This means changes might not take effect immediately.

getSourceS3Path

public S3Path getSourceS3Path()

The S3 path where your block list text file sits in S3.

If you update your block list and provide the same path to the block list text file in S3, then Amazon Kendra reloads the file to refresh the block list. Amazon Kendra does not automatically refresh your block list. You need to call the UpdateQuerySuggestionsBlockList API to refresh you block list.

If you update your block list, then Amazon Kendra asynchronously refreshes all query suggestions with the latest content in the S3 file. This means changes might not take effect immediately.

Returns:

The S3 path where your block list text file sits in S3.

If you update your block list and provide the same path to the block list text file in S3, then Amazon Kendra reloads the file to refresh the block list. Amazon Kendra does not automatically refresh your block list. You need to call the UpdateQuerySuggestionsBlockList API to refresh you block list.

If you update your block list, then Amazon Kendra asynchronously refreshes all query suggestions with the latest content in the S3 file. This means changes might not take effect immediately.

withSourceS3Path

public UpdateQuerySuggestionsBlockListRequest withSourceS3Path(S3Path sourceS3Path)

The S3 path where your block list text file sits in S3.

If you update your block list and provide the same path to the block list text file in S3, then Amazon Kendra reloads the file to refresh the block list. Amazon Kendra does not automatically refresh your block list. You need to call the UpdateQuerySuggestionsBlockList API to refresh you block list.

If you update your block list, then Amazon Kendra asynchronously refreshes all query suggestions with the latest content in the S3 file. This means changes might not take effect immediately.

Parameters:

sourceS3Path - The S3 path where your block list text file sits in S3.

If you update your block list and provide the same path to the block list text file in S3, then Amazon Kendra reloads the file to refresh the block list. Amazon Kendra does not automatically refresh your block list. You need to call the UpdateQuerySuggestionsBlockList API to refresh you block list.

If you update your block list, then Amazon Kendra asynchronously refreshes all query suggestions with the latest content in the S3 file. This means changes might not take effect immediately.

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 to access the block list text file in S3.

Parameters:

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

getRoleArn

public String getRoleArn()

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

Returns:

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

withRoleArn

public UpdateQuerySuggestionsBlockListRequest withRoleArn(String roleArn)

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

Parameters:

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

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