Package software.amazon.awssdk.services.kendra.model

Interface BoxConfiguration.Builder

All Superinterfaces:
Buildable, CopyableBuilder<BoxConfiguration.Builder,BoxConfiguration>, SdkBuilder<BoxConfiguration.Builder,BoxConfiguration>, SdkPojo
Enclosing class:
BoxConfiguration
public static interface BoxConfiguration.Builder extends SdkPojo, CopyableBuilder<BoxConfiguration.Builder,BoxConfiguration>

  • Method Details

    • enterpriseId

      BoxConfiguration.Builder enterpriseId(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.

    • secretArn

      BoxConfiguration.Builder secretArn(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.

    • useChangeLog

      BoxConfiguration.Builder useChangeLog(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.

    • crawlComments

      BoxConfiguration.Builder crawlComments(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.

    • crawlTasks

      BoxConfiguration.Builder crawlTasks(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.

    • crawlWebLinks

      BoxConfiguration.Builder crawlWebLinks(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.

    • fileFieldMappings

      BoxConfiguration.Builder fileFieldMappings(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.

    • fileFieldMappings

      BoxConfiguration.Builder fileFieldMappings(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.

    • fileFieldMappings

      BoxConfiguration.Builder fileFieldMappings(Consumer<DataSourceToIndexFieldMapping.Builder>... 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.

      This is a convenience method that creates an instance of the DataSourceToIndexFieldMapping.Builder avoiding the need to create one manually via DataSourceToIndexFieldMapping.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to fileFieldMappings(List<DataSourceToIndexFieldMapping>).

      Parameters:
      fileFieldMappings - a consumer that will call methods on DataSourceToIndexFieldMapping.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • taskFieldMappings

      BoxConfiguration.Builder taskFieldMappings(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.

    • taskFieldMappings

      BoxConfiguration.Builder taskFieldMappings(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.

    • taskFieldMappings

      BoxConfiguration.Builder taskFieldMappings(Consumer<DataSourceToIndexFieldMapping.Builder>... 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.

      This is a convenience method that creates an instance of the DataSourceToIndexFieldMapping.Builder avoiding the need to create one manually via DataSourceToIndexFieldMapping.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to taskFieldMappings(List<DataSourceToIndexFieldMapping>).

      Parameters:
      taskFieldMappings - a consumer that will call methods on DataSourceToIndexFieldMapping.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • commentFieldMappings

      BoxConfiguration.Builder commentFieldMappings(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.

    • commentFieldMappings

      BoxConfiguration.Builder commentFieldMappings(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.

    • commentFieldMappings

      BoxConfiguration.Builder commentFieldMappings(Consumer<DataSourceToIndexFieldMapping.Builder>... 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.

      This is a convenience method that creates an instance of the DataSourceToIndexFieldMapping.Builder avoiding the need to create one manually via DataSourceToIndexFieldMapping.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to commentFieldMappings(List<DataSourceToIndexFieldMapping>).

      Parameters:
      commentFieldMappings - a consumer that will call methods on DataSourceToIndexFieldMapping.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • webLinkFieldMappings

      BoxConfiguration.Builder webLinkFieldMappings(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.

    • webLinkFieldMappings

      BoxConfiguration.Builder webLinkFieldMappings(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.

    • webLinkFieldMappings

      BoxConfiguration.Builder webLinkFieldMappings(Consumer<DataSourceToIndexFieldMapping.Builder>... 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.

      This is a convenience method that creates an instance of the DataSourceToIndexFieldMapping.Builder avoiding the need to create one manually via DataSourceToIndexFieldMapping.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to webLinkFieldMappings(List<DataSourceToIndexFieldMapping>).

      Parameters:
      webLinkFieldMappings - a consumer that will call methods on DataSourceToIndexFieldMapping.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • inclusionPatterns

      BoxConfiguration.Builder inclusionPatterns(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.

    • inclusionPatterns

      BoxConfiguration.Builder inclusionPatterns(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.

    • exclusionPatterns

      BoxConfiguration.Builder exclusionPatterns(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.

    • exclusionPatterns

      BoxConfiguration.Builder exclusionPatterns(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.

    • vpcConfiguration

      BoxConfiguration.Builder vpcConfiguration(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.

    • vpcConfiguration

      default BoxConfiguration.Builder vpcConfiguration(Consumer<DataSourceVpcConfiguration.Builder> vpcConfiguration)

      Configuration information for an Amazon VPC to connect to your Box. For more information, see Configuring a VPC.

      This is a convenience method that creates an instance of the DataSourceVpcConfiguration.Builder avoiding the need to create one manually via DataSourceVpcConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to vpcConfiguration(DataSourceVpcConfiguration).

      Parameters:
      vpcConfiguration - a consumer that will call methods on DataSourceVpcConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: