Package software.amazon.awssdk.services.kendra.model

Interface UpdateIndexRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<UpdateIndexRequest.Builder,UpdateIndexRequest>, KendraRequest.Builder, SdkBuilder<UpdateIndexRequest.Builder,UpdateIndexRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

UpdateIndexRequest

public static interface UpdateIndexRequest.Builder
extends KendraRequest.Builder, SdkPojo, CopyableBuilder<UpdateIndexRequest.Builder,UpdateIndexRequest>

Method Summary

Modifier and Type	Method	Description
default UpdateIndexRequest.Builder	capacityUnits(Consumer<CapacityUnitsConfiguration.Builder> capacityUnits)	Sets the number of additional document storage and query capacity units that should be used by the index.
UpdateIndexRequest.Builder	capacityUnits(CapacityUnitsConfiguration capacityUnits)	Sets the number of additional document storage and query capacity units that should be used by the index.
UpdateIndexRequest.Builder	description(String description)	A new description for the index.
UpdateIndexRequest.Builder	documentMetadataConfigurationUpdates(Collection<DocumentMetadataConfiguration> documentMetadataConfigurationUpdates)	The document metadata configuration you want to update for the index.
UpdateIndexRequest.Builder	documentMetadataConfigurationUpdates(Consumer<DocumentMetadataConfiguration.Builder>... documentMetadataConfigurationUpdates)	The document metadata configuration you want to update for the index.
UpdateIndexRequest.Builder	documentMetadataConfigurationUpdates(DocumentMetadataConfiguration... documentMetadataConfigurationUpdates)	The document metadata configuration you want to update for the index.
UpdateIndexRequest.Builder	id(String id)	The identifier of the index you want to update.
UpdateIndexRequest.Builder	name(String name)	The name of the index you want to update.
UpdateIndexRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
UpdateIndexRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
UpdateIndexRequest.Builder	roleArn(String roleArn)	An Identity and Access Management (IAM) role that gives Amazon Kendra permission to access Amazon CloudWatch logs and metrics.
UpdateIndexRequest.Builder	userContextPolicy(String userContextPolicy)	The user context policy.
UpdateIndexRequest.Builder	userContextPolicy(UserContextPolicy userContextPolicy)	The user context policy.
default UpdateIndexRequest.Builder	userGroupResolutionConfiguration(Consumer<UserGroupResolutionConfiguration.Builder> userGroupResolutionConfiguration)	Enables fetching access levels of groups and users from an IAM Identity Center identity source.
UpdateIndexRequest.Builder	userGroupResolutionConfiguration(UserGroupResolutionConfiguration userGroupResolutionConfiguration)	Enables fetching access levels of groups and users from an IAM Identity Center identity source.
UpdateIndexRequest.Builder	userTokenConfigurations(Collection<UserTokenConfiguration> userTokenConfigurations)	The user token configuration.
UpdateIndexRequest.Builder	userTokenConfigurations(Consumer<UserTokenConfiguration.Builder>... userTokenConfigurations)	The user token configuration.
UpdateIndexRequest.Builder	userTokenConfigurations(UserTokenConfiguration... userTokenConfigurations)	The user token configuration.

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.services.kendra.model.KendraRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Method Details

id

UpdateIndexRequest.Builder id(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.

name

UpdateIndexRequest.Builder name(String name)

The name of the index you want to update.

Parameters:

name - The name of the index you want to update.

Returns:

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

roleArn

UpdateIndexRequest.Builder roleArn(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.

description

UpdateIndexRequest.Builder description(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.

documentMetadataConfigurationUpdates

UpdateIndexRequest.Builder documentMetadataConfigurationUpdates(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.

documentMetadataConfigurationUpdates

UpdateIndexRequest.Builder documentMetadataConfigurationUpdates(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.

documentMetadataConfigurationUpdates

UpdateIndexRequest.Builder documentMetadataConfigurationUpdates(Consumer<DocumentMetadataConfiguration.Builder>... 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.

This is a convenience method that creates an instance of the DocumentMetadataConfiguration.Builder avoiding the need to create one manually via DocumentMetadataConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to documentMetadataConfigurationUpdates(List<DocumentMetadataConfiguration>).

Parameters:

documentMetadataConfigurationUpdates - a consumer that will call methods on DocumentMetadataConfiguration.Builder

Returns:

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

See Also:

• documentMetadataConfigurationUpdates(java.util.Collection<DocumentMetadataConfiguration>)

capacityUnits

UpdateIndexRequest.Builder capacityUnits(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.

capacityUnits

default UpdateIndexRequest.Builder capacityUnits(Consumer<CapacityUnitsConfiguration.Builder> 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.

This is a convenience method that creates an instance of the CapacityUnitsConfiguration.Builder avoiding the need to create one manually via CapacityUnitsConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to capacityUnits(CapacityUnitsConfiguration).

Parameters:

capacityUnits - a consumer that will call methods on CapacityUnitsConfiguration.Builder

Returns:

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

See Also:

• capacityUnits(CapacityUnitsConfiguration)

userTokenConfigurations

UpdateIndexRequest.Builder userTokenConfigurations(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.

userTokenConfigurations

UpdateIndexRequest.Builder userTokenConfigurations(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.

userTokenConfigurations

UpdateIndexRequest.Builder userTokenConfigurations(Consumer<UserTokenConfiguration.Builder>... userTokenConfigurations)

The user token configuration.

This is a convenience method that creates an instance of the UserTokenConfiguration.Builder avoiding the need to create one manually via UserTokenConfiguration.builder() .

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to userTokenConfigurations(List<UserTokenConfiguration>).

Parameters:

userTokenConfigurations - a consumer that will call methods on UserTokenConfiguration.Builder

Returns:

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

See Also:

• userTokenConfigurations(java.util.Collection<UserTokenConfiguration>)

userContextPolicy

UpdateIndexRequest.Builder userContextPolicy(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
• UserContextPolicy

userContextPolicy

UpdateIndexRequest.Builder userContextPolicy(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
• UserContextPolicy

userGroupResolutionConfiguration

UpdateIndexRequest.Builder userGroupResolutionConfiguration(UserGroupResolutionConfiguration userGroupResolutionConfiguration)

Enables fetching access levels of groups and users from an IAM Identity Center identity source. To configure this, see UserGroupResolutionConfiguration.

Parameters:

userGroupResolutionConfiguration - Enables fetching access levels of groups and users from an IAM Identity Center identity source. To configure this, see UserGroupResolutionConfiguration.

Returns:

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

userGroupResolutionConfiguration

default UpdateIndexRequest.Builder userGroupResolutionConfiguration(Consumer<UserGroupResolutionConfiguration.Builder> userGroupResolutionConfiguration)

Enables fetching access levels of groups and users from an IAM Identity Center identity source. To configure this, see UserGroupResolutionConfiguration.

This is a convenience method that creates an instance of the UserGroupResolutionConfiguration.Builder avoiding the need to create one manually via UserGroupResolutionConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to userGroupResolutionConfiguration(UserGroupResolutionConfiguration).

Parameters:

userGroupResolutionConfiguration - a consumer that will call methods on UserGroupResolutionConfiguration.Builder

Returns:

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

See Also:

• userGroupResolutionConfiguration(UserGroupResolutionConfiguration)

overrideConfiguration

UpdateIndexRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

UpdateIndexRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.