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

Class S3DataSourceConfiguration

    • Method Detail

      • bucketName

        public final String bucketName()

        The name of the bucket that contains the documents.

        Returns:
        The name of the bucket that contains the documents.

      • hasInclusionPrefixes

        public final boolean hasInclusionPrefixes()
        For responses, this returns true if the service returned a value for the InclusionPrefixes 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.

      • inclusionPrefixes

        public final List<String> inclusionPrefixes()

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

        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 hasInclusionPrefixes() method.

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

      • hasInclusionPatterns

        public final boolean hasInclusionPatterns()
        For responses, this returns true if the service returned a value for the InclusionPatterns 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.

      • inclusionPatterns

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

        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 hasInclusionPatterns() method.

        Returns:
        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'.

      • hasExclusionPatterns

        public final boolean hasExclusionPatterns()
        For responses, this returns true if the service returned a value for the ExclusionPatterns 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.

      • exclusionPatterns

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

        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 hasExclusionPatterns() method.

        Returns:
        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.

      • documentsMetadataConfiguration

        public final DocumentsMetadataConfiguration documentsMetadataConfiguration()
        Returns the value of the DocumentsMetadataConfiguration property for this object.
        Returns:
        The value of the DocumentsMetadataConfiguration property for this object.

      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object

      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object

      • 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

      • getValueForField

        public final <T> Optional<T> getValueForField​(String fieldName,
                                              Class<T> clazz)