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

Interface DescribeIndexResponse.Builder

All Superinterfaces:

AwsResponse.Builder, Buildable, CopyableBuilder<DescribeIndexResponse.Builder,DescribeIndexResponse>, KendraResponse.Builder, SdkBuilder<DescribeIndexResponse.Builder,DescribeIndexResponse>, SdkPojo, SdkResponse.Builder

Enclosing class:

DescribeIndexResponse

public static interface DescribeIndexResponse.Builder
extends KendraResponse.Builder, SdkPojo, CopyableBuilder<DescribeIndexResponse.Builder,DescribeIndexResponse>

Method Summary

Modifier and Type	Method	Description
default DescribeIndexResponse.Builder	capacityUnits(Consumer<CapacityUnitsConfiguration.Builder> capacityUnits)	For Enterprise Edition indexes, you can choose to use additional capacity to meet the needs of your application.
DescribeIndexResponse.Builder	capacityUnits(CapacityUnitsConfiguration capacityUnits)	For Enterprise Edition indexes, you can choose to use additional capacity to meet the needs of your application.
DescribeIndexResponse.Builder	createdAt(Instant createdAt)	The Unix timestamp when the index was created.
DescribeIndexResponse.Builder	description(String description)	The description for the index.
DescribeIndexResponse.Builder	documentMetadataConfigurations(Collection<DocumentMetadataConfiguration> documentMetadataConfigurations)	Configuration information for document metadata or fields.
DescribeIndexResponse.Builder	documentMetadataConfigurations(Consumer<DocumentMetadataConfiguration.Builder>... documentMetadataConfigurations)	Configuration information for document metadata or fields.
DescribeIndexResponse.Builder	documentMetadataConfigurations(DocumentMetadataConfiguration... documentMetadataConfigurations)	Configuration information for document metadata or fields.
DescribeIndexResponse.Builder	edition(String edition)	The Amazon Kendra edition used for the index.
DescribeIndexResponse.Builder	edition(IndexEdition edition)	The Amazon Kendra edition used for the index.
DescribeIndexResponse.Builder	errorMessage(String errorMessage)	When the Status field value is FAILED, the ErrorMessage field contains a message that explains why.
DescribeIndexResponse.Builder	id(String id)	The identifier of the index.
default DescribeIndexResponse.Builder	indexStatistics(Consumer<IndexStatistics.Builder> indexStatistics)	Provides information about the number of FAQ questions and answers and the number of text documents indexed.
DescribeIndexResponse.Builder	indexStatistics(IndexStatistics indexStatistics)	Provides information about the number of FAQ questions and answers and the number of text documents indexed.
DescribeIndexResponse.Builder	name(String name)	The name of the index.
DescribeIndexResponse.Builder	roleArn(String roleArn)	The Amazon Resource Name (ARN) of the IAM role that gives Amazon Kendra permission to write to your Amazon Cloudwatch logs.
default DescribeIndexResponse.Builder	serverSideEncryptionConfiguration(Consumer<ServerSideEncryptionConfiguration.Builder> serverSideEncryptionConfiguration)	The identifier of the KMScustomer master key (CMK) that is used to encrypt your data.
DescribeIndexResponse.Builder	serverSideEncryptionConfiguration(ServerSideEncryptionConfiguration serverSideEncryptionConfiguration)	The identifier of the KMScustomer master key (CMK) that is used to encrypt your data.
DescribeIndexResponse.Builder	status(String status)	The current status of the index.
DescribeIndexResponse.Builder	status(IndexStatus status)	The current status of the index.
DescribeIndexResponse.Builder	updatedAt(Instant updatedAt)	The Unix when the index was last updated.
DescribeIndexResponse.Builder	userContextPolicy(String userContextPolicy)	The user context policy for the Amazon Kendra index.
DescribeIndexResponse.Builder	userContextPolicy(UserContextPolicy userContextPolicy)	The user context policy for the Amazon Kendra index.
default DescribeIndexResponse.Builder	userGroupResolutionConfiguration(Consumer<UserGroupResolutionConfiguration.Builder> userGroupResolutionConfiguration)	Whether you have enabled the configuration for fetching access levels of groups and users from an IAM Identity Center identity source.
DescribeIndexResponse.Builder	userGroupResolutionConfiguration(UserGroupResolutionConfiguration userGroupResolutionConfiguration)	Whether you have enabled the configuration for fetching access levels of groups and users from an IAM Identity Center identity source.
DescribeIndexResponse.Builder	userTokenConfigurations(Collection<UserTokenConfiguration> userTokenConfigurations)	The user token configuration for the Amazon Kendra index.
DescribeIndexResponse.Builder	userTokenConfigurations(Consumer<UserTokenConfiguration.Builder>... userTokenConfigurations)	The user token configuration for the Amazon Kendra index.
DescribeIndexResponse.Builder	userTokenConfigurations(UserTokenConfiguration... userTokenConfigurations)	The user token configuration for the Amazon Kendra index.

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

copy

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

build, responseMetadata, responseMetadata

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

applyMutation, build

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

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder

sdkHttpResponse, sdkHttpResponse

Method Details

name

DescribeIndexResponse.Builder name(String name)

The name of the index.

Parameters:

name - The name of the index.

Returns:

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

id

DescribeIndexResponse.Builder id(String id)

The identifier of the index.

Parameters:

id - The identifier of the index.

Returns:

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

edition

DescribeIndexResponse.Builder edition(String edition)

The Amazon Kendra edition used for the index. You decide the edition when you create the index.

Parameters:

edition - The Amazon Kendra edition used for the index. You decide the edition when you create the index.

Returns:

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

See Also:

• IndexEdition
• IndexEdition

edition

DescribeIndexResponse.Builder edition(IndexEdition edition)

The Amazon Kendra edition used for the index. You decide the edition when you create the index.

Parameters:

edition - The Amazon Kendra edition used for the index. You decide the edition when you create the index.

Returns:

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

See Also:

• IndexEdition
• IndexEdition

roleArn

DescribeIndexResponse.Builder roleArn(String roleArn)

The Amazon Resource Name (ARN) of the IAM role that gives Amazon Kendra permission to write to your Amazon Cloudwatch logs.

Parameters:

roleArn - The Amazon Resource Name (ARN) of the IAM role that gives Amazon Kendra permission to write to your Amazon Cloudwatch logs.

Returns:

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

serverSideEncryptionConfiguration

DescribeIndexResponse.Builder serverSideEncryptionConfiguration(ServerSideEncryptionConfiguration serverSideEncryptionConfiguration)

The identifier of the KMScustomer master key (CMK) that is used to encrypt your data. Amazon Kendra doesn't support asymmetric CMKs.

Parameters:

serverSideEncryptionConfiguration - The identifier of the KMScustomer master key (CMK) that is used to encrypt your data. Amazon Kendra doesn't support asymmetric CMKs.

Returns:

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

serverSideEncryptionConfiguration

default DescribeIndexResponse.Builder serverSideEncryptionConfiguration(Consumer<ServerSideEncryptionConfiguration.Builder> serverSideEncryptionConfiguration)

The identifier of the KMScustomer master key (CMK) that is used to encrypt your data. Amazon Kendra doesn't support asymmetric CMKs.

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

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

Parameters:

serverSideEncryptionConfiguration - a consumer that will call methods on ServerSideEncryptionConfiguration.Builder

Returns:

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

See Also:

• serverSideEncryptionConfiguration(ServerSideEncryptionConfiguration)

status

DescribeIndexResponse.Builder status(String status)

The current status of the index. When the value is ACTIVE, the index is ready for use. If the Status field value is FAILED, the ErrorMessage field contains a message that explains why.

Parameters:

status - The current status of the index. When the value is ACTIVE, the index is ready for use. If the Status field value is FAILED, the ErrorMessage field contains a message that explains why.

Returns:

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

See Also:

• IndexStatus
• IndexStatus

status

DescribeIndexResponse.Builder status(IndexStatus status)

The current status of the index. When the value is ACTIVE, the index is ready for use. If the Status field value is FAILED, the ErrorMessage field contains a message that explains why.

Parameters:

status - The current status of the index. When the value is ACTIVE, the index is ready for use. If the Status field value is FAILED, the ErrorMessage field contains a message that explains why.

Returns:

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

See Also:

• IndexStatus
• IndexStatus

description

DescribeIndexResponse.Builder description(String description)

The description for the index.

Parameters:

description - The description for the index.

Returns:

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

createdAt

DescribeIndexResponse.Builder createdAt(Instant createdAt)

The Unix timestamp when the index was created.

Parameters:

createdAt - The Unix timestamp when the index was created.

Returns:

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

updatedAt

DescribeIndexResponse.Builder updatedAt(Instant updatedAt)

The Unix when the index was last updated.

Parameters:

updatedAt - The Unix when the index was last updated.

Returns:

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

documentMetadataConfigurations

DescribeIndexResponse.Builder documentMetadataConfigurations(Collection<DocumentMetadataConfiguration> documentMetadataConfigurations)

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.

