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

Interface SlackConfiguration.Builder

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

  • Method Details

    • teamId

      SlackConfiguration.Builder teamId(String teamId)

      The identifier of the team in the Slack workspace. For example, T0123456789.

      You can find your team ID in the URL of the main page of your Slack workspace. When you log in to Slack via a browser, you are directed to the URL of the main page. For example, https://app.slack.com/client/T0123456789/....

      Parameters:
      teamId - The identifier of the team in the Slack workspace. For example, T0123456789.

      You can find your team ID in the URL of the main page of your Slack workspace. When you log in to Slack via a browser, you are directed to the URL of the main page. For example, https://app.slack.com/client/T0123456789/....

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • secretArn

      SlackConfiguration.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 Slack workspace team. The secret must contain a JSON structure with the following keys:

      Parameters:
      secretArn - The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the key-value pairs required to connect to your Slack workspace team. The secret must contain a JSON structure with the following keys:

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • vpcConfiguration

      SlackConfiguration.Builder vpcConfiguration(DataSourceVpcConfiguration vpcConfiguration)

      Configuration information for an Amazon Virtual Private Cloud to connect to your Slack. For more information, see Configuring a VPC.

      Parameters:
      vpcConfiguration - Configuration information for an Amazon Virtual Private Cloud to connect to your Slack. For more information, see Configuring a VPC.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • vpcConfiguration

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

      Configuration information for an Amazon Virtual Private Cloud to connect to your Slack. 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:

    • slackEntityListWithStrings

      SlackConfiguration.Builder slackEntityListWithStrings(Collection<String> slackEntityList)

      Specify whether to index public channels, private channels, group messages, and direct messages. You can specify one or more of these options.

      Parameters:
      slackEntityList - Specify whether to index public channels, private channels, group messages, and direct messages. You can specify one or more of these options.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • slackEntityListWithStrings

      SlackConfiguration.Builder slackEntityListWithStrings(String... slackEntityList)

      Specify whether to index public channels, private channels, group messages, and direct messages. You can specify one or more of these options.

      Parameters:
      slackEntityList - Specify whether to index public channels, private channels, group messages, and direct messages. You can specify one or more of these options.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • slackEntityList

      SlackConfiguration.Builder slackEntityList(Collection<SlackEntity> slackEntityList)

      Specify whether to index public channels, private channels, group messages, and direct messages. You can specify one or more of these options.

      Parameters:
      slackEntityList - Specify whether to index public channels, private channels, group messages, and direct messages. You can specify one or more of these options.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • slackEntityList

      SlackConfiguration.Builder slackEntityList(SlackEntity... slackEntityList)

      Specify whether to index public channels, private channels, group messages, and direct messages. You can specify one or more of these options.

      Parameters:
      slackEntityList - Specify whether to index public channels, private channels, group messages, and direct messages. You can specify one or more of these options.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • useChangeLog

      SlackConfiguration.Builder useChangeLog(Boolean useChangeLog)

      TRUE to use the Slack change log to determine which documents require updating in the index. Depending on the Slack change log's size, it may take longer for Amazon Kendra to use the change log than to scan all of your documents in Slack.

      Parameters:
      useChangeLog - TRUE to use the Slack change log to determine which documents require updating in the index. Depending on the Slack change log's size, it may take longer for Amazon Kendra to use the change log than to scan all of your documents in Slack.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • crawlBotMessage

      SlackConfiguration.Builder crawlBotMessage(Boolean crawlBotMessage)

      TRUE to index bot messages from your Slack workspace team.

      Parameters:
      crawlBotMessage - TRUE to index bot messages from your Slack workspace team.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • excludeArchived

      SlackConfiguration.Builder excludeArchived(Boolean excludeArchived)

      TRUE to exclude archived messages to index from your Slack workspace team.

      Parameters:
      excludeArchived - TRUE to exclude archived messages to index from your Slack workspace team.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sinceCrawlDate

      SlackConfiguration.Builder sinceCrawlDate(String sinceCrawlDate)

      The date to start crawling your data from your Slack workspace team. The date must follow this format: yyyy-mm-dd.

      Parameters:
      sinceCrawlDate - The date to start crawling your data from your Slack workspace team. The date must follow this format: yyyy-mm-dd.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • lookBackPeriod

      SlackConfiguration.Builder lookBackPeriod(Integer lookBackPeriod)

      The number of hours for change log to look back from when you last synchronized your data. You can look back up to 7 days or 168 hours.

      Change log updates your index only if new content was added since you last synced your data. Updated or deleted content from before you last synced does not get updated in your index. To capture updated or deleted content before you last synced, set the LookBackPeriod to the number of hours you want change log to look back.

      Parameters:
      lookBackPeriod - The number of hours for change log to look back from when you last synchronized your data. You can look back up to 7 days or 168 hours.

      Change log updates your index only if new content was added since you last synced your data. Updated or deleted content from before you last synced does not get updated in your index. To capture updated or deleted content before you last synced, set the LookBackPeriod to the number of hours you want change log to look back.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • privateChannelFilter

      SlackConfiguration.Builder privateChannelFilter(Collection<String> privateChannelFilter)

      The list of private channel names from your Slack workspace team. You use this if you want to index specific private channels, not all private channels. You can also use regular expression patterns to filter private channels.

      Parameters:
      privateChannelFilter - The list of private channel names from your Slack workspace team. You use this if you want to index specific private channels, not all private channels. You can also use regular expression patterns to filter private channels.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • privateChannelFilter

      SlackConfiguration.Builder privateChannelFilter(String... privateChannelFilter)

      The list of private channel names from your Slack workspace team. You use this if you want to index specific private channels, not all private channels. You can also use regular expression patterns to filter private channels.

      Parameters:
      privateChannelFilter - The list of private channel names from your Slack workspace team. You use this if you want to index specific private channels, not all private channels. You can also use regular expression patterns to filter private channels.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • publicChannelFilter

      SlackConfiguration.Builder publicChannelFilter(Collection<String> publicChannelFilter)

      The list of public channel names to index from your Slack workspace team. You use this if you want to index specific public channels, not all public channels. You can also use regular expression patterns to filter public channels.

      Parameters:
      publicChannelFilter - The list of public channel names to index from your Slack workspace team. You use this if you want to index specific public channels, not all public channels. You can also use regular expression patterns to filter public channels.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • publicChannelFilter

      SlackConfiguration.Builder publicChannelFilter(String... publicChannelFilter)

      The list of public channel names to index from your Slack workspace team. You use this if you want to index specific public channels, not all public channels. You can also use regular expression patterns to filter public channels.

      Parameters:
      publicChannelFilter - The list of public channel names to index from your Slack workspace team. You use this if you want to index specific public channels, not all public channels. You can also use regular expression patterns to filter public channels.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • inclusionPatterns

      SlackConfiguration.Builder inclusionPatterns(Collection<String> inclusionPatterns)

      A list of regular expression patterns to include certain attached files in your Slack workspace team. Files that match the patterns are included in the index. Files that don't match the patterns are excluded from the index. If a file matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the file isn't included in the index.

      Parameters:
      inclusionPatterns - A list of regular expression patterns to include certain attached files in your Slack workspace team. Files that match the patterns are included in the index. Files that don't match the patterns are excluded from the index. If a file matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the file isn't included in the index.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • inclusionPatterns

      SlackConfiguration.Builder inclusionPatterns(String... inclusionPatterns)

      A list of regular expression patterns to include certain attached files in your Slack workspace team. Files that match the patterns are included in the index. Files that don't match the patterns are excluded from the index. If a file matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the file isn't included in the index.

      Parameters:
      inclusionPatterns - A list of regular expression patterns to include certain attached files in your Slack workspace team. Files that match the patterns are included in the index. Files that don't match the patterns are excluded from the index. If a file matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the file isn't included in the index.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • exclusionPatterns

      SlackConfiguration.Builder exclusionPatterns(Collection<String> exclusionPatterns)

      A list of regular expression patterns to exclude certain attached files in your Slack workspace team. Files that match the patterns are excluded from the index. Files that don’t match the patterns are included in the index. If a file matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the file isn't included in the index.

      Parameters:
      exclusionPatterns - A list of regular expression patterns to exclude certain attached files in your Slack workspace team. Files that match the patterns are excluded from the index. Files that don’t match the patterns are included in the index. If a file matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the file isn't included in the index.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • exclusionPatterns

      SlackConfiguration.Builder exclusionPatterns(String... exclusionPatterns)

      A list of regular expression patterns to exclude certain attached files in your Slack workspace team. Files that match the patterns are excluded from the index. Files that don’t match the patterns are included in the index. If a file matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the file isn't included in the index.

      Parameters:
      exclusionPatterns - A list of regular expression patterns to exclude certain attached files in your Slack workspace team. Files that match the patterns are excluded from the index. Files that don’t match the patterns are included in the index. If a file matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the file isn't included in the index.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • fieldMappings

      SlackConfiguration.Builder fieldMappings(Collection<DataSourceToIndexFieldMapping> fieldMappings)

      A list of DataSourceToIndexFieldMapping objects that map Slack data source attributes or field names to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Slack fields. For more information, see Mapping data source fields. The Slack data source field names must exist in your Slack custom metadata.

      Parameters:
      fieldMappings - A list of DataSourceToIndexFieldMapping objects that map Slack data source attributes or field names to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Slack fields. For more information, see Mapping data source fields. The Slack data source field names must exist in your Slack custom metadata.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • fieldMappings

      SlackConfiguration.Builder fieldMappings(DataSourceToIndexFieldMapping... fieldMappings)

      A list of DataSourceToIndexFieldMapping objects that map Slack data source attributes or field names to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Slack fields. For more information, see Mapping data source fields. The Slack data source field names must exist in your Slack custom metadata.

      Parameters:
      fieldMappings - A list of DataSourceToIndexFieldMapping objects that map Slack data source attributes or field names to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Slack fields. For more information, see Mapping data source fields. The Slack data source field names must exist in your Slack custom metadata.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • fieldMappings

      SlackConfiguration.Builder fieldMappings(Consumer<DataSourceToIndexFieldMapping.Builder>... fieldMappings)

      A list of DataSourceToIndexFieldMapping objects that map Slack data source attributes or field names to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Slack fields. For more information, see Mapping data source fields. The Slack data source field names must exist in your Slack 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 fieldMappings(List<DataSourceToIndexFieldMapping>).

      Parameters:
      fieldMappings - 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: