S3DataSourceConfiguration (AWS Java SDK :: Services

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 the configuration information to connect to an Amazon S3 bucket.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface S3DataSourceConfiguration.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`S3DataSourceConfiguration.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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()` For responses, this returns true if the service returned a value for the ExclusionPatterns property.
`int`	`hashCode()`
`boolean`	`hasInclusionPatterns()` For responses, this returns true if the service returned a value for the InclusionPatterns property.
`boolean`	`hasInclusionPrefixes()` For responses, this returns true if the service returned a value for the InclusionPrefixes property.
`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()
```
    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.
  - 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

Class S3DataSourceConfiguration

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

bucketName

hasInclusionPrefixes

inclusionPrefixes

hasInclusionPatterns

inclusionPatterns

hasExclusionPatterns

exclusionPatterns

documentsMetadataConfiguration

accessControlListConfiguration

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields