@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.
Constructor and Description |
---|
SharePointConfiguration() |
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<String> |
getExclusionPatterns()
A list of regular expression patterns.
|
List<DataSourceToIndexFieldMapping> |
getFieldMappings()
A list of
DataSourceToIndexFieldMapping objects that map Microsoft SharePoint attributes to custom
fields in the Amazon Kendra index. |
List<String> |
getInclusionPatterns()
A list of regular expression patterns.
|
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.
|
Boolean |
getUseChangeLog()
Set to
TRUE to use the Microsoft SharePoint change log to determine the documents that need to be
updated 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 |
isUseChangeLog()
Set to
TRUE to use the Microsoft SharePoint change log to determine the documents that need to be
updated 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 |
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.
|
void |
setFieldMappings(Collection<DataSourceToIndexFieldMapping> fieldMappings)
A list of
DataSourceToIndexFieldMapping objects that map Microsoft SharePoint attributes to custom
fields in the Amazon Kendra index. |
void |
setInclusionPatterns(Collection<String> inclusionPatterns)
A list of regular expression patterns.
|
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 |
setUseChangeLog(Boolean useChangeLog)
Set to
TRUE to use the Microsoft SharePoint change log to determine the documents that need to be
updated 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 |
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.
|
SharePointConfiguration |
withExclusionPatterns(String... exclusionPatterns)
A list of regular expression patterns.
|
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 |
withInclusionPatterns(Collection<String> inclusionPatterns)
A list of regular expression patterns.
|
SharePointConfiguration |
withInclusionPatterns(String... inclusionPatterns)
A list of regular expression patterns.
|
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 |
withUseChangeLog(Boolean useChangeLog)
Set to
TRUE to use the Microsoft SharePoint change log to determine the documents that need to be
updated in the index. |
SharePointConfiguration |
withVpcConfiguration(DataSourceVpcConfiguration vpcConfiguration) |
public void setSharePointVersion(String sharePointVersion)
The version of Microsoft SharePoint that you are using as a data source.
sharePointVersion
- The version of Microsoft SharePoint that you are using as a data source.SharePointVersion
public String getSharePointVersion()
The version of Microsoft SharePoint that you are using as a data source.
SharePointVersion
public SharePointConfiguration withSharePointVersion(String sharePointVersion)
The version of Microsoft SharePoint that you are using as a data source.
sharePointVersion
- The version of Microsoft SharePoint that you are using as a data source.SharePointVersion
public SharePointConfiguration withSharePointVersion(SharePointVersion sharePointVersion)
The version of Microsoft SharePoint that you are using as a data source.
sharePointVersion
- The version of Microsoft SharePoint that you are using as a data source.SharePointVersion
public List<String> getUrls()
The URLs of the Microsoft SharePoint site that contains the documents that should be indexed.
public void setUrls(Collection<String> urls)
The URLs of the Microsoft SharePoint site that contains the documents that should be indexed.
urls
- The URLs of the Microsoft SharePoint site that contains the documents that should be indexed.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.
urls
- The URLs of the Microsoft SharePoint site that contains the documents that should be indexed.public SharePointConfiguration withUrls(Collection<String> urls)
The URLs of the Microsoft SharePoint site that contains the documents that should be indexed.
urls
- The URLs of the Microsoft SharePoint site that contains the documents that should be indexed.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.
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.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.
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.
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.public void setCrawlAttachments(Boolean crawlAttachments)
TRUE
to include attachments to documents stored in your Microsoft SharePoint site in the index;
otherwise, FALSE
.
crawlAttachments
- TRUE
to include attachments to documents stored in your Microsoft SharePoint site in the
index; otherwise, FALSE
.public Boolean getCrawlAttachments()
TRUE
to include attachments to documents stored in your Microsoft SharePoint site in the index;
otherwise, FALSE
.
TRUE
to include attachments to documents stored in your Microsoft SharePoint site in the
index; otherwise, FALSE
.public SharePointConfiguration withCrawlAttachments(Boolean crawlAttachments)
TRUE
to include attachments to documents stored in your Microsoft SharePoint site in the index;
otherwise, FALSE
.
crawlAttachments
- TRUE
to include attachments to documents stored in your Microsoft SharePoint site in the
index; otherwise, FALSE
.public Boolean isCrawlAttachments()
TRUE
to include attachments to documents stored in your Microsoft SharePoint site in the index;
otherwise, FALSE
.
TRUE
to include attachments to documents stored in your Microsoft SharePoint site in the
index; otherwise, FALSE
.public void setUseChangeLog(Boolean useChangeLog)
Set to TRUE
to use the Microsoft SharePoint change log to determine the documents that need to be
updated in the index. Depending on the size of the SharePoint change log, it may take longer for Amazon Kendra to
use the change log than it takes it to determine the changed documents using the Amazon Kendra document crawler.
useChangeLog
- Set to TRUE
to use the Microsoft SharePoint change log to determine the documents that need
to be updated in the index. Depending on the size of the SharePoint change log, it may take longer for
Amazon Kendra to use the change log than it takes it to determine the changed documents using the Amazon
Kendra document crawler.public Boolean getUseChangeLog()
Set to TRUE
to use the Microsoft SharePoint change log to determine the documents that need to be
updated in the index. Depending on the size of the SharePoint change log, it may take longer for Amazon Kendra to
use the change log than it takes it to determine the changed documents using the Amazon Kendra document crawler.
TRUE
to use the Microsoft SharePoint change log to determine the documents that need
to be updated in the index. Depending on the size of the SharePoint change log, it may take longer for
Amazon Kendra to use the change log than it takes it to determine the changed documents using the Amazon
Kendra document crawler.public SharePointConfiguration withUseChangeLog(Boolean useChangeLog)
Set to TRUE
to use the Microsoft SharePoint change log to determine the documents that need to be
updated in the index. Depending on the size of the SharePoint change log, it may take longer for Amazon Kendra to
use the change log than it takes it to determine the changed documents using the Amazon Kendra document crawler.
useChangeLog
- Set to TRUE
to use the Microsoft SharePoint change log to determine the documents that need
to be updated in the index. Depending on the size of the SharePoint change log, it may take longer for
Amazon Kendra to use the change log than it takes it to determine the changed documents using the Amazon
Kendra document crawler.public Boolean isUseChangeLog()
Set to TRUE
to use the Microsoft SharePoint change log to determine the documents that need to be
updated in the index. Depending on the size of the SharePoint change log, it may take longer for Amazon Kendra to
use the change log than it takes it to determine the changed documents using the Amazon Kendra document crawler.
TRUE
to use the Microsoft SharePoint change log to determine the documents that need
to be updated in the index. Depending on the size of the SharePoint change log, it may take longer for
Amazon Kendra to use the change log than it takes it to determine the changed documents using the Amazon
Kendra document crawler.public List<String> getInclusionPatterns()
A list of regular expression patterns. 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 pattern and an exclusion pattern, the document is not included in the index.
The regex is applied to the display URL of the SharePoint document.
The regex is applied to the display URL of the SharePoint document.
public void setInclusionPatterns(Collection<String> inclusionPatterns)
A list of regular expression patterns. 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 pattern and an exclusion pattern, the document is not included in the index.
The regex is applied to the display URL of the SharePoint document.
inclusionPatterns
- A list of regular expression patterns. 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 pattern and an exclusion pattern, the document is not included in the index.
The regex is applied to the display URL of the SharePoint document.
public SharePointConfiguration withInclusionPatterns(String... inclusionPatterns)
A list of regular expression patterns. 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 pattern and an exclusion pattern, the document is not 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.
inclusionPatterns
- A list of regular expression patterns. 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 pattern and an exclusion pattern, the document is not included in the index.
The regex is applied to the display URL of the SharePoint document.
public SharePointConfiguration withInclusionPatterns(Collection<String> inclusionPatterns)
A list of regular expression patterns. 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 pattern and an exclusion pattern, the document is not included in the index.
The regex is applied to the display URL of the SharePoint document.
inclusionPatterns
- A list of regular expression patterns. 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 pattern and an exclusion pattern, the document is not included in the index.
The regex is applied to the display URL of the SharePoint document.
public List<String> getExclusionPatterns()
A list of regular expression patterns. 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 exclusion pattern and an inclusion pattern, the document is not included in the index.
The regex is applied to the display URL of the SharePoint document.
The regex is applied to the display URL of the SharePoint document.
public void setExclusionPatterns(Collection<String> exclusionPatterns)
A list of regular expression patterns. 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 exclusion pattern and an inclusion pattern, the document is not included in the index.
The regex is applied to the display URL of the SharePoint document.
exclusionPatterns
- A list of regular expression patterns. 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 exclusion
pattern and an inclusion pattern, the document is not included in the index.
The regex is applied to the display URL of the SharePoint document.
public SharePointConfiguration withExclusionPatterns(String... exclusionPatterns)
A list of regular expression patterns. 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 exclusion pattern and an inclusion pattern, the document is not 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.
exclusionPatterns
- A list of regular expression patterns. 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 exclusion
pattern and an inclusion pattern, the document is not included in the index.
The regex is applied to the display URL of the SharePoint document.
public SharePointConfiguration withExclusionPatterns(Collection<String> exclusionPatterns)
A list of regular expression patterns. 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 exclusion pattern and an inclusion pattern, the document is not included in the index.
The regex is applied to the display URL of the SharePoint document.
exclusionPatterns
- A list of regular expression patterns. 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 exclusion
pattern and an inclusion pattern, the document is not included in the index.
The regex is applied to the display URL of the SharePoint document.
public void setVpcConfiguration(DataSourceVpcConfiguration vpcConfiguration)
vpcConfiguration
- public DataSourceVpcConfiguration getVpcConfiguration()
public SharePointConfiguration withVpcConfiguration(DataSourceVpcConfiguration vpcConfiguration)
vpcConfiguration
- 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.
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.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.
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.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.
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.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.
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.public void setDocumentTitleFieldName(String documentTitleFieldName)
The Microsoft SharePoint attribute field that contains the title of the document.
documentTitleFieldName
- The Microsoft SharePoint attribute field that contains the title of the document.public String getDocumentTitleFieldName()
The Microsoft SharePoint attribute field that contains the title of the document.
public SharePointConfiguration withDocumentTitleFieldName(String documentTitleFieldName)
The Microsoft SharePoint attribute field that contains the title of the document.
documentTitleFieldName
- The Microsoft SharePoint attribute field that contains the title of the document.public String toString()
toString
in class Object
Object.toString()
public SharePointConfiguration clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.