@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class BoxConfiguration extends Object implements Serializable, Cloneable, StructuredPojo
Provides the configuration information to connect to Box as your data source.
Constructor and Description |
---|
BoxConfiguration() |
Modifier and Type | Method and Description |
---|---|
BoxConfiguration |
clone() |
boolean |
equals(Object obj) |
List<DataSourceToIndexFieldMapping> |
getCommentFieldMappings()
A list of
DataSourceToIndexFieldMapping objects that map attributes or field names of Box comments
to Amazon Kendra index field names. |
Boolean |
getCrawlComments()
TRUE to index comments. |
Boolean |
getCrawlTasks()
TRUE to index the contents of tasks. |
Boolean |
getCrawlWebLinks()
TRUE to index web links. |
String |
getEnterpriseId()
The identifier of the Box Enterprise platform.
|
List<String> |
getExclusionPatterns()
A list of regular expression patterns to exclude certain files and folders from your Box platform.
|
List<DataSourceToIndexFieldMapping> |
getFileFieldMappings()
A list of
DataSourceToIndexFieldMapping objects that map attributes or field names of Box files to
Amazon Kendra index field names. |
List<String> |
getInclusionPatterns()
A list of regular expression patterns to include certain files and folders in your Box platform.
|
String |
getSecretArn()
The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the key-value pairs required to connect
to your Box platform.
|
List<DataSourceToIndexFieldMapping> |
getTaskFieldMappings()
A list of
DataSourceToIndexFieldMapping objects that map attributes or field names of Box tasks to
Amazon Kendra index field names. |
Boolean |
getUseChangeLog()
TRUE to use the Slack change log to determine which documents require updating in the index. |
DataSourceVpcConfiguration |
getVpcConfiguration()
Configuration information for an Amazon VPC to connect to your Box.
|
List<DataSourceToIndexFieldMapping> |
getWebLinkFieldMappings()
A list of
DataSourceToIndexFieldMapping objects that map attributes or field names of Box web links
to Amazon Kendra index field names. |
int |
hashCode() |
Boolean |
isCrawlComments()
TRUE to index comments. |
Boolean |
isCrawlTasks()
TRUE to index the contents of tasks. |
Boolean |
isCrawlWebLinks()
TRUE to index web links. |
Boolean |
isUseChangeLog()
TRUE to use the Slack change log to determine which documents require updating in the index. |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setCommentFieldMappings(Collection<DataSourceToIndexFieldMapping> commentFieldMappings)
A list of
DataSourceToIndexFieldMapping objects that map attributes or field names of Box comments
to Amazon Kendra index field names. |
void |
setCrawlComments(Boolean crawlComments)
TRUE to index comments. |
void |
setCrawlTasks(Boolean crawlTasks)
TRUE to index the contents of tasks. |
void |
setCrawlWebLinks(Boolean crawlWebLinks)
TRUE to index web links. |
void |
setEnterpriseId(String enterpriseId)
The identifier of the Box Enterprise platform.
|
void |
setExclusionPatterns(Collection<String> exclusionPatterns)
A list of regular expression patterns to exclude certain files and folders from your Box platform.
|
void |
setFileFieldMappings(Collection<DataSourceToIndexFieldMapping> fileFieldMappings)
A list of
DataSourceToIndexFieldMapping objects that map attributes or field names of Box files to
Amazon Kendra index field names. |
void |
setInclusionPatterns(Collection<String> inclusionPatterns)
A list of regular expression patterns to include certain files and folders in your Box platform.
|
void |
setSecretArn(String secretArn)
The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the key-value pairs required to connect
to your Box platform.
|
void |
setTaskFieldMappings(Collection<DataSourceToIndexFieldMapping> taskFieldMappings)
A list of
DataSourceToIndexFieldMapping objects that map attributes or field names of Box tasks to
Amazon Kendra index field names. |
void |
setUseChangeLog(Boolean useChangeLog)
TRUE to use the Slack change log to determine which documents require updating in the index. |
void |
setVpcConfiguration(DataSourceVpcConfiguration vpcConfiguration)
Configuration information for an Amazon VPC to connect to your Box.
|
void |
setWebLinkFieldMappings(Collection<DataSourceToIndexFieldMapping> webLinkFieldMappings)
A list of
DataSourceToIndexFieldMapping objects that map attributes or field names of Box web links
to Amazon Kendra index field names. |
String |
toString()
Returns a string representation of this object.
|
BoxConfiguration |
withCommentFieldMappings(Collection<DataSourceToIndexFieldMapping> commentFieldMappings)
A list of
DataSourceToIndexFieldMapping objects that map attributes or field names of Box comments
to Amazon Kendra index field names. |
BoxConfiguration |
withCommentFieldMappings(DataSourceToIndexFieldMapping... commentFieldMappings)
A list of
DataSourceToIndexFieldMapping objects that map attributes or field names of Box comments
to Amazon Kendra index field names. |
BoxConfiguration |
withCrawlComments(Boolean crawlComments)
TRUE to index comments. |
BoxConfiguration |
withCrawlTasks(Boolean crawlTasks)
TRUE to index the contents of tasks. |
BoxConfiguration |
withCrawlWebLinks(Boolean crawlWebLinks)
TRUE to index web links. |
BoxConfiguration |
withEnterpriseId(String enterpriseId)
The identifier of the Box Enterprise platform.
|
BoxConfiguration |
withExclusionPatterns(Collection<String> exclusionPatterns)
A list of regular expression patterns to exclude certain files and folders from your Box platform.
|
BoxConfiguration |
withExclusionPatterns(String... exclusionPatterns)
A list of regular expression patterns to exclude certain files and folders from your Box platform.
|
BoxConfiguration |
withFileFieldMappings(Collection<DataSourceToIndexFieldMapping> fileFieldMappings)
A list of
DataSourceToIndexFieldMapping objects that map attributes or field names of Box files to
Amazon Kendra index field names. |
BoxConfiguration |
withFileFieldMappings(DataSourceToIndexFieldMapping... fileFieldMappings)
A list of
DataSourceToIndexFieldMapping objects that map attributes or field names of Box files to
Amazon Kendra index field names. |
BoxConfiguration |
withInclusionPatterns(Collection<String> inclusionPatterns)
A list of regular expression patterns to include certain files and folders in your Box platform.
|
BoxConfiguration |
withInclusionPatterns(String... inclusionPatterns)
A list of regular expression patterns to include certain files and folders in your Box platform.
|
BoxConfiguration |
withSecretArn(String secretArn)
The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the key-value pairs required to connect
to your Box platform.
|
BoxConfiguration |
withTaskFieldMappings(Collection<DataSourceToIndexFieldMapping> taskFieldMappings)
A list of
DataSourceToIndexFieldMapping objects that map attributes or field names of Box tasks to
Amazon Kendra index field names. |
BoxConfiguration |
withTaskFieldMappings(DataSourceToIndexFieldMapping... taskFieldMappings)
A list of
DataSourceToIndexFieldMapping objects that map attributes or field names of Box tasks to
Amazon Kendra index field names. |
BoxConfiguration |
withUseChangeLog(Boolean useChangeLog)
TRUE to use the Slack change log to determine which documents require updating in the index. |
BoxConfiguration |
withVpcConfiguration(DataSourceVpcConfiguration vpcConfiguration)
Configuration information for an Amazon VPC to connect to your Box.
|
BoxConfiguration |
withWebLinkFieldMappings(Collection<DataSourceToIndexFieldMapping> webLinkFieldMappings)
A list of
DataSourceToIndexFieldMapping objects that map attributes or field names of Box web links
to Amazon Kendra index field names. |
BoxConfiguration |
withWebLinkFieldMappings(DataSourceToIndexFieldMapping... webLinkFieldMappings)
A list of
DataSourceToIndexFieldMapping objects that map attributes or field names of Box web links
to Amazon Kendra index field names. |
public void setEnterpriseId(String enterpriseId)
The identifier of the Box Enterprise platform. You can find the enterprise ID in the Box Developer Console settings or when you create an app in Box and download your authentication credentials. For example, 801234567.
enterpriseId
- The identifier of the Box Enterprise platform. You can find the enterprise ID in the Box Developer Console
settings or when you create an app in Box and download your authentication credentials. For example,
801234567.public String getEnterpriseId()
The identifier of the Box Enterprise platform. You can find the enterprise ID in the Box Developer Console settings or when you create an app in Box and download your authentication credentials. For example, 801234567.
public BoxConfiguration withEnterpriseId(String enterpriseId)
The identifier of the Box Enterprise platform. You can find the enterprise ID in the Box Developer Console settings or when you create an app in Box and download your authentication credentials. For example, 801234567.
enterpriseId
- The identifier of the Box Enterprise platform. You can find the enterprise ID in the Box Developer Console
settings or when you create an app in Box and download your authentication credentials. For example,
801234567.public void setSecretArn(String secretArn)
The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the key-value pairs required to connect to your Box platform. The secret must contain a JSON structure with the following keys:
clientID—The identifier of the client OAuth 2.0 authentication application created in Box.
clientSecret—A set of characters known only to the OAuth 2.0 authentication application created in Box.
publicKeyId—The identifier of the public key contained within an identity certificate.
privateKey—A set of characters that make up an encryption key.
passphrase—A set of characters that act like a password.
You create an application in Box to generate the keys or credentials required for the secret. For more information, see Using a Box data source.
secretArn
- The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the key-value pairs required to
connect to your Box platform. The secret must contain a JSON structure with the following keys:
clientID—The identifier of the client OAuth 2.0 authentication application created in Box.
clientSecret—A set of characters known only to the OAuth 2.0 authentication application created in Box.
publicKeyId—The identifier of the public key contained within an identity certificate.
privateKey—A set of characters that make up an encryption key.
passphrase—A set of characters that act like a password.
You create an application in Box to generate the keys or credentials required for the secret. For more information, see Using a Box data source.
public String getSecretArn()
The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the key-value pairs required to connect to your Box platform. The secret must contain a JSON structure with the following keys:
clientID—The identifier of the client OAuth 2.0 authentication application created in Box.
clientSecret—A set of characters known only to the OAuth 2.0 authentication application created in Box.
publicKeyId—The identifier of the public key contained within an identity certificate.
privateKey—A set of characters that make up an encryption key.
passphrase—A set of characters that act like a password.
You create an application in Box to generate the keys or credentials required for the secret. For more information, see Using a Box data source.
clientID—The identifier of the client OAuth 2.0 authentication application created in Box.
clientSecret—A set of characters known only to the OAuth 2.0 authentication application created in Box.
publicKeyId—The identifier of the public key contained within an identity certificate.
privateKey—A set of characters that make up an encryption key.
passphrase—A set of characters that act like a password.
You create an application in Box to generate the keys or credentials required for the secret. For more information, see Using a Box data source.
public BoxConfiguration withSecretArn(String secretArn)
The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the key-value pairs required to connect to your Box platform. The secret must contain a JSON structure with the following keys:
clientID—The identifier of the client OAuth 2.0 authentication application created in Box.
clientSecret—A set of characters known only to the OAuth 2.0 authentication application created in Box.
publicKeyId—The identifier of the public key contained within an identity certificate.
privateKey—A set of characters that make up an encryption key.
passphrase—A set of characters that act like a password.
You create an application in Box to generate the keys or credentials required for the secret. For more information, see Using a Box data source.
secretArn
- The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the key-value pairs required to
connect to your Box platform. The secret must contain a JSON structure with the following keys:
clientID—The identifier of the client OAuth 2.0 authentication application created in Box.
clientSecret—A set of characters known only to the OAuth 2.0 authentication application created in Box.
publicKeyId—The identifier of the public key contained within an identity certificate.
privateKey—A set of characters that make up an encryption key.
passphrase—A set of characters that act like a password.
You create an application in Box to generate the keys or credentials required for the secret. For more information, see Using a Box data source.
public void setUseChangeLog(Boolean useChangeLog)
TRUE
to use the Slack change log to determine which documents require updating in the index.
Depending on the data source change log's size, it may take longer for Amazon Kendra to use the change log than
to scan all of your documents.
useChangeLog
- TRUE
to use the Slack change log to determine which documents require updating in the index.
Depending on the data source change log's size, it may take longer for Amazon Kendra to use the change log
than to scan all of your documents.public Boolean getUseChangeLog()
TRUE
to use the Slack change log to determine which documents require updating in the index.
Depending on the data source change log's size, it may take longer for Amazon Kendra to use the change log than
to scan all of your documents.
TRUE
to use the Slack change log to determine which documents require updating in the index.
Depending on the data source change log's size, it may take longer for Amazon Kendra to use the change
log than to scan all of your documents.public BoxConfiguration withUseChangeLog(Boolean useChangeLog)
TRUE
to use the Slack change log to determine which documents require updating in the index.
Depending on the data source change log's size, it may take longer for Amazon Kendra to use the change log than
to scan all of your documents.
useChangeLog
- TRUE
to use the Slack change log to determine which documents require updating in the index.
Depending on the data source change log's size, it may take longer for Amazon Kendra to use the change log
than to scan all of your documents.public Boolean isUseChangeLog()
TRUE
to use the Slack change log to determine which documents require updating in the index.
Depending on the data source change log's size, it may take longer for Amazon Kendra to use the change log than
to scan all of your documents.
TRUE
to use the Slack change log to determine which documents require updating in the index.
Depending on the data source change log's size, it may take longer for Amazon Kendra to use the change
log than to scan all of your documents.public void setCrawlComments(Boolean crawlComments)
TRUE
to index comments.
crawlComments
- TRUE
to index comments.public Boolean getCrawlComments()
TRUE
to index comments.
TRUE
to index comments.public BoxConfiguration withCrawlComments(Boolean crawlComments)
TRUE
to index comments.
crawlComments
- TRUE
to index comments.public Boolean isCrawlComments()
TRUE
to index comments.
TRUE
to index comments.public void setCrawlTasks(Boolean crawlTasks)
TRUE
to index the contents of tasks.
crawlTasks
- TRUE
to index the contents of tasks.public Boolean getCrawlTasks()
TRUE
to index the contents of tasks.
TRUE
to index the contents of tasks.public BoxConfiguration withCrawlTasks(Boolean crawlTasks)
TRUE
to index the contents of tasks.
crawlTasks
- TRUE
to index the contents of tasks.public Boolean isCrawlTasks()
TRUE
to index the contents of tasks.
TRUE
to index the contents of tasks.public void setCrawlWebLinks(Boolean crawlWebLinks)
TRUE
to index web links.
crawlWebLinks
- TRUE
to index web links.public Boolean getCrawlWebLinks()
TRUE
to index web links.
TRUE
to index web links.public BoxConfiguration withCrawlWebLinks(Boolean crawlWebLinks)
TRUE
to index web links.
crawlWebLinks
- TRUE
to index web links.public Boolean isCrawlWebLinks()
TRUE
to index web links.
TRUE
to index web links.public List<DataSourceToIndexFieldMapping> getFileFieldMappings()
A list of DataSourceToIndexFieldMapping
objects that map attributes or field names of Box files to
Amazon Kendra index field names. To create custom fields, use the UpdateIndex
API before you map to
Box fields. For more information, see Mapping data source fields. The Box
field names must exist in your Box custom metadata.
DataSourceToIndexFieldMapping
objects that map attributes or field names of Box
files to Amazon Kendra index field names. To create custom fields, use the UpdateIndex
API
before you map to Box fields. For more information, see Mapping data source fields.
The Box field names must exist in your Box custom metadata.public void setFileFieldMappings(Collection<DataSourceToIndexFieldMapping> fileFieldMappings)
A list of DataSourceToIndexFieldMapping
objects that map attributes or field names of Box files to
Amazon Kendra index field names. To create custom fields, use the UpdateIndex
API before you map to
Box fields. For more information, see Mapping data source fields. The Box
field names must exist in your Box custom metadata.
fileFieldMappings
- A list of DataSourceToIndexFieldMapping
objects that map attributes or field names of Box
files to Amazon Kendra index field names. To create custom fields, use the UpdateIndex
API
before you map to Box fields. For more information, see Mapping data source fields. The
Box field names must exist in your Box custom metadata.public BoxConfiguration withFileFieldMappings(DataSourceToIndexFieldMapping... fileFieldMappings)
A list of DataSourceToIndexFieldMapping
objects that map attributes or field names of Box files to
Amazon Kendra index field names. To create custom fields, use the UpdateIndex
API before you map to
Box fields. For more information, see Mapping data source fields. The Box
field names must exist in your Box custom metadata.
NOTE: This method appends the values to the existing list (if any). Use
setFileFieldMappings(java.util.Collection)
or withFileFieldMappings(java.util.Collection)
if
you want to override the existing values.
fileFieldMappings
- A list of DataSourceToIndexFieldMapping
objects that map attributes or field names of Box
files to Amazon Kendra index field names. To create custom fields, use the UpdateIndex
API
before you map to Box fields. For more information, see Mapping data source fields. The
Box field names must exist in your Box custom metadata.public BoxConfiguration withFileFieldMappings(Collection<DataSourceToIndexFieldMapping> fileFieldMappings)
A list of DataSourceToIndexFieldMapping
objects that map attributes or field names of Box files to
Amazon Kendra index field names. To create custom fields, use the UpdateIndex
API before you map to
Box fields. For more information, see Mapping data source fields. The Box
field names must exist in your Box custom metadata.
fileFieldMappings
- A list of DataSourceToIndexFieldMapping
objects that map attributes or field names of Box
files to Amazon Kendra index field names. To create custom fields, use the UpdateIndex
API
before you map to Box fields. For more information, see Mapping data source fields. The
Box field names must exist in your Box custom metadata.public List<DataSourceToIndexFieldMapping> getTaskFieldMappings()
A list of DataSourceToIndexFieldMapping
objects that map attributes or field names of Box tasks to
Amazon Kendra index field names. To create custom fields, use the UpdateIndex
API before you map to
Box fields. For more information, see Mapping data source fields. The Box
field names must exist in your Box custom metadata.
DataSourceToIndexFieldMapping
objects that map attributes or field names of Box
tasks to Amazon Kendra index field names. To create custom fields, use the UpdateIndex
API
before you map to Box fields. For more information, see Mapping data source fields.
The Box field names must exist in your Box custom metadata.public void setTaskFieldMappings(Collection<DataSourceToIndexFieldMapping> taskFieldMappings)
A list of DataSourceToIndexFieldMapping
objects that map attributes or field names of Box tasks to
Amazon Kendra index field names. To create custom fields, use the UpdateIndex
API before you map to
Box fields. For more information, see Mapping data source fields. The Box
field names must exist in your Box custom metadata.
taskFieldMappings
- A list of DataSourceToIndexFieldMapping
objects that map attributes or field names of Box
tasks to Amazon Kendra index field names. To create custom fields, use the UpdateIndex
API
before you map to Box fields. For more information, see Mapping data source fields. The
Box field names must exist in your Box custom metadata.public BoxConfiguration withTaskFieldMappings(DataSourceToIndexFieldMapping... taskFieldMappings)
A list of DataSourceToIndexFieldMapping
objects that map attributes or field names of Box tasks to
Amazon Kendra index field names. To create custom fields, use the UpdateIndex
API before you map to
Box fields. For more information, see Mapping data source fields. The Box
field names must exist in your Box custom metadata.
NOTE: This method appends the values to the existing list (if any). Use
setTaskFieldMappings(java.util.Collection)
or withTaskFieldMappings(java.util.Collection)
if
you want to override the existing values.
taskFieldMappings
- A list of DataSourceToIndexFieldMapping
objects that map attributes or field names of Box
tasks to Amazon Kendra index field names. To create custom fields, use the UpdateIndex
API
before you map to Box fields. For more information, see Mapping data source fields. The
Box field names must exist in your Box custom metadata.public BoxConfiguration withTaskFieldMappings(Collection<DataSourceToIndexFieldMapping> taskFieldMappings)
A list of DataSourceToIndexFieldMapping
objects that map attributes or field names of Box tasks to
Amazon Kendra index field names. To create custom fields, use the UpdateIndex
API before you map to
Box fields. For more information, see Mapping data source fields. The Box
field names must exist in your Box custom metadata.
taskFieldMappings
- A list of DataSourceToIndexFieldMapping
objects that map attributes or field names of Box
tasks to Amazon Kendra index field names. To create custom fields, use the UpdateIndex
API
before you map to Box fields. For more information, see Mapping data source fields. The
Box field names must exist in your Box custom metadata.public List<DataSourceToIndexFieldMapping> getCommentFieldMappings()
A list of DataSourceToIndexFieldMapping
objects that map attributes or field names of Box comments
to Amazon Kendra index field names. To create custom fields, use the UpdateIndex
API before you map
to Box fields. For more information, see Mapping data source fields. The Box
field names must exist in your Box custom metadata.
DataSourceToIndexFieldMapping
objects that map attributes or field names of Box
comments to Amazon Kendra index field names. To create custom fields, use the UpdateIndex
API before you map to Box fields. For more information, see Mapping data source fields.
The Box field names must exist in your Box custom metadata.public void setCommentFieldMappings(Collection<DataSourceToIndexFieldMapping> commentFieldMappings)
A list of DataSourceToIndexFieldMapping
objects that map attributes or field names of Box comments
to Amazon Kendra index field names. To create custom fields, use the UpdateIndex
API before you map
to Box fields. For more information, see Mapping data source fields. The Box
field names must exist in your Box custom metadata.
commentFieldMappings
- A list of DataSourceToIndexFieldMapping
objects that map attributes or field names of Box
comments to Amazon Kendra index field names. To create custom fields, use the UpdateIndex
API
before you map to Box fields. For more information, see Mapping data source fields. The
Box field names must exist in your Box custom metadata.public BoxConfiguration withCommentFieldMappings(DataSourceToIndexFieldMapping... commentFieldMappings)
A list of DataSourceToIndexFieldMapping
objects that map attributes or field names of Box comments
to Amazon Kendra index field names. To create custom fields, use the UpdateIndex
API before you map
to Box fields. For more information, see Mapping data source fields. The Box
field names must exist in your Box custom metadata.
NOTE: This method appends the values to the existing list (if any). Use
setCommentFieldMappings(java.util.Collection)
or withCommentFieldMappings(java.util.Collection)
if you want to override the existing values.
commentFieldMappings
- A list of DataSourceToIndexFieldMapping
objects that map attributes or field names of Box
comments to Amazon Kendra index field names. To create custom fields, use the UpdateIndex
API
before you map to Box fields. For more information, see Mapping data source fields. The
Box field names must exist in your Box custom metadata.public BoxConfiguration withCommentFieldMappings(Collection<DataSourceToIndexFieldMapping> commentFieldMappings)
A list of DataSourceToIndexFieldMapping
objects that map attributes or field names of Box comments
to Amazon Kendra index field names. To create custom fields, use the UpdateIndex
API before you map
to Box fields. For more information, see Mapping data source fields. The Box
field names must exist in your Box custom metadata.
commentFieldMappings
- A list of DataSourceToIndexFieldMapping
objects that map attributes or field names of Box
comments to Amazon Kendra index field names. To create custom fields, use the UpdateIndex
API
before you map to Box fields. For more information, see Mapping data source fields. The
Box field names must exist in your Box custom metadata.public List<DataSourceToIndexFieldMapping> getWebLinkFieldMappings()
A list of DataSourceToIndexFieldMapping
objects that map attributes or field names of Box web links
to Amazon Kendra index field names. To create custom fields, use the UpdateIndex
API before you map
to Box fields. For more information, see Mapping data source fields. The Box
field names must exist in your Box custom metadata.
DataSourceToIndexFieldMapping
objects that map attributes or field names of Box
web links to Amazon Kendra index field names. To create custom fields, use the UpdateIndex
API before you map to Box fields. For more information, see Mapping data source fields.
The Box field names must exist in your Box custom metadata.public void setWebLinkFieldMappings(Collection<DataSourceToIndexFieldMapping> webLinkFieldMappings)
A list of DataSourceToIndexFieldMapping
objects that map attributes or field names of Box web links
to Amazon Kendra index field names. To create custom fields, use the UpdateIndex
API before you map
to Box fields. For more information, see Mapping data source fields. The Box
field names must exist in your Box custom metadata.
webLinkFieldMappings
- A list of DataSourceToIndexFieldMapping
objects that map attributes or field names of Box web
links to Amazon Kendra index field names. To create custom fields, use the UpdateIndex
API
before you map to Box fields. For more information, see Mapping data source fields. The
Box field names must exist in your Box custom metadata.public BoxConfiguration withWebLinkFieldMappings(DataSourceToIndexFieldMapping... webLinkFieldMappings)
A list of DataSourceToIndexFieldMapping
objects that map attributes or field names of Box web links
to Amazon Kendra index field names. To create custom fields, use the UpdateIndex
API before you map
to Box fields. For more information, see Mapping data source fields. The Box
field names must exist in your Box custom metadata.
NOTE: This method appends the values to the existing list (if any). Use
setWebLinkFieldMappings(java.util.Collection)
or withWebLinkFieldMappings(java.util.Collection)
if you want to override the existing values.
webLinkFieldMappings
- A list of DataSourceToIndexFieldMapping
objects that map attributes or field names of Box web
links to Amazon Kendra index field names. To create custom fields, use the UpdateIndex
API
before you map to Box fields. For more information, see Mapping data source fields. The
Box field names must exist in your Box custom metadata.public BoxConfiguration withWebLinkFieldMappings(Collection<DataSourceToIndexFieldMapping> webLinkFieldMappings)
A list of DataSourceToIndexFieldMapping
objects that map attributes or field names of Box web links
to Amazon Kendra index field names. To create custom fields, use the UpdateIndex
API before you map
to Box fields. For more information, see Mapping data source fields. The Box
field names must exist in your Box custom metadata.
webLinkFieldMappings
- A list of DataSourceToIndexFieldMapping
objects that map attributes or field names of Box web
links to Amazon Kendra index field names. To create custom fields, use the UpdateIndex
API
before you map to Box fields. For more information, see Mapping data source fields. The
Box field names must exist in your Box custom metadata.public List<String> getInclusionPatterns()
A list of regular expression patterns to include certain files and folders in your Box platform. Files and folders that match the patterns are included in the index. Files and folders that don't match the patterns are excluded from the index. If a file or folder matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the file or folder isn't included in the index.
public void setInclusionPatterns(Collection<String> inclusionPatterns)
A list of regular expression patterns to include certain files and folders in your Box platform. Files and folders that match the patterns are included in the index. Files and folders that don't match the patterns are excluded from the index. If a file or folder matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the file or folder isn't included in the index.
inclusionPatterns
- A list of regular expression patterns to include certain files and folders in your Box platform. Files and
folders that match the patterns are included in the index. Files and folders that don't match the patterns
are excluded from the index. If a file or folder matches both an inclusion and exclusion pattern, the
exclusion pattern takes precedence and the file or folder isn't included in the index.public BoxConfiguration withInclusionPatterns(String... inclusionPatterns)
A list of regular expression patterns to include certain files and folders in your Box platform. Files and folders that match the patterns are included in the index. Files and folders that don't match the patterns are excluded from the index. If a file or folder matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the file or folder 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 and folders in your Box platform. Files and
folders that match the patterns are included in the index. Files and folders that don't match the patterns
are excluded from the index. If a file or folder matches both an inclusion and exclusion pattern, the
exclusion pattern takes precedence and the file or folder isn't included in the index.public BoxConfiguration withInclusionPatterns(Collection<String> inclusionPatterns)
A list of regular expression patterns to include certain files and folders in your Box platform. Files and folders that match the patterns are included in the index. Files and folders that don't match the patterns are excluded from the index. If a file or folder matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the file or folder isn't included in the index.
inclusionPatterns
- A list of regular expression patterns to include certain files and folders in your Box platform. Files and
folders that match the patterns are included in the index. Files and folders that don't match the patterns
are excluded from the index. If a file or folder matches both an inclusion and exclusion pattern, the
exclusion pattern takes precedence and the file or folder isn't included in the index.public List<String> getExclusionPatterns()
A list of regular expression patterns to exclude certain files and folders from your Box platform. Files and folders that match the patterns are excluded from the index.Files and folders that don't match the patterns are included in the index. If a file or folder matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the file or folder isn't included in the index.
public void setExclusionPatterns(Collection<String> exclusionPatterns)
A list of regular expression patterns to exclude certain files and folders from your Box platform. Files and folders that match the patterns are excluded from the index.Files and folders that don't match the patterns are included in the index. If a file or folder matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the file or folder isn't included in the index.
exclusionPatterns
- A list of regular expression patterns to exclude certain files and folders from your Box platform. Files
and folders that match the patterns are excluded from the index.Files and folders that don't match the
patterns are included in the index. If a file or folder matches both an inclusion and exclusion pattern,
the exclusion pattern takes precedence and the file or folder isn't included in the index.public BoxConfiguration withExclusionPatterns(String... exclusionPatterns)
A list of regular expression patterns to exclude certain files and folders from your Box platform. Files and folders that match the patterns are excluded from the index.Files and folders that don't match the patterns are included in the index. If a file or folder matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the file or folder 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 and folders from your Box platform. Files
and folders that match the patterns are excluded from the index.Files and folders that don't match the
patterns are included in the index. If a file or folder matches both an inclusion and exclusion pattern,
the exclusion pattern takes precedence and the file or folder isn't included in the index.public BoxConfiguration withExclusionPatterns(Collection<String> exclusionPatterns)
A list of regular expression patterns to exclude certain files and folders from your Box platform. Files and folders that match the patterns are excluded from the index.Files and folders that don't match the patterns are included in the index. If a file or folder matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the file or folder isn't included in the index.
exclusionPatterns
- A list of regular expression patterns to exclude certain files and folders from your Box platform. Files
and folders that match the patterns are excluded from the index.Files and folders that don't match the
patterns are included in the index. If a file or folder matches both an inclusion and exclusion pattern,
the exclusion pattern takes precedence and the file or folder isn't included in the index.public void setVpcConfiguration(DataSourceVpcConfiguration vpcConfiguration)
Configuration information for an Amazon VPC to connect to your Box. For more information, see Configuring a VPC.
vpcConfiguration
- Configuration information for an Amazon VPC to connect to your Box. For more information, see Configuring a VPC.public DataSourceVpcConfiguration getVpcConfiguration()
Configuration information for an Amazon VPC to connect to your Box. For more information, see Configuring a VPC.
public BoxConfiguration withVpcConfiguration(DataSourceVpcConfiguration vpcConfiguration)
Configuration information for an Amazon VPC to connect to your Box. For more information, see Configuring a VPC.
vpcConfiguration
- Configuration information for an Amazon VPC to connect to your Box. For more information, see Configuring a VPC.public String toString()
toString
in class Object
Object.toString()
public BoxConfiguration clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.