WorkDocsConfiguration (AWS SDK for Java

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

All Implemented Interfaces:

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

Amazon WorkDocs connector is available in Oregon, North Virginia, Sydney, Singapore and Ireland regions.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

WorkDocsConfiguration()

Constructors
Constructor and Description
`WorkDocsConfiguration()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`WorkDocsConfiguration`	`clone()`
`boolean`	`equals(Object obj)`
`Boolean`	`getCrawlComments()` `TRUE` to include comments on documents in your index.
`List<String>`	`getExclusionPatterns()` A list of regular expression patterns to exclude certain files in your Amazon WorkDocs site repository.
`List<DataSourceToIndexFieldMapping>`	`getFieldMappings()` A list of `DataSourceToIndexFieldMapping` objects that map Amazon WorkDocs field names to custom index field names in Amazon Kendra.
`List<String>`	`getInclusionPatterns()` A list of regular expression patterns to include certain files in your Amazon WorkDocs site repository.
`String`	`getOrganizationId()` The identifier of the directory corresponding to your Amazon WorkDocs site repository.
`Boolean`	`getUseChangeLog()` `TRUE` to use the change logs to update documents in your index instead of scanning all documents.
`int`	`hashCode()`
`Boolean`	`isCrawlComments()` `TRUE` to include comments on documents in your index.
`Boolean`	`isUseChangeLog()` `TRUE` to use the change logs to update documents in your index instead of scanning all documents.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setCrawlComments(Boolean crawlComments)` `TRUE` to include comments on documents in your index.
`void`	`setExclusionPatterns(Collection<String> exclusionPatterns)` A list of regular expression patterns to exclude certain files in your Amazon WorkDocs site repository.
`void`	`setFieldMappings(Collection<DataSourceToIndexFieldMapping> fieldMappings)` A list of `DataSourceToIndexFieldMapping` objects that map Amazon WorkDocs field names to custom index field names in Amazon Kendra.
`void`	`setInclusionPatterns(Collection<String> inclusionPatterns)` A list of regular expression patterns to include certain files in your Amazon WorkDocs site repository.
`void`	`setOrganizationId(String organizationId)` The identifier of the directory corresponding to your Amazon WorkDocs site repository.
`void`	`setUseChangeLog(Boolean useChangeLog)` `TRUE` to use the change logs to update documents in your index instead of scanning all documents.
`String`	`toString()` Returns a string representation of this object.
`WorkDocsConfiguration`	`withCrawlComments(Boolean crawlComments)` `TRUE` to include comments on documents in your index.
`WorkDocsConfiguration`	`withExclusionPatterns(Collection<String> exclusionPatterns)` A list of regular expression patterns to exclude certain files in your Amazon WorkDocs site repository.
`WorkDocsConfiguration`	`withExclusionPatterns(String... exclusionPatterns)` A list of regular expression patterns to exclude certain files in your Amazon WorkDocs site repository.
`WorkDocsConfiguration`	`withFieldMappings(Collection<DataSourceToIndexFieldMapping> fieldMappings)` A list of `DataSourceToIndexFieldMapping` objects that map Amazon WorkDocs field names to custom index field names in Amazon Kendra.
`WorkDocsConfiguration`	`withFieldMappings(DataSourceToIndexFieldMapping... fieldMappings)` A list of `DataSourceToIndexFieldMapping` objects that map Amazon WorkDocs field names to custom index field names in Amazon Kendra.
`WorkDocsConfiguration`	`withInclusionPatterns(Collection<String> inclusionPatterns)` A list of regular expression patterns to include certain files in your Amazon WorkDocs site repository.
`WorkDocsConfiguration`	`withInclusionPatterns(String... inclusionPatterns)` A list of regular expression patterns to include certain files in your Amazon WorkDocs site repository.
`WorkDocsConfiguration`	`withOrganizationId(String organizationId)` The identifier of the directory corresponding to your Amazon WorkDocs site repository.
`WorkDocsConfiguration`	`withUseChangeLog(Boolean useChangeLog)` `TRUE` to use the change logs to update documents in your index instead of scanning all documents.

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

- Constructor Detail
  - WorkDocsConfiguration
```
public WorkDocsConfiguration()
```
- Method Detail
  - setOrganizationId
```
public void setOrganizationId(String organizationId)
```
    The identifier of the directory corresponding to your Amazon WorkDocs site repository.
    
    You can find the organization ID in the AWS Directory Service by going to Active Directory, then Directories. Your Amazon WorkDocs site directory has an ID, which is the organization ID. You can also set up a new Amazon WorkDocs directory in the AWS Directory Service console and enable a Amazon WorkDocs site for the directory in the Amazon WorkDocs console.
    
    Parameters:
    
    organizationId - The identifier of the directory corresponding to your Amazon WorkDocs site repository.
    
    You can find the organization ID in the AWS Directory Service by going to Active Directory, then Directories. Your Amazon WorkDocs site directory has an ID, which is the organization ID. You can also set up a new Amazon WorkDocs directory in the AWS Directory Service console and enable a Amazon WorkDocs site for the directory in the Amazon WorkDocs console.
  - getOrganizationId
```
public String getOrganizationId()
```
    The identifier of the directory corresponding to your Amazon WorkDocs site repository.
    
    You can find the organization ID in the AWS Directory Service by going to Active Directory, then Directories. Your Amazon WorkDocs site directory has an ID, which is the organization ID. You can also set up a new Amazon WorkDocs directory in the AWS Directory Service console and enable a Amazon WorkDocs site for the directory in the Amazon WorkDocs console.
    
    Returns:
    
    The identifier of the directory corresponding to your Amazon WorkDocs site repository.
    
    You can find the organization ID in the AWS Directory Service by going to Active Directory, then Directories. Your Amazon WorkDocs site directory has an ID, which is the organization ID. You can also set up a new Amazon WorkDocs directory in the AWS Directory Service console and enable a Amazon WorkDocs site for the directory in the Amazon WorkDocs console.
  - withOrganizationId
```
public WorkDocsConfiguration withOrganizationId(String organizationId)
```
    The identifier of the directory corresponding to your Amazon WorkDocs site repository.
    
    You can find the organization ID in the AWS Directory Service by going to Active Directory, then Directories. Your Amazon WorkDocs site directory has an ID, which is the organization ID. You can also set up a new Amazon WorkDocs directory in the AWS Directory Service console and enable a Amazon WorkDocs site for the directory in the Amazon WorkDocs console.
    
    Parameters:
    
    organizationId - The identifier of the directory corresponding to your Amazon WorkDocs site repository.
    
    You can find the organization ID in the AWS Directory Service by going to Active Directory, then Directories. Your Amazon WorkDocs site directory has an ID, which is the organization ID. You can also set up a new Amazon WorkDocs directory in the AWS Directory Service console and enable a Amazon WorkDocs site for the directory in the Amazon WorkDocs console.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCrawlComments
```
public void setCrawlComments(Boolean crawlComments)
```
    TRUE to include comments on documents in your index. Including comments in your index means each comment is a document that can be searched on.
    
    The default is set to FALSE.
    
    Parameters:
    
    crawlComments - TRUE to include comments on documents in your index. Including comments in your index means each comment is a document that can be searched on.
    
    The default is set to FALSE.
  - getCrawlComments
```
public Boolean getCrawlComments()
```
    TRUE to include comments on documents in your index. Including comments in your index means each comment is a document that can be searched on.
    
    The default is set to FALSE.
    
    Returns:
    
    TRUE to include comments on documents in your index. Including comments in your index means each comment is a document that can be searched on.
    
    The default is set to FALSE.
  - withCrawlComments
```
public WorkDocsConfiguration withCrawlComments(Boolean crawlComments)
```
    TRUE to include comments on documents in your index. Including comments in your index means each comment is a document that can be searched on.
    
    The default is set to FALSE.
    
    Parameters:
    
    crawlComments - TRUE to include comments on documents in your index. Including comments in your index means each comment is a document that can be searched on.
    
    The default is set to FALSE.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isCrawlComments
```
public Boolean isCrawlComments()
```
    TRUE to include comments on documents in your index. Including comments in your index means each comment is a document that can be searched on.
    
    The default is set to FALSE.
    
    Returns:
    
    TRUE to include comments on documents in your index. Including comments in your index means each comment is a document that can be searched on.
    
    The default is set to FALSE.
  - setUseChangeLog
```
public void setUseChangeLog(Boolean useChangeLog)
```
    TRUE to use the change logs to update documents in your index instead of scanning all documents.
    
    If you are syncing your Amazon WorkDocs data source with your index for the first time, all documents are scanned. After your first sync, you can use the change logs to update your documents in your index for future syncs.
    
    The default is set to FALSE.
    
    Parameters:
    
    useChangeLog - TRUE to use the change logs to update documents in your index instead of scanning all documents.
    
    If you are syncing your Amazon WorkDocs data source with your index for the first time, all documents are scanned. After your first sync, you can use the change logs to update your documents in your index for future syncs.
    
    The default is set to FALSE.
  - getUseChangeLog
```
public Boolean getUseChangeLog()
```
    TRUE to use the change logs to update documents in your index instead of scanning all documents.
    
    If you are syncing your Amazon WorkDocs data source with your index for the first time, all documents are scanned. After your first sync, you can use the change logs to update your documents in your index for future syncs.
    
    The default is set to FALSE.
    
    Returns:
    
    TRUE to use the change logs to update documents in your index instead of scanning all documents.
    
    If you are syncing your Amazon WorkDocs data source with your index for the first time, all documents are scanned. After your first sync, you can use the change logs to update your documents in your index for future syncs.
    
    The default is set to FALSE.
  - withUseChangeLog
```
public WorkDocsConfiguration withUseChangeLog(Boolean useChangeLog)
```
    TRUE to use the change logs to update documents in your index instead of scanning all documents.
    
    If you are syncing your Amazon WorkDocs data source with your index for the first time, all documents are scanned. After your first sync, you can use the change logs to update your documents in your index for future syncs.
    
    The default is set to FALSE.
    
    Parameters:
    
    useChangeLog - TRUE to use the change logs to update documents in your index instead of scanning all documents.
    
    If you are syncing your Amazon WorkDocs data source with your index for the first time, all documents are scanned. After your first sync, you can use the change logs to update your documents in your index for future syncs.
    
    The default is set to FALSE.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isUseChangeLog
```
public Boolean isUseChangeLog()
```
    TRUE to use the change logs to update documents in your index instead of scanning all documents.
    
    If you are syncing your Amazon WorkDocs data source with your index for the first time, all documents are scanned. After your first sync, you can use the change logs to update your documents in your index for future syncs.
    
    The default is set to FALSE.
    
    Returns:
    
    TRUE to use the change logs to update documents in your index instead of scanning all documents.
    
    If you are syncing your Amazon WorkDocs data source with your index for the first time, all documents are scanned. After your first sync, you can use the change logs to update your documents in your index for future syncs.
    
    The default is set to FALSE.
  - getInclusionPatterns
```
public List<String> getInclusionPatterns()
```
    A list of regular expression patterns to include certain files in your Amazon WorkDocs site repository. Files that match the patterns are included in the index. Files that don't match the patterns are excluded from the index. If a file matches both an inclusion pattern and an exclusion pattern, the exclusion pattern takes precedence and the file isn’t included in the index.
    
    Returns:
    
    A list of regular expression patterns to include certain files in your Amazon WorkDocs site repository. Files that match the patterns are included in the index. Files that don't match the patterns are excluded from the index. If a file matches both an inclusion pattern and an exclusion pattern, the exclusion pattern takes precedence and the file isn’t included in the index.
  - setInclusionPatterns
```
public void setInclusionPatterns(Collection<String> inclusionPatterns)
```
    A list of regular expression patterns to include certain files in your Amazon WorkDocs site repository. Files that match the patterns are included in the index. Files that don't match the patterns are excluded from the index. If a file matches both an inclusion pattern and an exclusion pattern, the exclusion pattern takes precedence and the file isn’t included in the index.
    
    Parameters:
    
    inclusionPatterns - A list of regular expression patterns to include certain files in your Amazon WorkDocs site repository. Files that match the patterns are included in the index. Files that don't match the patterns are excluded from the index. If a file matches both an inclusion pattern and an exclusion pattern, the exclusion pattern takes precedence and the file isn’t included in the index.
  - withInclusionPatterns
```
public WorkDocsConfiguration withInclusionPatterns(String... inclusionPatterns)
```
    A list of regular expression patterns to include certain files in your Amazon WorkDocs site repository. Files that match the patterns are included in the index. Files that don't match the patterns are excluded from the index. If a file matches both an inclusion pattern and an exclusion pattern, the exclusion pattern takes precedence and the file isn’t included in the index.
    
    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 files in your Amazon WorkDocs site repository. Files that match the patterns are included in the index. Files that don't match the patterns are excluded from the index. If a file matches both an inclusion pattern and an exclusion pattern, the exclusion pattern takes precedence and the file isn’t included in the index.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withInclusionPatterns
```
public WorkDocsConfiguration withInclusionPatterns(Collection<String> inclusionPatterns)
```
    A list of regular expression patterns to include certain files in your Amazon WorkDocs site repository. Files that match the patterns are included in the index. Files that don't match the patterns are excluded from the index. If a file matches both an inclusion pattern and an exclusion pattern, the exclusion pattern takes precedence and the file isn’t included in the index.
    
    Parameters:
    
    inclusionPatterns - A list of regular expression patterns to include certain files in your Amazon WorkDocs site repository. Files that match the patterns are included in the index. Files that don't match the patterns are excluded from the index. If a file matches both an inclusion pattern and an exclusion pattern, the exclusion pattern takes precedence and the file isn’t included in the index.
    
    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 files in your Amazon WorkDocs site repository. Files that match the patterns are excluded from the index. Files that don’t match the patterns are included in the index. If a file matches both an inclusion pattern and an exclusion pattern, the exclusion pattern takes precedence and the file isn’t included in the index.
    
    Returns:
    
    A list of regular expression patterns to exclude certain files in your Amazon WorkDocs site repository. Files that match the patterns are excluded from the index. Files that don’t match the patterns are included in the index. If a file matches both an inclusion pattern and an exclusion pattern, the exclusion pattern takes precedence and the file isn’t included in the index.
  - setExclusionPatterns
```
public void setExclusionPatterns(Collection<String> exclusionPatterns)
```
    A list of regular expression patterns to exclude certain files in your Amazon WorkDocs site repository. Files that match the patterns are excluded from the index. Files that don’t match the patterns are included in the index. If a file matches both an inclusion pattern and an exclusion pattern, the exclusion pattern takes precedence and the file isn’t included in the index.
    
    Parameters:
    
    exclusionPatterns - A list of regular expression patterns to exclude certain files in your Amazon WorkDocs site repository. Files that match the patterns are excluded from the index. Files that don’t match the patterns are included in the index. If a file matches both an inclusion pattern and an exclusion pattern, the exclusion pattern takes precedence and the file isn’t included in the index.
  - withExclusionPatterns
```
public WorkDocsConfiguration withExclusionPatterns(String... exclusionPatterns)
```
    A list of regular expression patterns to exclude certain files in your Amazon WorkDocs site repository. Files that match the patterns are excluded from the index. Files that don’t match the patterns are included in the index. If a file matches both an inclusion pattern and an exclusion pattern, the exclusion pattern takes precedence and the file isn’t included in the index.
    
    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 files in your Amazon WorkDocs site repository. Files that match the patterns are excluded from the index. Files that don’t match the patterns are included in the index. If a file matches both an inclusion pattern and an exclusion pattern, the exclusion pattern takes precedence and the file isn’t included in the index.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withExclusionPatterns
```
public WorkDocsConfiguration withExclusionPatterns(Collection<String> exclusionPatterns)
```
    A list of regular expression patterns to exclude certain files in your Amazon WorkDocs site repository. Files that match the patterns are excluded from the index. Files that don’t match the patterns are included in the index. If a file matches both an inclusion pattern and an exclusion pattern, the exclusion pattern takes precedence and the file isn’t included in the index.
    
    Parameters:
    
    exclusionPatterns - A list of regular expression patterns to exclude certain files in your Amazon WorkDocs site repository. Files that match the patterns are excluded from the index. Files that don’t match the patterns are included in the index. If a file matches both an inclusion pattern and an exclusion pattern, the exclusion pattern takes precedence and the file isn’t included in the index.
    
    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 Amazon WorkDocs field names to custom index field names in Amazon Kendra. You must first create the custom index fields using the UpdateIndex operation before you map to Amazon WorkDocs fields. For more information, see Mapping Data Source Fields. The Amazon WorkDocs data source field names need to exist in your Amazon WorkDocs custom metadata.
    
    Returns:
    
    A list of DataSourceToIndexFieldMapping objects that map Amazon WorkDocs field names to custom index field names in Amazon Kendra. You must first create the custom index fields using the UpdateIndex operation before you map to Amazon WorkDocs fields. For more information, see Mapping Data Source Fields. The Amazon WorkDocs data source field names need to exist in your Amazon WorkDocs custom metadata.
  - setFieldMappings
```
public void setFieldMappings(Collection<DataSourceToIndexFieldMapping> fieldMappings)
```
    A list of DataSourceToIndexFieldMapping objects that map Amazon WorkDocs field names to custom index field names in Amazon Kendra. You must first create the custom index fields using the UpdateIndex operation before you map to Amazon WorkDocs fields. For more information, see Mapping Data Source Fields. The Amazon WorkDocs data source field names need to exist in your Amazon WorkDocs custom metadata.
    
    Parameters:
    
    fieldMappings - A list of DataSourceToIndexFieldMapping objects that map Amazon WorkDocs field names to custom index field names in Amazon Kendra. You must first create the custom index fields using the UpdateIndex operation before you map to Amazon WorkDocs fields. For more information, see Mapping Data Source Fields. The Amazon WorkDocs data source field names need to exist in your Amazon WorkDocs custom metadata.
  - withFieldMappings
```
public WorkDocsConfiguration withFieldMappings(DataSourceToIndexFieldMapping... fieldMappings)
```
    A list of DataSourceToIndexFieldMapping objects that map Amazon WorkDocs field names to custom index field names in Amazon Kendra. You must first create the custom index fields using the UpdateIndex operation before you map to Amazon WorkDocs fields. For more information, see Mapping Data Source Fields. The Amazon WorkDocs data source field names need to exist in your Amazon WorkDocs 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 Amazon WorkDocs field names to custom index field names in Amazon Kendra. You must first create the custom index fields using the UpdateIndex operation before you map to Amazon WorkDocs fields. For more information, see Mapping Data Source Fields. The Amazon WorkDocs data source field names need to exist in your Amazon WorkDocs custom metadata.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withFieldMappings
```
public WorkDocsConfiguration withFieldMappings(Collection<DataSourceToIndexFieldMapping> fieldMappings)
```
    A list of DataSourceToIndexFieldMapping objects that map Amazon WorkDocs field names to custom index field names in Amazon Kendra. You must first create the custom index fields using the UpdateIndex operation before you map to Amazon WorkDocs fields. For more information, see Mapping Data Source Fields. The Amazon WorkDocs data source field names need to exist in your Amazon WorkDocs custom metadata.
    
    Parameters:
    
    fieldMappings - A list of DataSourceToIndexFieldMapping objects that map Amazon WorkDocs field names to custom index field names in Amazon Kendra. You must first create the custom index fields using the UpdateIndex operation before you map to Amazon WorkDocs fields. For more information, see Mapping Data Source Fields. The Amazon WorkDocs data source field names need to exist in your Amazon WorkDocs custom metadata.
    
    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 WorkDocsConfiguration 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 WorkDocsConfiguration

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

WorkDocsConfiguration

Method Detail

setOrganizationId

getOrganizationId

withOrganizationId

setCrawlComments

getCrawlComments

withCrawlComments

isCrawlComments

setUseChangeLog

getUseChangeLog

withUseChangeLog

isUseChangeLog

getInclusionPatterns

setInclusionPatterns

withInclusionPatterns

withInclusionPatterns

getExclusionPatterns

setExclusionPatterns

withExclusionPatterns

withExclusionPatterns

getFieldMappings

setFieldMappings

withFieldMappings

withFieldMappings

toString

equals

hashCode

clone

marshall