Parameters:

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

Returns:

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

documentMetadataConfigurations

DescribeIndexResponse.Builder documentMetadataConfigurations(DocumentMetadataConfiguration... documentMetadataConfigurations)

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.

Parameters:

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

Returns:

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

documentMetadataConfigurations

DescribeIndexResponse.Builder documentMetadataConfigurations(Consumer<DocumentMetadataConfiguration.Builder>... documentMetadataConfigurations)

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.

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 documentMetadataConfigurations(List<DocumentMetadataConfiguration>).

Parameters:

documentMetadataConfigurations - 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:

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

indexStatistics

DescribeIndexResponse.Builder indexStatistics(IndexStatistics indexStatistics)

Provides information about the number of FAQ questions and answers and the number of text documents indexed.

Parameters:

indexStatistics - Provides information about the number of FAQ questions and answers and the number of text documents indexed.

Returns:

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

indexStatistics

default DescribeIndexResponse.Builder indexStatistics(Consumer<IndexStatistics.Builder> indexStatistics)

Provides information about the number of FAQ questions and answers and the number of text documents indexed.

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

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

Parameters:

indexStatistics - a consumer that will call methods on IndexStatistics.Builder

Returns:

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

See Also:

• indexStatistics(IndexStatistics)

errorMessage

DescribeIndexResponse.Builder errorMessage(String errorMessage)

When the Status field value is FAILED, the ErrorMessage field contains a message that explains why.

Parameters:

errorMessage - When the Status field value is FAILED, the ErrorMessage field contains a message that explains why.

Returns:

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

capacityUnits

DescribeIndexResponse.Builder capacityUnits(CapacityUnitsConfiguration capacityUnits)

For Enterprise Edition indexes, you can choose to use additional capacity to meet the needs of your application. This contains the capacity units used for the index. A query or document storage capacity of zero indicates that the index is using the default capacity. For more information on the default capacity for an index and adjusting this, see Adjusting capacity.

Parameters:

capacityUnits - For Enterprise Edition indexes, you can choose to use additional capacity to meet the needs of your application. This contains the capacity units used for the index. A query or document storage capacity of zero indicates that the index is using the default capacity. For more information on the default capacity for an index and adjusting this, see Adjusting capacity.

Returns:

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

capacityUnits

default DescribeIndexResponse.Builder capacityUnits(Consumer<CapacityUnitsConfiguration.Builder> capacityUnits)

For Enterprise Edition indexes, you can choose to use additional capacity to meet the needs of your application. This contains the capacity units used for the index. A query or document storage capacity of zero indicates that the index is using the default capacity. For more information on the default capacity for an index and adjusting this, see Adjusting capacity.

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

DescribeIndexResponse.Builder userTokenConfigurations(Collection<UserTokenConfiguration> userTokenConfigurations)

The user token configuration for the Amazon Kendra index.

Parameters:

userTokenConfigurations - The user token configuration for the Amazon Kendra index.

Returns:

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

userTokenConfigurations

DescribeIndexResponse.Builder userTokenConfigurations(UserTokenConfiguration... userTokenConfigurations)

The user token configuration for the Amazon Kendra index.

Parameters:

userTokenConfigurations - The user token configuration for the Amazon Kendra index.

Returns:

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

userTokenConfigurations

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

The user token configuration for the Amazon Kendra index.

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

DescribeIndexResponse.Builder userContextPolicy(String userContextPolicy)

The user context policy for the Amazon Kendra index.

Parameters:

userContextPolicy - The user context policy for the Amazon Kendra index.

Returns:

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

See Also:

• UserContextPolicy
• UserContextPolicy

userContextPolicy

DescribeIndexResponse.Builder userContextPolicy(UserContextPolicy userContextPolicy)

The user context policy for the Amazon Kendra index.

Parameters:

userContextPolicy - The user context policy for the Amazon Kendra index.

Returns:

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

See Also:

• UserContextPolicy
• UserContextPolicy

userGroupResolutionConfiguration

DescribeIndexResponse.Builder userGroupResolutionConfiguration(UserGroupResolutionConfiguration userGroupResolutionConfiguration)

Whether you have enabled the configuration for fetching access levels of groups and users from an IAM Identity Center identity source.

Parameters:

userGroupResolutionConfiguration - Whether you have enabled the configuration for fetching access levels of groups and users from an IAM Identity Center identity source.

Returns:

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

userGroupResolutionConfiguration

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

Whether you have enabled the configuration for fetching access levels of groups and users from an IAM Identity Center identity source.

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)