software.amazon.awssdk.services.kendra.model

Class S3DataSourceConfiguration

java.lang.Object

software.amazon.awssdk.services.kendra.model.S3DataSourceConfiguration

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<S3DataSourceConfiguration.Builder,S3DataSourceConfiguration>

@Generated(value="software.amazon.awssdk:codegen")
public final class S3DataSourceConfiguration
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<S3DataSourceConfiguration.Builder,S3DataSourceConfiguration>

Provides configuration information for a data source to index documents in an Amazon S3 bucket.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	S3DataSourceConfiguration.Builder

Method Summary

Modifier and Type	Method and Description
AccessControlListConfiguration	accessControlListConfiguration() Provides the path to the S3 bucket that contains the user context filtering files for the data source.
String	bucketName() The name of the bucket that contains the documents.
static S3DataSourceConfiguration.Builder	builder()
DocumentsMetadataConfiguration	documentsMetadataConfiguration() Returns the value of the DocumentsMetadataConfiguration property for this object.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<String>	exclusionPatterns() A list of glob patterns for documents that should not be indexed.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasExclusionPatterns() Returns true if the ExclusionPatterns property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
int	hashCode()
boolean	hasInclusionPatterns() Returns true if the InclusionPatterns property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
boolean	hasInclusionPrefixes() Returns true if the InclusionPrefixes property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
List<String>	inclusionPatterns() A list of glob patterns for documents that should be indexed.
List<String>	inclusionPrefixes() A list of S3 prefixes for the documents that should be included in the index.
List<SdkField<?>>	sdkFields()
static Class<? extends S3DataSourceConfiguration.Builder>	serializableBuilderClass()
S3DataSourceConfiguration.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

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()

Returns true if the InclusionPrefixes property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

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.

You can use hasInclusionPrefixes() to see if a value was sent in this field.

Returns:

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

hasInclusionPatterns

public final boolean hasInclusionPatterns()

Returns true if the InclusionPatterns property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

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.

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

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

You can use hasInclusionPatterns() to see if a value was sent in this field.

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.

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

hasExclusionPatterns

public final boolean hasExclusionPatterns()

Returns true if the ExclusionPatterns property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

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.

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

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

You can use hasExclusionPatterns() to see if a value was sent in this field.

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.

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

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.

accessControlListConfiguration

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

Returns:

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.

toBuilder

public S3DataSourceConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<S3DataSourceConfiguration.Builder,S3DataSourceConfiguration>

builder

public static S3DataSourceConfiguration.Builder builder()

serializableBuilderClass

public static Class<? extends S3DataSourceConfiguration.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo