software.amazon.awssdk.services.kendra.model

Interface S3DataSourceConfiguration.Builder

All Superinterfaces:

Buildable, CopyableBuilder<S3DataSourceConfiguration.Builder,S3DataSourceConfiguration>, SdkBuilder<S3DataSourceConfiguration.Builder,S3DataSourceConfiguration>, SdkPojo

Enclosing class:

S3DataSourceConfiguration

public static interface S3DataSourceConfiguration.Builder
extends SdkPojo, CopyableBuilder<S3DataSourceConfiguration.Builder,S3DataSourceConfiguration>

Method Summary

Modifier and Type	Method and Description
S3DataSourceConfiguration.Builder	accessControlListConfiguration(AccessControlListConfiguration accessControlListConfiguration) Provides the path to the S3 bucket that contains the user context filtering files for the data source.
default S3DataSourceConfiguration.Builder	accessControlListConfiguration(Consumer<AccessControlListConfiguration.Builder> accessControlListConfiguration) Provides the path to the S3 bucket that contains the user context filtering files for the data source.
S3DataSourceConfiguration.Builder	bucketName(String bucketName) The name of the bucket that contains the documents.
default S3DataSourceConfiguration.Builder	documentsMetadataConfiguration(Consumer<DocumentsMetadataConfiguration.Builder> documentsMetadataConfiguration) Sets the value of the DocumentsMetadataConfiguration property for this object.
S3DataSourceConfiguration.Builder	documentsMetadataConfiguration(DocumentsMetadataConfiguration documentsMetadataConfiguration) Sets the value of the DocumentsMetadataConfiguration property for this object.
S3DataSourceConfiguration.Builder	exclusionPatterns(Collection<String> exclusionPatterns) A list of glob patterns for documents that should not be indexed.
S3DataSourceConfiguration.Builder	exclusionPatterns(String... exclusionPatterns) A list of glob patterns for documents that should not be indexed.
S3DataSourceConfiguration.Builder	inclusionPatterns(Collection<String> inclusionPatterns) A list of glob patterns for documents that should be indexed.
S3DataSourceConfiguration.Builder	inclusionPatterns(String... inclusionPatterns) A list of glob patterns for documents that should be indexed.
S3DataSourceConfiguration.Builder	inclusionPrefixes(Collection<String> inclusionPrefixes) A list of S3 prefixes for the documents that should be included in the index.
S3DataSourceConfiguration.Builder	inclusionPrefixes(String... inclusionPrefixes) A list of S3 prefixes for the documents that should be included in the index.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

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.

For more information about glob patterns, see glob (programming) in Wikipedia.

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.

For more information about glob patterns, see glob (programming) in Wikipedia.

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.

For more information about glob patterns, see glob (programming) in Wikipedia.

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.

For more information about glob patterns, see glob (programming) in Wikipedia.

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.

For more information about glob patterns, see glob (programming) in Wikipedia.

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.

For more information about glob patterns, see glob (programming) in Wikipedia.

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.

For more information about glob patterns, see glob (programming) in Wikipedia.

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.

For more information about glob patterns, see glob (programming) in Wikipedia.

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.

documentsMetadataConfiguration

default S3DataSourceConfiguration.Builder documentsMetadataConfiguration(Consumer<DocumentsMetadataConfiguration.Builder> documentsMetadataConfiguration)

Sets the value of the DocumentsMetadataConfiguration property for this object. This is a convenience that creates an instance of the DocumentsMetadataConfiguration.Builder avoiding the need to create one manually via DocumentsMetadataConfiguration.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to documentsMetadataConfiguration(DocumentsMetadataConfiguration).

Parameters:

documentsMetadataConfiguration - a consumer that will call methods on DocumentsMetadataConfiguration.Builder

Returns:

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

See Also:

documentsMetadataConfiguration(DocumentsMetadataConfiguration)

accessControlListConfiguration

S3DataSourceConfiguration.Builder accessControlListConfiguration(AccessControlListConfiguration accessControlListConfiguration)

Provides the path to the S3 bucket that contains the user context filtering files for the data source. For the format of the file, see Access control for S3 data sources.

Parameters:

accessControlListConfiguration - Provides the path to the S3 bucket that contains the user context filtering files for the data source. For the format of the file, see Access control for S3 data sources.

Returns:

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

accessControlListConfiguration

default S3DataSourceConfiguration.Builder accessControlListConfiguration(Consumer<AccessControlListConfiguration.Builder> accessControlListConfiguration)

Provides the path to the S3 bucket that contains the user context filtering files for the data source. For the format of the file, see Access control for S3 data sources.

This is a convenience that creates an instance of the AccessControlListConfiguration.Builder avoiding the need to create one manually via AccessControlListConfiguration.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to accessControlListConfiguration(AccessControlListConfiguration).

Parameters:

accessControlListConfiguration - a consumer that will call methods on AccessControlListConfiguration.Builder

Returns:

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

See Also:

accessControlListConfiguration(AccessControlListConfiguration)