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 the configuration information to connect to OneDrive as your data source.

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	disableLocalGroups() TRUE to disable local groups information.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<String>	exclusionPatterns() A list of regular expression patterns to exclude certain documents in your OneDrive.
List<DataSourceToIndexFieldMapping>	fieldMappings() A list of DataSourceToIndexFieldMapping objects that map OneDrive data source attributes or field names to Amazon Kendra index field names.
<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.
boolean	hasFieldMappings() For responses, this returns true if the service returned a value for the FieldMappings property.
int	hashCode()
boolean	hasInclusionPatterns() For responses, this returns true if the service returned a value for the InclusionPatterns property.
List<String>	inclusionPatterns() A list of regular expression patterns to include certain documents in your OneDrive.
OneDriveUsers	oneDriveUsers() A list of user accounts whose documents should be indexed.
List<SdkField<?>>	sdkFields()
String	secretArn() The Amazon Resource Name (ARN) of an Secrets Managersecret that contains the user name and password to connect to OneDrive.
static Class<? extends OneDriveConfiguration.Builder>	serializableBuilderClass()
String	tenantDomain() The 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 final String tenantDomain()

The Azure Active Directory domain of the organization.

Returns:

The Azure Active Directory domain of the organization.

secretArn

public final String secretArn()

The Amazon Resource Name (ARN) of an Secrets Managersecret that contains the user name and password to connect to OneDrive. The user name 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 Secrets Managersecret that contains the user name and password to connect to OneDrive. The user name should be the application ID for the OneDrive application, and the password is the application key for the OneDrive application.

oneDriveUsers

public final 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 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 regular expression patterns to include certain documents in your OneDrive. Documents that match the patterns are included in the index. Documents that don't match the patterns are excluded from the index. If a document matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the document isn't included in the index.

The pattern is applied to the file name.

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 regular expression patterns to include certain documents in your OneDrive. Documents that match the patterns are included in the index. Documents that don't match the patterns are excluded from the index. If a document matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the document isn't included in the index.

The pattern is applied to the file name.

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 regular expression patterns to exclude certain documents in your OneDrive. Documents that match the patterns are excluded from the index. Documents that don't match the patterns are included in the index. If a document matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the document isn't included in the index.

The pattern is applied to the file name.

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 regular expression patterns to exclude certain documents in your OneDrive. Documents that match the patterns are excluded from the index. Documents that don't match the patterns are included in the index. If a document matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the document isn't included in the index.

The pattern is applied to the file name.

hasFieldMappings

public final boolean hasFieldMappings()

For responses, this returns true if the service returned a value for the FieldMappings 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.

fieldMappings

public final List<DataSourceToIndexFieldMapping> fieldMappings()

A list of DataSourceToIndexFieldMapping objects that map OneDrive data source attributes or field names to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to OneDrive fields. For more information, see Mapping data source fields. The OneDrive data source field names must exist in your OneDrive custom metadata.

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

Returns:

A list of DataSourceToIndexFieldMapping objects that map OneDrive data source attributes or field names to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to OneDrive fields. For more information, see Mapping data source fields. The OneDrive data source field names must exist in your OneDrive custom metadata.

disableLocalGroups

public final Boolean disableLocalGroups()

TRUE to disable local groups information.

Returns:

TRUE to disable local groups information.

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