Interface UpdateIndexRequest.Builder

All Superinterfaces:

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

Enclosing class:

UpdateIndexRequest

@Mutable
@NotThreadSafe
public static interface UpdateIndexRequest.Builder
extends QBusinessRequest.Builder, SdkPojo, CopyableBuilder<UpdateIndexRequest.Builder,UpdateIndexRequest>

Method Summary

Modifier and Type	Method	Description
UpdateIndexRequest.Builder	applicationId(String applicationId)	The identifier of the Amazon Q Business application connected to the index.
default UpdateIndexRequest.Builder	capacityConfiguration(Consumer<IndexCapacityConfiguration.Builder> capacityConfiguration)	The storage capacity units you want to provision for your Amazon Q Business index.
UpdateIndexRequest.Builder	capacityConfiguration(IndexCapacityConfiguration capacityConfiguration)	The storage capacity units you want to provision for your Amazon Q Business index.
UpdateIndexRequest.Builder	description(String description)	The description of the Amazon Q Business index.
UpdateIndexRequest.Builder	displayName(String displayName)	The name of the Amazon Q Business index.
UpdateIndexRequest.Builder	documentAttributeConfigurations(Collection<DocumentAttributeConfiguration> documentAttributeConfigurations)	Configuration information for document metadata or fields.
UpdateIndexRequest.Builder	documentAttributeConfigurations(Consumer<DocumentAttributeConfiguration.Builder>... documentAttributeConfigurations)	Configuration information for document metadata or fields.
UpdateIndexRequest.Builder	documentAttributeConfigurations(DocumentAttributeConfiguration... documentAttributeConfigurations)	Configuration information for document metadata or fields.
UpdateIndexRequest.Builder	indexId(String indexId)	The identifier of the Amazon Q Business index.
UpdateIndexRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
UpdateIndexRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override 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.qbusiness.model.QBusinessRequest.Builder

build

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

applyMutation, build

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

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Details

applicationId

UpdateIndexRequest.Builder applicationId(String applicationId)

The identifier of the Amazon Q Business application connected to the index.

Parameters:

applicationId - The identifier of the Amazon Q Business application connected to the index.

Returns:

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

indexId

UpdateIndexRequest.Builder indexId(String indexId)

The identifier of the Amazon Q Business index.

Parameters:

indexId - The identifier of the Amazon Q Business index.

Returns:

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

displayName

UpdateIndexRequest.Builder displayName(String displayName)

The name of the Amazon Q Business index.

Parameters:

displayName - The name of the Amazon Q Business index.

Returns:

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

description

UpdateIndexRequest.Builder description(String description)

The description of the Amazon Q Business index.

Parameters:

description - The description of the Amazon Q Business index.

Returns:

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

capacityConfiguration

UpdateIndexRequest.Builder capacityConfiguration(IndexCapacityConfiguration capacityConfiguration)

The storage capacity units you want to provision for your Amazon Q Business index. You can add and remove capacity to fit your usage needs.

Parameters:

capacityConfiguration - The storage capacity units you want to provision for your Amazon Q Business index. You can add and remove capacity to fit your usage needs.

Returns:

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

capacityConfiguration

default UpdateIndexRequest.Builder capacityConfiguration(Consumer<IndexCapacityConfiguration.Builder> capacityConfiguration)

The storage capacity units you want to provision for your Amazon Q Business index. You can add and remove capacity to fit your usage needs.

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

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

Parameters:

capacityConfiguration - a consumer that will call methods on IndexCapacityConfiguration.Builder

Returns:

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

See Also:

• capacityConfiguration(IndexCapacityConfiguration)

documentAttributeConfigurations

UpdateIndexRequest.Builder documentAttributeConfigurations(Collection<DocumentAttributeConfiguration> documentAttributeConfigurations)

Configuration information for document metadata or fields. Document metadata are fields or attributes associated with your documents. For example, the company department name associated with each document. For more information, see Understanding document attributes.

Parameters:

documentAttributeConfigurations - Configuration information for document metadata or fields. Document metadata are fields or attributes associated with your documents. For example, the company department name associated with each document. For more information, see Understanding document attributes.

Returns:

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

documentAttributeConfigurations

UpdateIndexRequest.Builder documentAttributeConfigurations(DocumentAttributeConfiguration... documentAttributeConfigurations)

Configuration information for document metadata or fields. Document metadata are fields or attributes associated with your documents. For example, the company department name associated with each document. For more information, see Understanding document attributes.

Parameters:

documentAttributeConfigurations - Configuration information for document metadata or fields. Document metadata are fields or attributes associated with your documents. For example, the company department name associated with each document. For more information, see Understanding document attributes.

Returns:

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

documentAttributeConfigurations

UpdateIndexRequest.Builder documentAttributeConfigurations(Consumer<DocumentAttributeConfiguration.Builder>... documentAttributeConfigurations)

Configuration information for document metadata or fields. Document metadata are fields or attributes associated with your documents. For example, the company department name associated with each document. For more information, see Understanding document attributes.

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

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

Parameters:

documentAttributeConfigurations - a consumer that will call methods on DocumentAttributeConfiguration.Builder

Returns:

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

See Also:

• documentAttributeConfigurations(java.util.Collection<DocumentAttributeConfiguration>)

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.