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 configuration information for connecting to a Microsoft SharePoint 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`.
`String`	`getDocumentTitleFieldName()` The Microsoft SharePoint attribute field that contains the title of the document.
`List<DataSourceToIndexFieldMapping>`	`getFieldMappings()` A list of `DataSourceToIndexFieldMapping` objects that map Microsoft SharePoint attributes to custom fields in the Amazon Kendra index.
`String`	`getSecretArn()` The Amazon Resource Name (ARN) of credentials stored in AWS Secrets Manager.
`String`	`getSharePointVersion()` The version of Microsoft SharePoint that you are using as a data source.
`List<String>`	`getUrls()` The URLs of the Microsoft SharePoint site that contains the documents that should be indexed.
`DataSourceVpcConfiguration`	`getVpcConfiguration()`
`int`	`hashCode()`
`Boolean`	`isCrawlAttachments()` `TRUE` to include attachments to documents stored in your Microsoft SharePoint site in the index; otherwise, `FALSE`.
`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`	`setDocumentTitleFieldName(String documentTitleFieldName)` The Microsoft SharePoint attribute field that contains the title of the document.
`void`	`setFieldMappings(Collection<DataSourceToIndexFieldMapping> fieldMappings)` A list of `DataSourceToIndexFieldMapping` objects that map Microsoft SharePoint attributes to custom fields in the Amazon Kendra index.
`void`	`setSecretArn(String secretArn)` The Amazon Resource Name (ARN) of credentials stored in AWS Secrets Manager.
`void`	`setSharePointVersion(String sharePointVersion)` The version of Microsoft SharePoint that you are using as a data source.
`void`	`setUrls(Collection<String> urls)` The URLs of the Microsoft SharePoint site that contains the documents that should be indexed.
`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`	`withDocumentTitleFieldName(String documentTitleFieldName)` The Microsoft SharePoint attribute field that contains the title of the document.
`SharePointConfiguration`	`withFieldMappings(Collection<DataSourceToIndexFieldMapping> fieldMappings)` A list of `DataSourceToIndexFieldMapping` objects that map Microsoft SharePoint attributes to custom fields in the Amazon Kendra index.
`SharePointConfiguration`	`withFieldMappings(DataSourceToIndexFieldMapping... fieldMappings)` A list of `DataSourceToIndexFieldMapping` objects that map Microsoft SharePoint attributes to custom fields in the Amazon Kendra index.
`SharePointConfiguration`	`withSecretArn(String secretArn)` The Amazon Resource Name (ARN) of credentials stored in AWS 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`	`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`	`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 AWS Secrets Manager. The credentials should be a user/password pair. For more information, see Using a Microsoft SharePoint Data Source. For more information about AWS Secrets Manager, see What Is AWS Secrets Manager in the AWS Secrets Manager user guide.
    
    Parameters:
    
    secretArn - The Amazon Resource Name (ARN) of credentials stored in AWS Secrets Manager. The credentials should be a user/password pair. For more information, see Using a Microsoft SharePoint Data Source. For more information about AWS Secrets Manager, see What Is AWS Secrets Manager in the AWS Secrets Manager user guide.
  - getSecretArn
```
public String getSecretArn()
```
    The Amazon Resource Name (ARN) of credentials stored in AWS Secrets Manager. The credentials should be a user/password pair. For more information, see Using a Microsoft SharePoint Data Source. For more information about AWS Secrets Manager, see What Is AWS Secrets Manager in the AWS Secrets Manager user guide.
    
    Returns:
    
    The Amazon Resource Name (ARN) of credentials stored in AWS Secrets Manager. The credentials should be a user/password pair. For more information, see Using a Microsoft SharePoint Data Source. For more information about AWS Secrets Manager, see What Is AWS Secrets Manager in the AWS Secrets Manager user guide.
  - withSecretArn
```
public SharePointConfiguration withSecretArn(String secretArn)
```
    The Amazon Resource Name (ARN) of credentials stored in AWS Secrets Manager. The credentials should be a user/password pair. For more information, see Using a Microsoft SharePoint Data Source. For more information about AWS Secrets Manager, see What Is AWS Secrets Manager in the AWS Secrets Manager user guide.
    
    Parameters:
    
    secretArn - The Amazon Resource Name (ARN) of credentials stored in AWS Secrets Manager. The credentials should be a user/password pair. For more information, see Using a Microsoft SharePoint Data Source. For more information about AWS Secrets Manager, see What Is AWS Secrets Manager in the AWS 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.
  - 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 Microsoft SharePoint attributes to custom fields in the Amazon Kendra index. You must first create the index fields using the operation before you map SharePoint attributes. For more information, see Mapping Data Source Fields.
    
    Returns:
    
    A list of DataSourceToIndexFieldMapping objects that map Microsoft SharePoint attributes to custom fields in the Amazon Kendra index. You must first create the index fields using the operation before you map SharePoint attributes. For more information, see Mapping Data Source Fields.
  - setFieldMappings
```
public void setFieldMappings(Collection<DataSourceToIndexFieldMapping> fieldMappings)
```
    A list of DataSourceToIndexFieldMapping objects that map Microsoft SharePoint attributes to custom fields in the Amazon Kendra index. You must first create the index fields using the operation before you map SharePoint attributes. For more information, see Mapping Data Source Fields.
    
    Parameters:
    
    fieldMappings - A list of DataSourceToIndexFieldMapping objects that map Microsoft SharePoint attributes to custom fields in the Amazon Kendra index. You must first create the index fields using the operation before you map SharePoint attributes. For more information, see Mapping Data Source Fields.
  - withFieldMappings
```
public SharePointConfiguration withFieldMappings(DataSourceToIndexFieldMapping... fieldMappings)
```
    A list of DataSourceToIndexFieldMapping objects that map Microsoft SharePoint attributes to custom fields in the Amazon Kendra index. You must first create the index fields using the operation before you map SharePoint attributes. For more information, see Mapping Data Source 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 SharePoint attributes to custom fields in the Amazon Kendra index. You must first create the index fields using the operation before you map SharePoint attributes. For more information, see Mapping Data Source Fields.
    
    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 Microsoft SharePoint attributes to custom fields in the Amazon Kendra index. You must first create the index fields using the operation before you map SharePoint attributes. For more information, see Mapping Data Source Fields.
    
    Parameters:
    
    fieldMappings - A list of DataSourceToIndexFieldMapping objects that map Microsoft SharePoint attributes to custom fields in the Amazon Kendra index. You must first create the index fields using the operation before you map SharePoint attributes. For more information, see Mapping Data Source Fields.
    
    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.
  - 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

setVpcConfiguration

getVpcConfiguration

withVpcConfiguration

getFieldMappings

setFieldMappings

withFieldMappings

withFieldMappings

setDocumentTitleFieldName

getDocumentTitleFieldName

withDocumentTitleFieldName

toString

equals

hashCode

clone

marshall