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

Interface DescribeIndexResponse.Builder

    • Method Detail

      • 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 KMS customer master key (CMK) that is used to encrypt your data. Amazon Kendra doesn't support asymmetric CMKs.

        Parameters:
        serverSideEncryptionConfiguration - The identifier of the KMS customer 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.

      • 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 timestamp when the index was last updated.

        Parameters:
        updatedAt - The Unix timestamp 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.

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

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

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

      • 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

      • userGroupResolutionConfiguration

        DescribeIndexResponse.Builder userGroupResolutionConfiguration​(UserGroupResolutionConfiguration userGroupResolutionConfiguration)

        Whether you have enabled IAM Identity Center identity source for your users and groups. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.

        Parameters:
        userGroupResolutionConfiguration - Whether you have enabled IAM Identity Center identity source for your users and groups. 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.