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 (patterns that can expand a wildcard pattern into a list of path names that match the given pattern) for certain file names and file types to include in your index. If a document matches both an inclusion and exclusion prefix or pattern, the exclusion prefix takes precendence and the document is not indexed. Examples of glob patterns include:

        • /myapp/config/*—All files inside config directory.

        • **/*.png—All .png files in all directories.

        • **/*.{png, ico, md}—All .png, .ico or .md files in all directories.

        • /myapp/src/**/*.ts—All .ts files inside src directory (and all its subdirectories).

        • **/!(*.module).ts—All .ts files but not .module.ts

        • *.png , *.jpg—All PNG and JPEG image files in a directory (files with the extensions .png and .jpg).

        • *internal*—All files in a directory that contain 'internal' in the file name, such as 'internal', 'internal_only', 'company_internal'.

        • **/*internal*—All internal-related files in a directory and its subdirectories.

        For more examples, see Use of Exclude and Include Filters in the Amazon Web Services CLI Command Reference.

        Parameters:
        inclusionPatterns - A list of glob patterns (patterns that can expand a wildcard pattern into a list of path names that match the given pattern) for certain file names and file types to include in your index. If a document matches both an inclusion and exclusion prefix or pattern, the exclusion prefix takes precendence and the document is not indexed. Examples of glob patterns include:

        • /myapp/config/*—All files inside config directory.

        • **/*.png—All .png files in all directories.

        • **/*.{png, ico, md}—All .png, .ico or .md files in all directories.

        • /myapp/src/**/*.ts—All .ts files inside src directory (and all its subdirectories).

        • **/!(*.module).ts—All .ts files but not .module.ts

        • *.png , *.jpg—All PNG and JPEG image files in a directory (files with the extensions .png and .jpg).

        • *internal*—All files in a directory that contain 'internal' in the file name, such as 'internal', 'internal_only', 'company_internal'.

        • **/*internal*—All internal-related files in a directory and its subdirectories.

        For more examples, see Use of Exclude and Include Filters in the Amazon Web Services CLI Command Reference.

        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 (patterns that can expand a wildcard pattern into a list of path names that match the given pattern) for certain file names and file types to include in your index. If a document matches both an inclusion and exclusion prefix or pattern, the exclusion prefix takes precendence and the document is not indexed. Examples of glob patterns include:

        • /myapp/config/*—All files inside config directory.

        • **/*.png—All .png files in all directories.

        • **/*.{png, ico, md}—All .png, .ico or .md files in all directories.

        • /myapp/src/**/*.ts—All .ts files inside src directory (and all its subdirectories).

        • **/!(*.module).ts—All .ts files but not .module.ts

        • *.png , *.jpg—All PNG and JPEG image files in a directory (files with the extensions .png and .jpg).

        • *internal*—All files in a directory that contain 'internal' in the file name, such as 'internal', 'internal_only', 'company_internal'.

        • **/*internal*—All internal-related files in a directory and its subdirectories.

        For more examples, see Use of Exclude and Include Filters in the Amazon Web Services CLI Command Reference.

        Parameters:
        inclusionPatterns - A list of glob patterns (patterns that can expand a wildcard pattern into a list of path names that match the given pattern) for certain file names and file types to include in your index. If a document matches both an inclusion and exclusion prefix or pattern, the exclusion prefix takes precendence and the document is not indexed. Examples of glob patterns include:

        • /myapp/config/*—All files inside config directory.

        • **/*.png—All .png files in all directories.

        • **/*.{png, ico, md}—All .png, .ico or .md files in all directories.

        • /myapp/src/**/*.ts—All .ts files inside src directory (and all its subdirectories).

        • **/!(*.module).ts—All .ts files but not .module.ts

        • *.png , *.jpg—All PNG and JPEG image files in a directory (files with the extensions .png and .jpg).

        • *internal*—All files in a directory that contain 'internal' in the file name, such as 'internal', 'internal_only', 'company_internal'.

        • **/*internal*—All internal-related files in a directory and its subdirectories.

        For more examples, see Use of Exclude and Include Filters in the Amazon Web Services CLI Command Reference.

        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 (patterns that can expand a wildcard pattern into a list of path names that match the given pattern) for certain file names and file types to exclude from your index. If a document matches both an inclusion and exclusion prefix or pattern, the exclusion prefix takes precendence and the document is not indexed. Examples of glob patterns include:

        • /myapp/config/*—All files inside config directory.

        • **/*.png—All .png files in all directories.

        • **/*.{png, ico, md}—All .png, .ico or .md files in all directories.

        • /myapp/src/**/*.ts—All .ts files inside src directory (and all its subdirectories).

        • **/!(*.module).ts—All .ts files but not .module.ts

        • *.png , *.jpg—All PNG and JPEG image files in a directory (files with the extensions .png and .jpg).

        • *internal*—All files in a directory that contain 'internal' in the file name, such as 'internal', 'internal_only', 'company_internal'.

        • **/*internal*—All internal-related files in a directory and its subdirectories.

        For more examples, see Use of Exclude and Include Filters in the Amazon Web Services CLI Command Reference.

        Parameters:
        exclusionPatterns - A list of glob patterns (patterns that can expand a wildcard pattern into a list of path names that match the given pattern) for certain file names and file types to exclude from your index. If a document matches both an inclusion and exclusion prefix or pattern, the exclusion prefix takes precendence and the document is not indexed. Examples of glob patterns include:

        • /myapp/config/*—All files inside config directory.

        • **/*.png—All .png files in all directories.

        • **/*.{png, ico, md}—All .png, .ico or .md files in all directories.

        • /myapp/src/**/*.ts—All .ts files inside src directory (and all its subdirectories).

        • **/!(*.module).ts—All .ts files but not .module.ts

        • *.png , *.jpg—All PNG and JPEG image files in a directory (files with the extensions .png and .jpg).

        • *internal*—All files in a directory that contain 'internal' in the file name, such as 'internal', 'internal_only', 'company_internal'.

        • **/*internal*—All internal-related files in a directory and its subdirectories.

        For more examples, see Use of Exclude and Include Filters in the Amazon Web Services CLI Command Reference.

        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 (patterns that can expand a wildcard pattern into a list of path names that match the given pattern) for certain file names and file types to exclude from your index. If a document matches both an inclusion and exclusion prefix or pattern, the exclusion prefix takes precendence and the document is not indexed. Examples of glob patterns include:

        • /myapp/config/*—All files inside config directory.

        • **/*.png—All .png files in all directories.

        • **/*.{png, ico, md}—All .png, .ico or .md files in all directories.

        • /myapp/src/**/*.ts—All .ts files inside src directory (and all its subdirectories).

        • **/!(*.module).ts—All .ts files but not .module.ts

        • *.png , *.jpg—All PNG and JPEG image files in a directory (files with the extensions .png and .jpg).

        • *internal*—All files in a directory that contain 'internal' in the file name, such as 'internal', 'internal_only', 'company_internal'.

        • **/*internal*—All internal-related files in a directory and its subdirectories.

        For more examples, see Use of Exclude and Include Filters in the Amazon Web Services CLI Command Reference.

        Parameters:
        exclusionPatterns - A list of glob patterns (patterns that can expand a wildcard pattern into a list of path names that match the given pattern) for certain file names and file types to exclude from your index. If a document matches both an inclusion and exclusion prefix or pattern, the exclusion prefix takes precendence and the document is not indexed. Examples of glob patterns include:

        • /myapp/config/*—All files inside config directory.

        • **/*.png—All .png files in all directories.

        • **/*.{png, ico, md}—All .png, .ico or .md files in all directories.

        • /myapp/src/**/*.ts—All .ts files inside src directory (and all its subdirectories).

        • **/!(*.module).ts—All .ts files but not .module.ts

        • *.png , *.jpg—All PNG and JPEG image files in a directory (files with the extensions .png and .jpg).

        • *internal*—All files in a directory that contain 'internal' in the file name, such as 'internal', 'internal_only', 'company_internal'.

        • **/*internal*—All internal-related files in a directory and its subdirectories.

        For more examples, see Use of Exclude and Include Filters in the Amazon Web Services CLI Command Reference.

        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.