@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.
Constructor and Description |
---|
WorkDocsConfiguration() |
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 data source attributes or
field names to Amazon Kendra index field names. |
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 Amazon WorkDocs change log to determine which documents require updating in the
index. |
int |
hashCode() |
Boolean |
isCrawlComments()
TRUE to include comments on documents in your index. |
Boolean |
isUseChangeLog()
TRUE to use the Amazon WorkDocs change log to determine which documents require updating in the
index. |
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 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 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 Amazon WorkDocs change log to determine which documents require updating in the
index. |
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 data source attributes or
field names to Amazon Kendra index field names. |
WorkDocsConfiguration |
withFieldMappings(DataSourceToIndexFieldMapping... fieldMappings)
A list of
DataSourceToIndexFieldMapping objects that map Amazon WorkDocs data source attributes or
field names to Amazon Kendra index field names. |
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 Amazon WorkDocs change log to determine which documents require updating in the
index. |
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 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 Directory Service console and enable a Amazon WorkDocs site for the directory in the Amazon WorkDocs console.
organizationId
- The identifier of the directory corresponding to your Amazon WorkDocs site repository.
You can find the organization ID in the 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 Directory Service console and enable a Amazon WorkDocs site for the directory in the Amazon WorkDocs console.
public String getOrganizationId()
The identifier of the directory corresponding to your Amazon WorkDocs site repository.
You can find the organization ID in the 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 Directory Service console and enable a Amazon WorkDocs site for the directory in the Amazon WorkDocs console.
You can find the organization ID in the 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 Directory Service console and enable a Amazon WorkDocs site for the directory in the Amazon WorkDocs console.
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 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 Directory Service console and enable a Amazon WorkDocs site for the directory in the Amazon WorkDocs console.
organizationId
- The identifier of the directory corresponding to your Amazon WorkDocs site repository.
You can find the organization ID in the 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 Directory Service console and enable a Amazon WorkDocs site for the directory in the Amazon WorkDocs console.
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
.
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
.
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
.
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
.
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
.
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
.
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
.
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
.
public void setUseChangeLog(Boolean useChangeLog)
TRUE
to use the Amazon WorkDocs 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 Amazon WorkDocs.
useChangeLog
- TRUE
to use the Amazon WorkDocs 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 Amazon WorkDocs.public Boolean getUseChangeLog()
TRUE
to use the Amazon WorkDocs 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 Amazon WorkDocs.
TRUE
to use the Amazon WorkDocs 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 Amazon WorkDocs.public WorkDocsConfiguration withUseChangeLog(Boolean useChangeLog)
TRUE
to use the Amazon WorkDocs 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 Amazon WorkDocs.
useChangeLog
- TRUE
to use the Amazon WorkDocs 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 Amazon WorkDocs.public Boolean isUseChangeLog()
TRUE
to use the Amazon WorkDocs 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 Amazon WorkDocs.
TRUE
to use the Amazon WorkDocs 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 Amazon WorkDocs.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 and exclusion pattern, the exclusion pattern takes precedence and the file isn't included in the index.
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 and exclusion pattern, the exclusion pattern takes precedence and the file isn't included in the index.
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 and exclusion pattern, the exclusion pattern takes
precedence and the file isn't included in the index.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 and 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.
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 and exclusion pattern, the exclusion pattern takes
precedence and the file isn't included in the index.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 and exclusion pattern, the exclusion pattern takes precedence and the file isn't included in the index.
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 and exclusion pattern, the exclusion pattern takes
precedence and the file isn't included in the index.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 and exclusion pattern, the exclusion pattern takes precedence and the file isn't included in the index.
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 and exclusion pattern, the exclusion pattern takes precedence and the file isn't included in the index.
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 and exclusion pattern, the exclusion pattern
takes precedence and the file isn't included in the index.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 and 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.
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 and exclusion pattern, the exclusion pattern
takes precedence and the file isn't included in the index.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 and exclusion pattern, the exclusion pattern takes precedence and the file isn't included in the index.
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 and exclusion pattern, the exclusion pattern
takes precedence and the file isn't included in the index.public List<DataSourceToIndexFieldMapping> getFieldMappings()
A list of DataSourceToIndexFieldMapping
objects that map Amazon WorkDocs data source attributes or
field names to Amazon Kendra index field names. To create custom fields, use the UpdateIndex
API
before you map to Amazon WorkDocs fields. For more information, see Mapping data source fields. The Amazon
WorkDocs data source field names must exist in your Amazon WorkDocs custom metadata.
DataSourceToIndexFieldMapping
objects that map Amazon WorkDocs data source
attributes or field names to Amazon Kendra index field names. To create custom fields, use the
UpdateIndex
API before you map to Amazon WorkDocs fields. For more information, see Mapping data source fields.
The Amazon WorkDocs data source field names must exist in your Amazon WorkDocs custom metadata.public void setFieldMappings(Collection<DataSourceToIndexFieldMapping> fieldMappings)
A list of DataSourceToIndexFieldMapping
objects that map Amazon WorkDocs data source attributes or
field names to Amazon Kendra index field names. To create custom fields, use the UpdateIndex
API
before you map to Amazon WorkDocs fields. For more information, see Mapping data source fields. The Amazon
WorkDocs data source field names must exist in your Amazon WorkDocs custom metadata.
fieldMappings
- A list of DataSourceToIndexFieldMapping
objects that map Amazon WorkDocs data source
attributes or field names to Amazon Kendra index field names. To create custom fields, use the
UpdateIndex
API before you map to Amazon WorkDocs fields. For more information, see Mapping data source fields. The
Amazon WorkDocs data source field names must exist in your Amazon WorkDocs custom metadata.public WorkDocsConfiguration withFieldMappings(DataSourceToIndexFieldMapping... fieldMappings)
A list of DataSourceToIndexFieldMapping
objects that map Amazon WorkDocs data source attributes or
field names to Amazon Kendra index field names. To create custom fields, use the UpdateIndex
API
before you map to Amazon WorkDocs fields. For more information, see Mapping data source fields. The Amazon
WorkDocs data source field names must 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.
fieldMappings
- A list of DataSourceToIndexFieldMapping
objects that map Amazon WorkDocs data source
attributes or field names to Amazon Kendra index field names. To create custom fields, use the
UpdateIndex
API before you map to Amazon WorkDocs fields. For more information, see Mapping data source fields. The
Amazon WorkDocs data source field names must exist in your Amazon WorkDocs custom metadata.public WorkDocsConfiguration withFieldMappings(Collection<DataSourceToIndexFieldMapping> fieldMappings)
A list of DataSourceToIndexFieldMapping
objects that map Amazon WorkDocs data source attributes or
field names to Amazon Kendra index field names. To create custom fields, use the UpdateIndex
API
before you map to Amazon WorkDocs fields. For more information, see Mapping data source fields. The Amazon
WorkDocs data source field names must exist in your Amazon WorkDocs custom metadata.
fieldMappings
- A list of DataSourceToIndexFieldMapping
objects that map Amazon WorkDocs data source
attributes or field names to Amazon Kendra index field names. To create custom fields, use the
UpdateIndex
API before you map to Amazon WorkDocs fields. For more information, see Mapping data source fields. The
Amazon WorkDocs data source field names must exist in your Amazon WorkDocs custom metadata.public String toString()
toString
in class Object
Object.toString()
public WorkDocsConfiguration clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.