OneDriveConfiguration (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.kendra.model.OneDriveConfiguration

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class OneDriveConfiguration
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Provides configuration information for data sources that connect to OneDrive.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

OneDriveConfiguration()

Constructors
Constructor and Description
`OneDriveConfiguration()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`OneDriveConfiguration`	`clone()`
`boolean`	`equals(Object obj)`
`Boolean`	`getDisableLocalGroups()` A Boolean value that specifies whether local groups are disabled (`True`) or enabled ( `False`).
`List<String>`	`getExclusionPatterns()` List of regular expressions applied to documents.
`List<DataSourceToIndexFieldMapping>`	`getFieldMappings()` A list of `DataSourceToIndexFieldMapping` objects that map Microsoft OneDrive fields to custom fields in the Amazon Kendra index.
`List<String>`	`getInclusionPatterns()` A list of regular expression patterns.
`OneDriveUsers`	`getOneDriveUsers()` A list of user accounts whose documents should be indexed.
`String`	`getSecretArn()` The Amazon Resource Name (ARN) of an AWS Secrets Manager secret that contains the user name and password to connect to OneDrive.
`String`	`getTenantDomain()` The Azure Active Directory domain of the organization.
`int`	`hashCode()`
`Boolean`	`isDisableLocalGroups()` A Boolean value that specifies whether local groups are disabled (`True`) or enabled ( `False`).
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setDisableLocalGroups(Boolean disableLocalGroups)` A Boolean value that specifies whether local groups are disabled (`True`) or enabled ( `False`).
`void`	`setExclusionPatterns(Collection<String> exclusionPatterns)` List of regular expressions applied to documents.
`void`	`setFieldMappings(Collection<DataSourceToIndexFieldMapping> fieldMappings)` A list of `DataSourceToIndexFieldMapping` objects that map Microsoft OneDrive fields to custom fields in the Amazon Kendra index.
`void`	`setInclusionPatterns(Collection<String> inclusionPatterns)` A list of regular expression patterns.
`void`	`setOneDriveUsers(OneDriveUsers oneDriveUsers)` A list of user accounts whose documents should be indexed.
`void`	`setSecretArn(String secretArn)` The Amazon Resource Name (ARN) of an AWS Secrets Manager secret that contains the user name and password to connect to OneDrive.
`void`	`setTenantDomain(String tenantDomain)` The Azure Active Directory domain of the organization.
`String`	`toString()` Returns a string representation of this object.
`OneDriveConfiguration`	`withDisableLocalGroups(Boolean disableLocalGroups)` A Boolean value that specifies whether local groups are disabled (`True`) or enabled ( `False`).
`OneDriveConfiguration`	`withExclusionPatterns(Collection<String> exclusionPatterns)` List of regular expressions applied to documents.
`OneDriveConfiguration`	`withExclusionPatterns(String... exclusionPatterns)` List of regular expressions applied to documents.
`OneDriveConfiguration`	`withFieldMappings(Collection<DataSourceToIndexFieldMapping> fieldMappings)` A list of `DataSourceToIndexFieldMapping` objects that map Microsoft OneDrive fields to custom fields in the Amazon Kendra index.
`OneDriveConfiguration`	`withFieldMappings(DataSourceToIndexFieldMapping... fieldMappings)` A list of `DataSourceToIndexFieldMapping` objects that map Microsoft OneDrive fields to custom fields in the Amazon Kendra index.
`OneDriveConfiguration`	`withInclusionPatterns(Collection<String> inclusionPatterns)` A list of regular expression patterns.
`OneDriveConfiguration`	`withInclusionPatterns(String... inclusionPatterns)` A list of regular expression patterns.
`OneDriveConfiguration`	`withOneDriveUsers(OneDriveUsers oneDriveUsers)` A list of user accounts whose documents should be indexed.
`OneDriveConfiguration`	`withSecretArn(String secretArn)` The Amazon Resource Name (ARN) of an AWS Secrets Manager secret that contains the user name and password to connect to OneDrive.
`OneDriveConfiguration`	`withTenantDomain(String tenantDomain)` The Azure Active Directory domain of the organization.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - OneDriveConfiguration
```
public OneDriveConfiguration()
```
- Method Detail
  - setTenantDomain
```
public void setTenantDomain(String tenantDomain)
```
    The Azure Active Directory domain of the organization.
    
    Parameters:
    
    tenantDomain - The Azure Active Directory domain of the organization.
  - getTenantDomain
```
public String getTenantDomain()
```
    The Azure Active Directory domain of the organization.
    
    Returns:
    
    The Azure Active Directory domain of the organization.
  - withTenantDomain
```
public OneDriveConfiguration withTenantDomain(String tenantDomain)
```
    The Azure Active Directory domain of the organization.
    
    Parameters:
    
    tenantDomain - The Azure Active Directory domain of the organization.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSecretArn
```
public void setSecretArn(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.
    
    Parameters:
    
    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.
  - getSecretArn
```
public String getSecretArn()
```
    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.
  - withSecretArn
```
public OneDriveConfiguration withSecretArn(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setOneDriveUsers
```
public void setOneDriveUsers(OneDriveUsers oneDriveUsers)
```
    A list of user accounts whose documents should be indexed.
    
    Parameters:
    
    oneDriveUsers - A list of user accounts whose documents should be indexed.
  - getOneDriveUsers
```
public OneDriveUsers getOneDriveUsers()
```
    A list of user accounts whose documents should be indexed.
    
    Returns:
    
    A list of user accounts whose documents should be indexed.
  - withOneDriveUsers
```
public OneDriveConfiguration withOneDriveUsers(OneDriveUsers oneDriveUsers)
```
    A list of user accounts whose documents should be indexed.
    
    Parameters:
    
    oneDriveUsers - A list of user accounts whose documents should be indexed.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getInclusionPatterns
```
public List<String> getInclusionPatterns()
```
    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.
    
    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.
  - setInclusionPatterns
```
public void setInclusionPatterns(Collection<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.
    
    Parameters:
    
    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.
  - withInclusionPatterns
```
public OneDriveConfiguration withInclusionPatterns(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.
    
    NOTE: This method appends the values to the existing list (if any). Use setInclusionPatterns(java.util.Collection) or withInclusionPatterns(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withInclusionPatterns
```
public OneDriveConfiguration withInclusionPatterns(Collection<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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getExclusionPatterns
```
public List<String> getExclusionPatterns()
```
    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.
    
    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.
  - setExclusionPatterns
```
public void setExclusionPatterns(Collection<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.
    
    Parameters:
    
    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.
  - withExclusionPatterns
```
public OneDriveConfiguration withExclusionPatterns(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.
    
    NOTE: This method appends the values to the existing list (if any). Use setExclusionPatterns(java.util.Collection) or withExclusionPatterns(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withExclusionPatterns
```
public OneDriveConfiguration withExclusionPatterns(Collection<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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getFieldMappings
```
public List<DataSourceToIndexFieldMapping> getFieldMappings()
```
    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.
    
    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.
  - setFieldMappings
```
public void setFieldMappings(Collection<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.
    
    Parameters:
    
    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.
  - withFieldMappings
```
public OneDriveConfiguration withFieldMappings(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.
    
    NOTE: This method appends the values to the existing list (if any). Use setFieldMappings(java.util.Collection) or withFieldMappings(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withFieldMappings
```
public OneDriveConfiguration withFieldMappings(Collection<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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDisableLocalGroups
```
public void setDisableLocalGroups(Boolean disableLocalGroups)
```
    A Boolean value that specifies whether local groups are disabled (True) or enabled ( False).
    
    Parameters:
    
    disableLocalGroups - A Boolean value that specifies whether local groups are disabled (True) or enabled ( False).
  - getDisableLocalGroups
```
public Boolean getDisableLocalGroups()
```
    A Boolean value that specifies whether local groups are disabled (True) or enabled ( False).
    
    Returns:
    
    A Boolean value that specifies whether local groups are disabled (True) or enabled ( False).
  - withDisableLocalGroups
```
public OneDriveConfiguration withDisableLocalGroups(Boolean disableLocalGroups)
```
    A Boolean value that specifies whether local groups are disabled (True) or enabled ( False).
    
    Parameters:
    
    disableLocalGroups - A Boolean value that specifies whether local groups are disabled (True) or enabled ( False).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isDisableLocalGroups
```
public Boolean isDisableLocalGroups()
```
    A Boolean value that specifies whether local groups are disabled (True) or enabled ( False).
    
    Returns:
    
    A Boolean value that specifies whether local groups are disabled (True) or enabled ( False).
  - 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public OneDriveConfiguration clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class OneDriveConfiguration

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

OneDriveConfiguration

Method Detail

setTenantDomain

getTenantDomain

withTenantDomain

setSecretArn

getSecretArn

withSecretArn

setOneDriveUsers

getOneDriveUsers

withOneDriveUsers

getInclusionPatterns

setInclusionPatterns

withInclusionPatterns

withInclusionPatterns

getExclusionPatterns

setExclusionPatterns

withExclusionPatterns

withExclusionPatterns

getFieldMappings

setFieldMappings

withFieldMappings

withFieldMappings

setDisableLocalGroups

getDisableLocalGroups

withDisableLocalGroups

isDisableLocalGroups

toString

equals

hashCode

clone

marshall