SharePointConfiguration (AWS SDK for Java

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

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class SharePointConfiguration
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Provides the configuration information to connect to Microsoft SharePoint as your data source.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

SharePointConfiguration()

Constructors
Constructor and Description
`SharePointConfiguration()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`SharePointConfiguration`	`clone()`
`boolean`	`equals(Object obj)`
`Boolean`	`getCrawlAttachments()` `TRUE` to include attachments to documents stored in your Microsoft SharePoint site in the index; otherwise, `FALSE`.
`Boolean`	`getDisableLocalGroups()` A Boolean value that specifies whether local groups are disabled (`True`) or enabled ( `False`).
`String`	`getDocumentTitleFieldName()` The Microsoft SharePoint attribute field that contains the title of the document.
`List<String>`	`getExclusionPatterns()` A list of regular expression patterns to exclude certain documents in your SharePoint.
`List<DataSourceToIndexFieldMapping>`	`getFieldMappings()` A list of `DataSourceToIndexFieldMapping` objects that map SharePoint data source attributes or field names to Amazon Kendra index field names.
`List<String>`	`getInclusionPatterns()` A list of regular expression patterns to include certain documents in your SharePoint.
`String`	`getSecretArn()` The Amazon Resource Name (ARN) of credentials stored in Secrets Manager.
`String`	`getSharePointVersion()` The version of Microsoft SharePoint that you are using as a data source.
`S3Path`	`getSslCertificateS3Path()`
`List<String>`	`getUrls()` The URLs of the Microsoft SharePoint site that contains the documents that should be indexed.
`Boolean`	`getUseChangeLog()` `TRUE` to use the SharePoint change log to determine which documents require updating in the index.
`DataSourceVpcConfiguration`	`getVpcConfiguration()`
`int`	`hashCode()`
`Boolean`	`isCrawlAttachments()` `TRUE` to include attachments to documents stored in your Microsoft SharePoint site in the index; otherwise, `FALSE`.
`Boolean`	`isDisableLocalGroups()` A Boolean value that specifies whether local groups are disabled (`True`) or enabled ( `False`).
`Boolean`	`isUseChangeLog()` `TRUE` to use the SharePoint change log to determine which documents require updating in the index.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setCrawlAttachments(Boolean crawlAttachments)` `TRUE` to include attachments to documents stored in your Microsoft SharePoint site in the index; otherwise, `FALSE`.
`void`	`setDisableLocalGroups(Boolean disableLocalGroups)` A Boolean value that specifies whether local groups are disabled (`True`) or enabled ( `False`).
`void`	`setDocumentTitleFieldName(String documentTitleFieldName)` The Microsoft SharePoint attribute field that contains the title of the document.
`void`	`setExclusionPatterns(Collection<String> exclusionPatterns)` A list of regular expression patterns to exclude certain documents in your SharePoint.
`void`	`setFieldMappings(Collection<DataSourceToIndexFieldMapping> fieldMappings)` A list of `DataSourceToIndexFieldMapping` objects that map SharePoint data source attributes or field names to Amazon Kendra index field names.
`void`	`setInclusionPatterns(Collection<String> inclusionPatterns)` A list of regular expression patterns to include certain documents in your SharePoint.
`void`	`setSecretArn(String secretArn)` The Amazon Resource Name (ARN) of credentials stored in Secrets Manager.
`void`	`setSharePointVersion(String sharePointVersion)` The version of Microsoft SharePoint that you are using as a data source.
`void`	`setSslCertificateS3Path(S3Path sslCertificateS3Path)`
`void`	`setUrls(Collection<String> urls)` The URLs of the Microsoft SharePoint site that contains the documents that should be indexed.
`void`	`setUseChangeLog(Boolean useChangeLog)` `TRUE` to use the SharePoint change log to determine which documents require updating in the index.
`void`	`setVpcConfiguration(DataSourceVpcConfiguration vpcConfiguration)`
`String`	`toString()` Returns a string representation of this object.
`SharePointConfiguration`	`withCrawlAttachments(Boolean crawlAttachments)` `TRUE` to include attachments to documents stored in your Microsoft SharePoint site in the index; otherwise, `FALSE`.
`SharePointConfiguration`	`withDisableLocalGroups(Boolean disableLocalGroups)` A Boolean value that specifies whether local groups are disabled (`True`) or enabled ( `False`).
`SharePointConfiguration`	`withDocumentTitleFieldName(String documentTitleFieldName)` The Microsoft SharePoint attribute field that contains the title of the document.
`SharePointConfiguration`	`withExclusionPatterns(Collection<String> exclusionPatterns)` A list of regular expression patterns to exclude certain documents in your SharePoint.
`SharePointConfiguration`	`withExclusionPatterns(String... exclusionPatterns)` A list of regular expression patterns to exclude certain documents in your SharePoint.
`SharePointConfiguration`	`withFieldMappings(Collection<DataSourceToIndexFieldMapping> fieldMappings)` A list of `DataSourceToIndexFieldMapping` objects that map SharePoint data source attributes or field names to Amazon Kendra index field names.
`SharePointConfiguration`	`withFieldMappings(DataSourceToIndexFieldMapping... fieldMappings)` A list of `DataSourceToIndexFieldMapping` objects that map SharePoint data source attributes or field names to Amazon Kendra index field names.
`SharePointConfiguration`	`withInclusionPatterns(Collection<String> inclusionPatterns)` A list of regular expression patterns to include certain documents in your SharePoint.
`SharePointConfiguration`	`withInclusionPatterns(String... inclusionPatterns)` A list of regular expression patterns to include certain documents in your SharePoint.
`SharePointConfiguration`	`withSecretArn(String secretArn)` The Amazon Resource Name (ARN) of credentials stored in Secrets Manager.
`SharePointConfiguration`	`withSharePointVersion(SharePointVersion sharePointVersion)` The version of Microsoft SharePoint that you are using as a data source.
`SharePointConfiguration`	`withSharePointVersion(String sharePointVersion)` The version of Microsoft SharePoint that you are using as a data source.
`SharePointConfiguration`	`withSslCertificateS3Path(S3Path sslCertificateS3Path)`
`SharePointConfiguration`	`withUrls(Collection<String> urls)` The URLs of the Microsoft SharePoint site that contains the documents that should be indexed.
`SharePointConfiguration`	`withUrls(String... urls)` The URLs of the Microsoft SharePoint site that contains the documents that should be indexed.
`SharePointConfiguration`	`withUseChangeLog(Boolean useChangeLog)` `TRUE` to use the SharePoint change log to determine which documents require updating in the index.
`SharePointConfiguration`	`withVpcConfiguration(DataSourceVpcConfiguration vpcConfiguration)`

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

- Constructor Detail
  - SharePointConfiguration
```
public SharePointConfiguration()
```
- Method Detail
  - setSharePointVersion
```
public void setSharePointVersion(String sharePointVersion)
```
    The version of Microsoft SharePoint that you are using as a data source.
    
    Parameters:
    
    sharePointVersion - The version of Microsoft SharePoint that you are using as a data source.
    
    See Also:
    
    SharePointVersion
  - getSharePointVersion
```
public String getSharePointVersion()
```
    The version of Microsoft SharePoint that you are using as a data source.
    
    Returns:
    
    The version of Microsoft SharePoint that you are using as a data source.
    
    See Also:
    
    SharePointVersion
  - withSharePointVersion
```
public SharePointConfiguration withSharePointVersion(String sharePointVersion)
```
    The version of Microsoft SharePoint that you are using as a data source.
    
    Parameters:
    
    sharePointVersion - The version of Microsoft SharePoint that you are using as a data source.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    SharePointVersion
  - withSharePointVersion
```
public SharePointConfiguration withSharePointVersion(SharePointVersion sharePointVersion)
```
    The version of Microsoft SharePoint that you are using as a data source.
    
    Parameters:
    
    sharePointVersion - The version of Microsoft SharePoint that you are using as a data source.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    SharePointVersion
  - getUrls
```
public List<String> getUrls()
```
    The URLs of the Microsoft SharePoint site that contains the documents that should be indexed.
    
    Returns:
    
    The URLs of the Microsoft SharePoint site that contains the documents that should be indexed.
  - setUrls
```
public void setUrls(Collection<String> urls)
```
    The URLs of the Microsoft SharePoint site that contains the documents that should be indexed.
    
    Parameters:
    
    urls - The URLs of the Microsoft SharePoint site that contains the documents that should be indexed.
  - withUrls
```
public SharePointConfiguration withUrls(String... urls)
```
    The URLs of the Microsoft SharePoint site that contains the documents that should be indexed.
    
    NOTE: This method appends the values to the existing list (if any). Use setUrls(java.util.Collection) or withUrls(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    urls - The URLs of the Microsoft SharePoint site that contains the documents that should be indexed.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withUrls
```
public SharePointConfiguration withUrls(Collection<String> urls)
```
    The URLs of the Microsoft SharePoint site that contains the documents that should be indexed.
    
    Parameters:
    
    urls - The URLs of the Microsoft SharePoint site that contains the documents that should be indexed.
    
    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 credentials stored in Secrets Manager. The credentials should be a user/password pair. If you use SharePoint Server, you also need to provide the sever domain name as part of the credentials. For more information, see Using a Microsoft SharePoint Data Source. For more information about Secrets Manager see What Is Secrets Manager in the Secrets Manager user guide.
    
    Parameters:
    
    secretArn - The Amazon Resource Name (ARN) of credentials stored in Secrets Manager. The credentials should be a user/password pair. If you use SharePoint Server, you also need to provide the sever domain name as part of the credentials. For more information, see Using a Microsoft SharePoint Data Source. For more information about Secrets Manager see What Is Secrets Manager in the Secrets Manager user guide.
  - getSecretArn
```
public String getSecretArn()
```
    The Amazon Resource Name (ARN) of credentials stored in Secrets Manager. The credentials should be a user/password pair. If you use SharePoint Server, you also need to provide the sever domain name as part of the credentials. For more information, see Using a Microsoft SharePoint Data Source. For more information about Secrets Manager see What Is Secrets Manager in the Secrets Manager user guide.
    
    Returns:
    
    The Amazon Resource Name (ARN) of credentials stored in Secrets Manager. The credentials should be a user/password pair. If you use SharePoint Server, you also need to provide the sever domain name as part of the credentials. For more information, see Using a Microsoft SharePoint Data Source. For more information about Secrets Manager see What Is Secrets Manager in the Secrets Manager user guide.
  - withSecretArn
```
public SharePointConfiguration withSecretArn(String secretArn)
```
    The Amazon Resource Name (ARN) of credentials stored in Secrets Manager. The credentials should be a user/password pair. If you use SharePoint Server, you also need to provide the sever domain name as part of the credentials. For more information, see Using a Microsoft SharePoint Data Source. For more information about Secrets Manager see What Is Secrets Manager in the Secrets Manager user guide.
    
    Parameters:
    
    secretArn - The Amazon Resource Name (ARN) of credentials stored in Secrets Manager. The credentials should be a user/password pair. If you use SharePoint Server, you also need to provide the sever domain name as part of the credentials. For more information, see Using a Microsoft SharePoint Data Source. For more information about Secrets Manager see What Is Secrets Manager in the Secrets Manager user guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCrawlAttachments
```
public void setCrawlAttachments(Boolean crawlAttachments)
```
    TRUE to include attachments to documents stored in your Microsoft SharePoint site in the index; otherwise, FALSE.
    
    Parameters:
    
    crawlAttachments - TRUE to include attachments to documents stored in your Microsoft SharePoint site in the index; otherwise, FALSE.
  - getCrawlAttachments
```
public Boolean getCrawlAttachments()
```
    TRUE to include attachments to documents stored in your Microsoft SharePoint site in the index; otherwise, FALSE.
    
    Returns:
    
    TRUE to include attachments to documents stored in your Microsoft SharePoint site in the index; otherwise, FALSE.
  - withCrawlAttachments
```
public SharePointConfiguration withCrawlAttachments(Boolean crawlAttachments)
```
    TRUE to include attachments to documents stored in your Microsoft SharePoint site in the index; otherwise, FALSE.
    
    Parameters:
    
    crawlAttachments - TRUE to include attachments to documents stored in your Microsoft SharePoint site in the index; otherwise, FALSE.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isCrawlAttachments
```
public Boolean isCrawlAttachments()
```
    TRUE to include attachments to documents stored in your Microsoft SharePoint site in the index; otherwise, FALSE.
    
    Returns:
    
    TRUE to include attachments to documents stored in your Microsoft SharePoint site in the index; otherwise, FALSE.
  - setUseChangeLog
```
public void setUseChangeLog(Boolean useChangeLog)
```
    TRUE to use the SharePoint change log to determine which documents require updating in the index. Depending on the change log's size, it may take longer for Amazon Kendra to use the change log than to scan all of your documents in SharePoint.
    
    Parameters:
    
    useChangeLog - TRUE to use the SharePoint change log to determine which documents require updating in the index. Depending on the change log's size, it may take longer for Amazon Kendra to use the change log than to scan all of your documents in SharePoint.
  - getUseChangeLog
```
public Boolean getUseChangeLog()
```
    TRUE to use the SharePoint change log to determine which documents require updating in the index. Depending on the change log's size, it may take longer for Amazon Kendra to use the change log than to scan all of your documents in SharePoint.
    
    Returns:
    
    TRUE to use the SharePoint change log to determine which documents require updating in the index. Depending on the change log's size, it may take longer for Amazon Kendra to use the change log than to scan all of your documents in SharePoint.
  - withUseChangeLog
```
public SharePointConfiguration withUseChangeLog(Boolean useChangeLog)
```
    TRUE to use the SharePoint change log to determine which documents require updating in the index. Depending on the change log's size, it may take longer for Amazon Kendra to use the change log than to scan all of your documents in SharePoint.
    
    Parameters:
    
    useChangeLog - TRUE to use the SharePoint change log to determine which documents require updating in the index. Depending on the change log's size, it may take longer for Amazon Kendra to use the change log than to scan all of your documents in SharePoint.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isUseChangeLog
```
public Boolean isUseChangeLog()
```
    TRUE to use the SharePoint change log to determine which documents require updating in the index. Depending on the change log's size, it may take longer for Amazon Kendra to use the change log than to scan all of your documents in SharePoint.
    
    Returns:
    
    TRUE to use the SharePoint change log to determine which documents require updating in the index. Depending on the change log's size, it may take longer for Amazon Kendra to use the change log than to scan all of your documents in SharePoint.
  - getInclusionPatterns
```
public List<String> getInclusionPatterns()
```
    A list of regular expression patterns to include certain documents in your SharePoint. 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 regex is applied to the display URL of the SharePoint document.
    
    Returns:
    
    A list of regular expression patterns to include certain documents in your SharePoint. 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 regex is applied to the display URL of the SharePoint document.
  - setInclusionPatterns
```
public void setInclusionPatterns(Collection<String> inclusionPatterns)
```
    A list of regular expression patterns to include certain documents in your SharePoint. 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 regex is applied to the display URL of the SharePoint document.
    
    Parameters:
    
    inclusionPatterns - A list of regular expression patterns to include certain documents in your SharePoint. 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 regex is applied to the display URL of the SharePoint document.
  - withInclusionPatterns
```
public SharePointConfiguration withInclusionPatterns(String... inclusionPatterns)
```
    A list of regular expression patterns to include certain documents in your SharePoint. 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 regex is applied to the display URL of the SharePoint document.
    
    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 to include certain documents in your SharePoint. 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 regex is applied to the display URL of the SharePoint document.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withInclusionPatterns
```
public SharePointConfiguration withInclusionPatterns(Collection<String> inclusionPatterns)
```
    A list of regular expression patterns to include certain documents in your SharePoint. 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 regex is applied to the display URL of the SharePoint document.
    
    Parameters:
    
    inclusionPatterns - A list of regular expression patterns to include certain documents in your SharePoint. 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 regex is applied to the display URL of the SharePoint document.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getExclusionPatterns
```
public List<String> getExclusionPatterns()
```
    A list of regular expression patterns to exclude certain documents in your SharePoint. 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 regex is applied to the display URL of the SharePoint document.
    
    Returns:
    
    A list of regular expression patterns to exclude certain documents in your SharePoint. 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 regex is applied to the display URL of the SharePoint document.
  - setExclusionPatterns
```
public void setExclusionPatterns(Collection<String> exclusionPatterns)
```
    A list of regular expression patterns to exclude certain documents in your SharePoint. 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 regex is applied to the display URL of the SharePoint document.
    
    Parameters:
    
    exclusionPatterns - A list of regular expression patterns to exclude certain documents in your SharePoint. 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 regex is applied to the display URL of the SharePoint document.
  - withExclusionPatterns
```
public SharePointConfiguration withExclusionPatterns(String... exclusionPatterns)
```
    A list of regular expression patterns to exclude certain documents in your SharePoint. 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 regex is applied to the display URL of the SharePoint document.
    
    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 - A list of regular expression patterns to exclude certain documents in your SharePoint. 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 regex is applied to the display URL of the SharePoint document.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withExclusionPatterns
```
public SharePointConfiguration withExclusionPatterns(Collection<String> exclusionPatterns)
```
    A list of regular expression patterns to exclude certain documents in your SharePoint. 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 regex is applied to the display URL of the SharePoint document.
    
    Parameters:
    
    exclusionPatterns - A list of regular expression patterns to exclude certain documents in your SharePoint. 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 regex is applied to the display URL of the SharePoint document.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setVpcConfiguration
```
public void setVpcConfiguration(DataSourceVpcConfiguration vpcConfiguration)
```
    Parameters:
    
    vpcConfiguration -
  - getVpcConfiguration
```
public DataSourceVpcConfiguration getVpcConfiguration()
```
    Returns:
  - withVpcConfiguration
```
public SharePointConfiguration withVpcConfiguration(DataSourceVpcConfiguration vpcConfiguration)
```
    Parameters:
    
    vpcConfiguration -
    
    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 SharePoint data source attributes or field names to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to SharePoint fields. For more information, see Mapping data source fields. The SharePoint data source field names must exist in your SharePoint custom metadata.
    
    Returns:
    
    A list of DataSourceToIndexFieldMapping objects that map SharePoint data source attributes or field names to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to SharePoint fields. For more information, see Mapping data source fields. The SharePoint data source field names must exist in your SharePoint custom metadata.
  - setFieldMappings
```
public void setFieldMappings(Collection<DataSourceToIndexFieldMapping> fieldMappings)
```
    A list of DataSourceToIndexFieldMapping objects that map SharePoint data source attributes or field names to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to SharePoint fields. For more information, see Mapping data source fields. The SharePoint data source field names must exist in your SharePoint custom metadata.
    
    Parameters:
    
    fieldMappings - A list of DataSourceToIndexFieldMapping objects that map SharePoint data source attributes or field names to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to SharePoint fields. For more information, see Mapping data source fields. The SharePoint data source field names must exist in your SharePoint custom metadata.
  - withFieldMappings
```
public SharePointConfiguration withFieldMappings(DataSourceToIndexFieldMapping... fieldMappings)
```
    A list of DataSourceToIndexFieldMapping objects that map SharePoint data source attributes or field names to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to SharePoint fields. For more information, see Mapping data source fields. The SharePoint data source field names must exist in your SharePoint custom metadata.
    
    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 SharePoint data source attributes or field names to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to SharePoint fields. For more information, see Mapping data source fields. The SharePoint data source field names must exist in your SharePoint custom metadata.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withFieldMappings
```
public SharePointConfiguration withFieldMappings(Collection<DataSourceToIndexFieldMapping> fieldMappings)
```
    A list of DataSourceToIndexFieldMapping objects that map SharePoint data source attributes or field names to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to SharePoint fields. For more information, see Mapping data source fields. The SharePoint data source field names must exist in your SharePoint custom metadata.
    
    Parameters:
    
    fieldMappings - A list of DataSourceToIndexFieldMapping objects that map SharePoint data source attributes or field names to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to SharePoint fields. For more information, see Mapping data source fields. The SharePoint data source field names must exist in your SharePoint custom metadata.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDocumentTitleFieldName
```
public void setDocumentTitleFieldName(String documentTitleFieldName)
```
    The Microsoft SharePoint attribute field that contains the title of the document.
    
    Parameters:
    
    documentTitleFieldName - The Microsoft SharePoint attribute field that contains the title of the document.
  - getDocumentTitleFieldName
```
public String getDocumentTitleFieldName()
```
    The Microsoft SharePoint attribute field that contains the title of the document.
    
    Returns:
    
    The Microsoft SharePoint attribute field that contains the title of the document.
  - withDocumentTitleFieldName
```
public SharePointConfiguration withDocumentTitleFieldName(String documentTitleFieldName)
```
    The Microsoft SharePoint attribute field that contains the title of the document.
    
    Parameters:
    
    documentTitleFieldName - The Microsoft SharePoint attribute field that contains the title of the document.
    
    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 SharePointConfiguration 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).
  - setSslCertificateS3Path
```
public void setSslCertificateS3Path(S3Path sslCertificateS3Path)
```
    Parameters:
    
    sslCertificateS3Path -
  - getSslCertificateS3Path
```
public S3Path getSslCertificateS3Path()
```
    Returns:
  - withSslCertificateS3Path
```
public SharePointConfiguration withSslCertificateS3Path(S3Path sslCertificateS3Path)
```
    Parameters:
    
    sslCertificateS3Path -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - 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 SharePointConfiguration 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 SharePointConfiguration

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SharePointConfiguration

Method Detail

setSharePointVersion

getSharePointVersion

withSharePointVersion

withSharePointVersion

getUrls

setUrls

withUrls

withUrls

setSecretArn

getSecretArn

withSecretArn

setCrawlAttachments

getCrawlAttachments

withCrawlAttachments

isCrawlAttachments

setUseChangeLog

getUseChangeLog

withUseChangeLog

isUseChangeLog

getInclusionPatterns

setInclusionPatterns

withInclusionPatterns

withInclusionPatterns

getExclusionPatterns

setExclusionPatterns

withExclusionPatterns

withExclusionPatterns

setVpcConfiguration

getVpcConfiguration

withVpcConfiguration

getFieldMappings

setFieldMappings

withFieldMappings

withFieldMappings

setDocumentTitleFieldName

getDocumentTitleFieldName

withDocumentTitleFieldName

setDisableLocalGroups

getDisableLocalGroups

withDisableLocalGroups

isDisableLocalGroups

setSslCertificateS3Path

getSslCertificateS3Path

withSslCertificateS3Path

toString

equals

hashCode

clone

marshall