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

Interface S3DataSourceConfiguration.Builder

    • Method Detail

      • bucketName

        S3DataSourceConfiguration.Builder bucketName​(String bucketName)

        The name of the bucket that contains the documents.

        Parameters:
        bucketName - The name of the bucket that contains the documents.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • inclusionPrefixes

        S3DataSourceConfiguration.Builder inclusionPrefixes​(Collection<String> inclusionPrefixes)

        A list of S3 prefixes for the documents that should be included in the index.

        Parameters:
        inclusionPrefixes - A list of S3 prefixes for the documents that should be included in the index.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • inclusionPrefixes

        S3DataSourceConfiguration.Builder inclusionPrefixes​(String... inclusionPrefixes)

        A list of S3 prefixes for the documents that should be included in the index.

        Parameters:
        inclusionPrefixes - A list of S3 prefixes for the documents that should be included in the index.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • inclusionPatterns

        S3DataSourceConfiguration.Builder inclusionPatterns​(Collection<String> inclusionPatterns)

        A list of glob patterns for documents that should be indexed. If a document that matches an inclusion pattern also matches an exclusion pattern, the document is not indexed.

        Some examples are:

        • *.txt will include all text files in a directory (files with the extension .txt).

        • **/*.txt will include all text files in a directory and its subdirectories.

        • *tax* will include all files in a directory that contain 'tax' in the file name, such as 'tax', 'taxes', 'income_tax'.

        Parameters:
        inclusionPatterns - A list of glob patterns for documents that should be indexed. If a document that matches an inclusion pattern also matches an exclusion pattern, the document is not indexed.

        Some examples are:

        • *.txt will include all text files in a directory (files with the extension .txt).

        • **/*.txt will include all text files in a directory and its subdirectories.

        • *tax* will include all files in a directory that contain 'tax' in the file name, such as 'tax', 'taxes', 'income_tax'.

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

      • inclusionPatterns

        S3DataSourceConfiguration.Builder inclusionPatterns​(String... inclusionPatterns)

        A list of glob patterns for documents that should be indexed. If a document that matches an inclusion pattern also matches an exclusion pattern, the document is not indexed.

        Some examples are:

        • *.txt will include all text files in a directory (files with the extension .txt).

        • **/*.txt will include all text files in a directory and its subdirectories.

        • *tax* will include all files in a directory that contain 'tax' in the file name, such as 'tax', 'taxes', 'income_tax'.

        Parameters:
        inclusionPatterns - A list of glob patterns for documents that should be indexed. If a document that matches an inclusion pattern also matches an exclusion pattern, the document is not indexed.

        Some examples are:

        • *.txt will include all text files in a directory (files with the extension .txt).

        • **/*.txt will include all text files in a directory and its subdirectories.

        • *tax* will include all files in a directory that contain 'tax' in the file name, such as 'tax', 'taxes', 'income_tax'.

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

      • exclusionPatterns

        S3DataSourceConfiguration.Builder exclusionPatterns​(Collection<String> exclusionPatterns)

        A list of glob patterns for documents that should not be indexed. If a document that matches an inclusion prefix or inclusion pattern also matches an exclusion pattern, the document is not indexed.

        Some examples are:

        • *.png , *.jpg will exclude all PNG and JPEG image files in a directory (files with the extensions .png and .jpg).

        • *internal* will exclude all files in a directory that contain 'internal' in the file name, such as 'internal', 'internal_only', 'company_internal'.

        • **/*internal* will exclude all internal-related files in a directory and its subdirectories.

        Parameters:
        exclusionPatterns - A list of glob patterns for documents that should not be indexed. If a document that matches an inclusion prefix or inclusion pattern also matches an exclusion pattern, the document is not indexed.

        Some examples are:

        • *.png , *.jpg will exclude all PNG and JPEG image files in a directory (files with the extensions .png and .jpg).

        • *internal* will exclude all files in a directory that contain 'internal' in the file name, such as 'internal', 'internal_only', 'company_internal'.

        • **/*internal* will exclude all internal-related files in a directory and its subdirectories.

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

      • exclusionPatterns

        S3DataSourceConfiguration.Builder exclusionPatterns​(String... exclusionPatterns)

        A list of glob patterns for documents that should not be indexed. If a document that matches an inclusion prefix or inclusion pattern also matches an exclusion pattern, the document is not indexed.

        Some examples are:

        • *.png , *.jpg will exclude all PNG and JPEG image files in a directory (files with the extensions .png and .jpg).

        • *internal* will exclude all files in a directory that contain 'internal' in the file name, such as 'internal', 'internal_only', 'company_internal'.

        • **/*internal* will exclude all internal-related files in a directory and its subdirectories.

        Parameters:
        exclusionPatterns - A list of glob patterns for documents that should not be indexed. If a document that matches an inclusion prefix or inclusion pattern also matches an exclusion pattern, the document is not indexed.

        Some examples are:

        • *.png , *.jpg will exclude all PNG and JPEG image files in a directory (files with the extensions .png and .jpg).

        • *internal* will exclude all files in a directory that contain 'internal' in the file name, such as 'internal', 'internal_only', 'company_internal'.

        • **/*internal* will exclude all internal-related files in a directory and its subdirectories.

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

      • documentsMetadataConfiguration

        S3DataSourceConfiguration.Builder documentsMetadataConfiguration​(DocumentsMetadataConfiguration documentsMetadataConfiguration)
        Sets the value of the DocumentsMetadataConfiguration property for this object.
        Parameters:
        documentsMetadataConfiguration - The new value for the DocumentsMetadataConfiguration property for this object.
        Returns:
        Returns a reference to this object so that method calls can be chained together.