BoxConfiguration (AWS SDK for Java

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

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@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.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

BoxConfiguration()

Constructors
Constructor and Description
`BoxConfiguration()`

Method Summary

All Methods Instance Methods Concrete Methods
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.

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

- Constructor Detail
  - BoxConfiguration
```
public BoxConfiguration()
```
- Method Detail
  - setEnterpriseId
```
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.
    
    Parameters:
    
    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.
  - getEnterpriseId
```
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.
    
    Returns:
    
    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.
  - withEnterpriseId
```
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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSecretArn
```
public void setSecretArn(String secretArn)
```
    The Amazon Resource Name (ARN) of 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.
    Parameters:
    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.
  - getSecretArn
```
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.
    Returns:
    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.
  - withSecretArn
```
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.
    Parameters:
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setUseChangeLog
```
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.
    
    Parameters:
    
    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.
  - getUseChangeLog
```
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.
    
    Returns:
    
    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.
  - withUseChangeLog
```
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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isUseChangeLog
```
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.
    
    Returns:
    
    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.
  - setCrawlComments
```
public void setCrawlComments(Boolean crawlComments)
```
    TRUE to index comments.
    
    Parameters:
    
    crawlComments - TRUE to index comments.
  - getCrawlComments
```
public Boolean getCrawlComments()
```
    TRUE to index comments.
    
    Returns:
    
    TRUE to index comments.
  - withCrawlComments
```
public BoxConfiguration withCrawlComments(Boolean crawlComments)
```
    TRUE to index comments.
    
    Parameters:
    
    crawlComments - TRUE to index comments.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isCrawlComments
```
public Boolean isCrawlComments()
```
    TRUE to index comments.
    
    Returns:
    
    TRUE to index comments.
  - setCrawlTasks
```
public void setCrawlTasks(Boolean crawlTasks)
```
    TRUE to index the contents of tasks.
    
    Parameters:
    
    crawlTasks - TRUE to index the contents of tasks.
  - getCrawlTasks
```
public Boolean getCrawlTasks()
```
    TRUE to index the contents of tasks.
    
    Returns:
    
    TRUE to index the contents of tasks.
  - withCrawlTasks
```
public BoxConfiguration withCrawlTasks(Boolean crawlTasks)
```
    TRUE to index the contents of tasks.
    
    Parameters:
    
    crawlTasks - TRUE to index the contents of tasks.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isCrawlTasks
```
public Boolean isCrawlTasks()
```
    TRUE to index the contents of tasks.
    
    Returns:
    
    TRUE to index the contents of tasks.
  - setCrawlWebLinks
```
public void setCrawlWebLinks(Boolean crawlWebLinks)
```
    TRUE to index web links.
    
    Parameters:
    
    crawlWebLinks - TRUE to index web links.
  - getCrawlWebLinks
```
public Boolean getCrawlWebLinks()
```
    TRUE to index web links.
    
    Returns:
    
    TRUE to index web links.
  - withCrawlWebLinks
```
public BoxConfiguration withCrawlWebLinks(Boolean crawlWebLinks)
```
    TRUE to index web links.
    
    Parameters:
    
    crawlWebLinks - TRUE to index web links.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isCrawlWebLinks
```
public Boolean isCrawlWebLinks()
```
    TRUE to index web links.
    
    Returns:
    
    TRUE to index web links.
  - getFileFieldMappings
```
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.
    
    Returns:
    
    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.
  - setFileFieldMappings
```
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.
    
    Parameters:
    
    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.
  - withFileFieldMappings
```
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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withFileFieldMappings
```
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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getTaskFieldMappings
```
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.
    
    Returns:
    
    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.
  - setTaskFieldMappings
```
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.
    
    Parameters:
    
    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.
  - withTaskFieldMappings
```
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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withTaskFieldMappings
```
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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getCommentFieldMappings
```
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.
    
    Returns:
    
    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.
  - setCommentFieldMappings
```
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.
    
    Parameters:
    
    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.
  - withCommentFieldMappings
```
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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withCommentFieldMappings
```
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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getWebLinkFieldMappings
```
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.
    
    Returns:
    
    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.
  - setWebLinkFieldMappings
```
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.
    
    Parameters:
    
    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.
  - withWebLinkFieldMappings
```
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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withWebLinkFieldMappings
```
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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getInclusionPatterns
```
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.
    
    Returns:
    
    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.
  - setInclusionPatterns
```
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.
    
    Parameters:
    
    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.
  - withInclusionPatterns
```
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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withInclusionPatterns
```
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.
    
    Parameters:
    
    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.
    
    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 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.
    
    Returns:
    
    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.
  - setExclusionPatterns
```
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.
    
    Parameters:
    
    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.
  - withExclusionPatterns
```
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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withExclusionPatterns
```
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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setVpcConfiguration
```
public void setVpcConfiguration(DataSourceVpcConfiguration vpcConfiguration)
```
    Configuration information for an Amazon VPC to connect to your Box. For more information, see Configuring a VPC.
    
    Parameters:
    
    vpcConfiguration - Configuration information for an Amazon VPC to connect to your Box. For more information, see Configuring a VPC.
  - getVpcConfiguration
```
public DataSourceVpcConfiguration getVpcConfiguration()
```
    Configuration information for an Amazon VPC to connect to your Box. For more information, see Configuring a VPC.
    
    Returns:
    
    Configuration information for an Amazon VPC to connect to your Box. For more information, see Configuring a VPC.
  - withVpcConfiguration
```
public BoxConfiguration withVpcConfiguration(DataSourceVpcConfiguration vpcConfiguration)
```
    Configuration information for an Amazon VPC to connect to your Box. For more information, see Configuring a VPC.
    
    Parameters:
    
    vpcConfiguration - Configuration information for an Amazon VPC to connect to your Box. For more information, see Configuring a VPC.
    
    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 BoxConfiguration 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.

AWS SDK for Java 1.x API Reference - 1.12.793

Class BoxConfiguration

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

BoxConfiguration

Method Detail

setEnterpriseId

getEnterpriseId

withEnterpriseId

setSecretArn

getSecretArn

withSecretArn

setUseChangeLog

getUseChangeLog

withUseChangeLog

isUseChangeLog

setCrawlComments

getCrawlComments

withCrawlComments

isCrawlComments

setCrawlTasks

getCrawlTasks

withCrawlTasks

isCrawlTasks

setCrawlWebLinks

getCrawlWebLinks

withCrawlWebLinks

isCrawlWebLinks

getFileFieldMappings

setFileFieldMappings

withFileFieldMappings

withFileFieldMappings

getTaskFieldMappings

setTaskFieldMappings

withTaskFieldMappings

withTaskFieldMappings

getCommentFieldMappings

setCommentFieldMappings

withCommentFieldMappings

withCommentFieldMappings

getWebLinkFieldMappings

setWebLinkFieldMappings

withWebLinkFieldMappings

withWebLinkFieldMappings

getInclusionPatterns

setInclusionPatterns

withInclusionPatterns

withInclusionPatterns

getExclusionPatterns

setExclusionPatterns

withExclusionPatterns

withExclusionPatterns

setVpcConfiguration

getVpcConfiguration

withVpcConfiguration

toString

equals

hashCode

clone

marshall