software.amazon.awssdk.services.kendra.model

Class OneDriveConfiguration

java.lang.Object

software.amazon.awssdk.services.kendra.model.OneDriveConfiguration

All Implemented Interfaces:

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

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

Provides configuration information for data sources that connect to OneDrive.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	OneDriveConfiguration.Builder

Method Summary

Modifier and Type	Method and Description
static OneDriveConfiguration.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<String>	exclusionPatterns() List of regular expressions applied to documents.
List<DataSourceToIndexFieldMapping>	fieldMappings() A list of DataSourceToIndexFieldMapping objects that map Microsoft OneDrive fields to custom fields in the Amazon Kendra index.
<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).
boolean	hasFieldMappings() Returns true if the FieldMappings 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).
List<String>	inclusionPatterns() A list of regular expression patterns.
OneDriveUsers	oneDriveUsers() A list of user accounts whose documents should be indexed.
List<SdkField<?>>	sdkFields()
String	secretArn() The Amazon Resource Name (ARN) of an AWS Secrets Manager secret that contains the user name and password to connect to OneDrive.
static Class<? extends OneDriveConfiguration.Builder>	serializableBuilderClass()
String	tenantDomain() Tha Azure Active Directory domain of the organization.
OneDriveConfiguration.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

tenantDomain

public String tenantDomain()

Tha Azure Active Directory domain of the organization.

Returns:

Tha Azure Active Directory domain of the organization.

secretArn

public String secretArn()

The Amazon Resource Name (ARN) of an AWS Secrets Manager secret that contains the user name and password to connect to OneDrive. The user namd should be the application ID for the OneDrive application, and the password is the application key for the OneDrive application.

Returns:

The Amazon Resource Name (ARN) of an AWS Secrets Manager secret that contains the user name and password to connect to OneDrive. The user namd should be the application ID for the OneDrive application, and the password is the application key for the OneDrive application.

oneDriveUsers

public OneDriveUsers oneDriveUsers()

A list of user accounts whose documents should be indexed.

Returns:

A list of user accounts whose documents should be indexed.

hasInclusionPatterns

public 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 List<String> inclusionPatterns()

A list of regular expression patterns. Documents that match the pattern are included in the index. Documents that don't match the pattern are excluded from the index. If a document matches both an inclusion pattern and an exclusion pattern, the document is not included in the index.

The exclusion pattern is applied to the file name.

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 regular expression patterns. Documents that match the pattern are included in the index. Documents that don't match the pattern are excluded from the index. If a document matches both an inclusion pattern and an exclusion pattern, the document is not included in the index.

The exclusion pattern is applied to the file name.

hasExclusionPatterns

public 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 List<String> exclusionPatterns()

List of regular expressions applied to documents. Items that match the exclusion pattern are not indexed. If you provide both an inclusion pattern and an exclusion pattern, any item that matches the exclusion pattern isn't indexed.

The exclusion pattern is applied to the file name.

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:

List of regular expressions applied to documents. Items that match the exclusion pattern are not indexed. If you provide both an inclusion pattern and an exclusion pattern, any item that matches the exclusion pattern isn't indexed.

The exclusion pattern is applied to the file name.

hasFieldMappings

public boolean hasFieldMappings()

Returns true if the FieldMappings 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.

fieldMappings

public List<DataSourceToIndexFieldMapping> fieldMappings()

A list of DataSourceToIndexFieldMapping objects that map Microsoft OneDrive fields to custom fields in the Amazon Kendra index. You must first create the index fields before you map OneDrive fields.

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

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

Returns:

A list of DataSourceToIndexFieldMapping objects that map Microsoft OneDrive fields to custom fields in the Amazon Kendra index. You must first create the index fields before you map OneDrive fields.

toBuilder

public OneDriveConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<OneDriveConfiguration.Builder,OneDriveConfiguration>

builder

public static OneDriveConfiguration.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo