com.amazonaws.services.kendra.model

Class UpdateIndexRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.kendra.model.UpdateIndexRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

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

Method Summary

Modifier and Type	Method and Description
UpdateIndexRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
CapacityUnitsConfiguration	getCapacityUnits() Sets the number of additional document storage and query capacity units that should be used by the index.
String	getDescription() A new description for the index.
List<DocumentMetadataConfiguration>	getDocumentMetadataConfigurationUpdates() The document metadata configuration you want to update for the index.
String	getId() The identifier of the index you want to update.
String	getName() A new name for the index.
String	getRoleArn() An Identity and Access Management (IAM) role that gives Amazon Kendra permission to access Amazon CloudWatch logs and metrics.
String	getUserContextPolicy() The user context policy.
UserGroupResolutionConfiguration	getUserGroupResolutionConfiguration() Gets users and groups from IAM Identity Center identity source.
List<UserTokenConfiguration>	getUserTokenConfigurations() The user token configuration.
int	hashCode()
void	setCapacityUnits(CapacityUnitsConfiguration capacityUnits) Sets the number of additional document storage and query capacity units that should be used by the index.
void	setDescription(String description) A new description for the index.
void	setDocumentMetadataConfigurationUpdates(Collection<DocumentMetadataConfiguration> documentMetadataConfigurationUpdates) The document metadata configuration you want to update for the index.
void	setId(String id) The identifier of the index you want to update.
void	setName(String name) A new name for the index.
void	setRoleArn(String roleArn) An Identity and Access Management (IAM) role that gives Amazon Kendra permission to access Amazon CloudWatch logs and metrics.
void	setUserContextPolicy(String userContextPolicy) The user context policy.
void	setUserGroupResolutionConfiguration(UserGroupResolutionConfiguration userGroupResolutionConfiguration) Gets users and groups from IAM Identity Center identity source.
void	setUserTokenConfigurations(Collection<UserTokenConfiguration> userTokenConfigurations) The user token configuration.
String	toString() Returns a string representation of this object.
UpdateIndexRequest	withCapacityUnits(CapacityUnitsConfiguration capacityUnits) Sets the number of additional document storage and query capacity units that should be used by the index.
UpdateIndexRequest	withDescription(String description) A new description for the index.
UpdateIndexRequest	withDocumentMetadataConfigurationUpdates(Collection<DocumentMetadataConfiguration> documentMetadataConfigurationUpdates) The document metadata configuration you want to update for the index.
UpdateIndexRequest	withDocumentMetadataConfigurationUpdates(DocumentMetadataConfiguration... documentMetadataConfigurationUpdates) The document metadata configuration you want to update for the index.
UpdateIndexRequest	withId(String id) The identifier of the index you want to update.
UpdateIndexRequest	withName(String name) A new name for the index.
UpdateIndexRequest	withRoleArn(String roleArn) An Identity and Access Management (IAM) role that gives Amazon Kendra permission to access Amazon CloudWatch logs and metrics.
UpdateIndexRequest	withUserContextPolicy(String userContextPolicy) The user context policy.
UpdateIndexRequest	withUserContextPolicy(UserContextPolicy userContextPolicy) The user context policy.
UpdateIndexRequest	withUserGroupResolutionConfiguration(UserGroupResolutionConfiguration userGroupResolutionConfiguration) Gets users and groups from IAM Identity Center identity source.
UpdateIndexRequest	withUserTokenConfigurations(Collection<UserTokenConfiguration> userTokenConfigurations) The user token configuration.
UpdateIndexRequest	withUserTokenConfigurations(UserTokenConfiguration... userTokenConfigurations) The user token configuration.

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

UpdateIndexRequest

public UpdateIndexRequest()

Method Detail

setId

public void setId(String id)

The identifier of the index you want to update.

Parameters:

id - The identifier of the index you want to update.

getId

public String getId()

The identifier of the index you want to update.

Returns:

The identifier of the index you want to update.

withId

public UpdateIndexRequest withId(String id)

The identifier of the index you want to update.

Parameters:

id - The identifier of the index 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 index.

Parameters:

name - A new name for the index.

getName

public String getName()

A new name for the index.

Returns:

A new name for the index.

withName

public UpdateIndexRequest withName(String name)

A new name for the index.

Parameters:

name - A new name for the index.

Returns:

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

setRoleArn

public void setRoleArn(String roleArn)

An Identity and Access Management (IAM) role that gives Amazon Kendra permission to access Amazon CloudWatch logs and metrics.

Parameters:

roleArn - An Identity and Access Management (IAM) role that gives Amazon Kendra permission to access Amazon CloudWatch logs and metrics.

getRoleArn

public String getRoleArn()

An Identity and Access Management (IAM) role that gives Amazon Kendra permission to access Amazon CloudWatch logs and metrics.

Returns:

An Identity and Access Management (IAM) role that gives Amazon Kendra permission to access Amazon CloudWatch logs and metrics.

withRoleArn

public UpdateIndexRequest withRoleArn(String roleArn)

An Identity and Access Management (IAM) role that gives Amazon Kendra permission to access Amazon CloudWatch logs and metrics.

Parameters:

roleArn - An Identity and Access Management (IAM) role that gives Amazon Kendra permission to access Amazon CloudWatch logs and metrics.

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 index.

Parameters:

description - A new description for the index.

getDescription

public String getDescription()

A new description for the index.

Returns:

A new description for the index.

withDescription

public UpdateIndexRequest withDescription(String description)

A new description for the index.

Parameters:

description - A new description for the index.

Returns:

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

getDocumentMetadataConfigurationUpdates

public List<DocumentMetadataConfiguration> getDocumentMetadataConfigurationUpdates()

The document metadata configuration you want to update for the index. Document metadata are fields or attributes associated with your documents. For example, the company department name associated with each document.

Returns:

The document metadata configuration you want to update for the index. Document metadata are fields or attributes associated with your documents. For example, the company department name associated with each document.

setDocumentMetadataConfigurationUpdates

public void setDocumentMetadataConfigurationUpdates(Collection<DocumentMetadataConfiguration> documentMetadataConfigurationUpdates)

The document metadata configuration you want to update for the index. Document metadata are fields or attributes associated with your documents. For example, the company department name associated with each document.

Parameters:

documentMetadataConfigurationUpdates - The document metadata configuration you want to update for the index. Document metadata are fields or attributes associated with your documents. For example, the company department name associated with each document.

withDocumentMetadataConfigurationUpdates

public UpdateIndexRequest withDocumentMetadataConfigurationUpdates(DocumentMetadataConfiguration... documentMetadataConfigurationUpdates)

The document metadata configuration you want to update for the index. Document metadata are fields or attributes associated with your documents. For example, the company department name associated with each document.

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

Parameters:

documentMetadataConfigurationUpdates - The document metadata configuration you want to update for the index. Document metadata are fields or attributes associated with your documents. For example, the company department name associated with each document.

Returns:

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

withDocumentMetadataConfigurationUpdates

public UpdateIndexRequest withDocumentMetadataConfigurationUpdates(Collection<DocumentMetadataConfiguration> documentMetadataConfigurationUpdates)

The document metadata configuration you want to update for the index. Document metadata are fields or attributes associated with your documents. For example, the company department name associated with each document.

Parameters:

documentMetadataConfigurationUpdates - The document metadata configuration you want to update for the index. Document metadata are fields or attributes associated with your documents. For example, the company department name associated with each document.

Returns:

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

setCapacityUnits

public void setCapacityUnits(CapacityUnitsConfiguration capacityUnits)

Sets the number of additional document storage and query capacity units that should be used by the index. You can change the capacity of the index up to 5 times per day, or make 5 API calls.

If you are using extra storage units, you can't reduce the storage capacity below what is required to meet the storage needs for your index.

Parameters:

capacityUnits - Sets the number of additional document storage and query capacity units that should be used by the index. You can change the capacity of the index up to 5 times per day, or make 5 API calls.

If you are using extra storage units, you can't reduce the storage capacity below what is required to meet the storage needs for your index.

getCapacityUnits

public CapacityUnitsConfiguration getCapacityUnits()

Sets the number of additional document storage and query capacity units that should be used by the index. You can change the capacity of the index up to 5 times per day, or make 5 API calls.

If you are using extra storage units, you can't reduce the storage capacity below what is required to meet the storage needs for your index.

Returns:

Sets the number of additional document storage and query capacity units that should be used by the index. You can change the capacity of the index up to 5 times per day, or make 5 API calls.

If you are using extra storage units, you can't reduce the storage capacity below what is required to meet the storage needs for your index.

withCapacityUnits

public UpdateIndexRequest withCapacityUnits(CapacityUnitsConfiguration capacityUnits)

Sets the number of additional document storage and query capacity units that should be used by the index. You can change the capacity of the index up to 5 times per day, or make 5 API calls.

If you are using extra storage units, you can't reduce the storage capacity below what is required to meet the storage needs for your index.

Parameters:

capacityUnits - Sets the number of additional document storage and query capacity units that should be used by the index. You can change the capacity of the index up to 5 times per day, or make 5 API calls.

If you are using extra storage units, you can't reduce the storage capacity below what is required to meet the storage needs for your index.

Returns:

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

getUserTokenConfigurations

public List<UserTokenConfiguration> getUserTokenConfigurations()

The user token configuration.

Returns:

The user token configuration.

setUserTokenConfigurations

public void setUserTokenConfigurations(Collection<UserTokenConfiguration> userTokenConfigurations)

The user token configuration.

Parameters:

userTokenConfigurations - The user token configuration.

withUserTokenConfigurations

public UpdateIndexRequest withUserTokenConfigurations(UserTokenConfiguration... userTokenConfigurations)

The user token configuration.

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

Parameters:

userTokenConfigurations - The user token configuration.

Returns:

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

withUserTokenConfigurations

public UpdateIndexRequest withUserTokenConfigurations(Collection<UserTokenConfiguration> userTokenConfigurations)

The user token configuration.

Parameters:

userTokenConfigurations - The user token configuration.

Returns:

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

setUserContextPolicy

public void setUserContextPolicy(String userContextPolicy)

The user context policy.

Parameters:

userContextPolicy - The user context policy.

See Also:

UserContextPolicy

getUserContextPolicy

public String getUserContextPolicy()

The user context policy.

Returns:

The user context policy.

See Also:

UserContextPolicy

withUserContextPolicy

public UpdateIndexRequest withUserContextPolicy(String userContextPolicy)

The user context policy.

Parameters:

userContextPolicy - The user context policy.

Returns:

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

See Also:

UserContextPolicy

withUserContextPolicy

public UpdateIndexRequest withUserContextPolicy(UserContextPolicy userContextPolicy)

The user context policy.

Parameters:

userContextPolicy - The user context policy.

Returns:

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

See Also:

UserContextPolicy

setUserGroupResolutionConfiguration

public void setUserGroupResolutionConfiguration(UserGroupResolutionConfiguration userGroupResolutionConfiguration)

Gets users and groups from IAM Identity Center identity source. To configure this, see UserGroupResolutionConfiguration. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.

Parameters:

userGroupResolutionConfiguration - Gets users and groups from IAM Identity Center identity source. To configure this, see UserGroupResolutionConfiguration. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.

getUserGroupResolutionConfiguration

public UserGroupResolutionConfiguration getUserGroupResolutionConfiguration()

Gets users and groups from IAM Identity Center identity source. To configure this, see UserGroupResolutionConfiguration. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.

Returns:

Gets users and groups from IAM Identity Center identity source. To configure this, see UserGroupResolutionConfiguration. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.

withUserGroupResolutionConfiguration

public UpdateIndexRequest withUserGroupResolutionConfiguration(UserGroupResolutionConfiguration userGroupResolutionConfiguration)

Gets users and groups from IAM Identity Center identity source. To configure this, see UserGroupResolutionConfiguration. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.

Parameters:

userGroupResolutionConfiguration - Gets users and groups from IAM Identity Center identity source. To configure this, see UserGroupResolutionConfiguration. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.

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