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

Class UpdateIndexRequest

    • Method Detail

      • id

        public final String id()

        The identifier of the index you want to update.

        Returns:
        The identifier of the index you want to update.

      • name

        public final String name()

        A new name for the index.

        Returns:
        A new name for the index.

      • roleArn

        public final String roleArn()

        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.

      • description

        public final String description()

        A new description for the index.

        Returns:
        A new description for the index.

      • hasDocumentMetadataConfigurationUpdates

        public final boolean hasDocumentMetadataConfigurationUpdates()
        For responses, this returns true if the service returned a value for the DocumentMetadataConfigurationUpdates property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • documentMetadataConfigurationUpdates

        public final List<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.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasDocumentMetadataConfigurationUpdates() method.

        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.

      • capacityUnits

        public final 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.

        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.

      • hasUserTokenConfigurations

        public final boolean hasUserTokenConfigurations()
        For responses, this returns true if the service returned a value for the UserTokenConfigurations property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • userTokenConfigurations

        public final List<UserTokenConfiguration> userTokenConfigurations()

        The user token configuration.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasUserTokenConfigurations() method.

        Returns:
        The user token configuration.

      • userGroupResolutionConfiguration

        public final 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.

        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.

      • toString

        public final 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