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

Interface JiraConfiguration.Builder

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

  • Method Details

    • jiraAccountUrl

      JiraConfiguration.Builder jiraAccountUrl(String jiraAccountUrl)

      The URL of the Jira account. For example, company.atlassian.net.

      Parameters:
      jiraAccountUrl - The URL of the Jira account. For example, company.atlassian.net.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • secretArn

      JiraConfiguration.Builder secretArn(String secretArn)

      The Amazon Resource Name (ARN) of a secret in Secrets Manager contains the key-value pairs required to connect to your Jira data source. The secret must contain a JSON structure with the following keys:

      • jiraId—The Jira user name or email.

      • jiraCredentials—The Jira API token. For more information, see Using a Jira data source.

      Parameters:
      secretArn - The Amazon Resource Name (ARN) of a secret in Secrets Manager contains the key-value pairs required to connect to your Jira data source. The secret must contain a JSON structure with the following keys:

      • jiraId—The Jira user name or email.

      • jiraCredentials—The Jira API token. For more information, see Using a Jira data source.

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

    • useChangeLog

      JiraConfiguration.Builder useChangeLog(Boolean useChangeLog)

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

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

    • project

      JiraConfiguration.Builder project(Collection<String> project)

      Specify which projects to crawl in your Jira data source. You can specify one or more Jira project IDs.

      Parameters:
      project - Specify which projects to crawl in your Jira data source. You can specify one or more Jira project IDs.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • project

      JiraConfiguration.Builder project(String... project)

      Specify which projects to crawl in your Jira data source. You can specify one or more Jira project IDs.

      Parameters:
      project - Specify which projects to crawl in your Jira data source. You can specify one or more Jira project IDs.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • issueType

      JiraConfiguration.Builder issueType(Collection<String> issueType)

      Specify which issue types to crawl in your Jira data source. You can specify one or more of these options to crawl.

      Parameters:
      issueType - Specify which issue types to crawl in your Jira data source. You can specify one or more of these options to crawl.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • issueType

      JiraConfiguration.Builder issueType(String... issueType)

      Specify which issue types to crawl in your Jira data source. You can specify one or more of these options to crawl.

      Parameters:
      issueType - Specify which issue types to crawl in your Jira data source. You can specify one or more of these options to crawl.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • status

      JiraConfiguration.Builder status(Collection<String> status)

      Specify which statuses to crawl in your Jira data source. You can specify one or more of these options to crawl.

      Parameters:
      status - Specify which statuses to crawl in your Jira data source. You can specify one or more of these options to crawl.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • status

      JiraConfiguration.Builder status(String... status)

      Specify which statuses to crawl in your Jira data source. You can specify one or more of these options to crawl.

      Parameters:
      status - Specify which statuses to crawl in your Jira data source. You can specify one or more of these options to crawl.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • issueSubEntityFilterWithStrings

      JiraConfiguration.Builder issueSubEntityFilterWithStrings(Collection<String> issueSubEntityFilter)

      Specify whether to crawl comments, attachments, and work logs. You can specify one or more of these options.

      Parameters:
      issueSubEntityFilter - Specify whether to crawl comments, attachments, and work logs. You can specify one or more of these options.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • issueSubEntityFilterWithStrings

      JiraConfiguration.Builder issueSubEntityFilterWithStrings(String... issueSubEntityFilter)

      Specify whether to crawl comments, attachments, and work logs. You can specify one or more of these options.

      Parameters:
      issueSubEntityFilter - Specify whether to crawl comments, attachments, and work logs. You can specify one or more of these options.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • issueSubEntityFilter

      JiraConfiguration.Builder issueSubEntityFilter(Collection<IssueSubEntity> issueSubEntityFilter)

      Specify whether to crawl comments, attachments, and work logs. You can specify one or more of these options.

      Parameters:
      issueSubEntityFilter - Specify whether to crawl comments, attachments, and work logs. You can specify one or more of these options.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • issueSubEntityFilter

      JiraConfiguration.Builder issueSubEntityFilter(IssueSubEntity... issueSubEntityFilter)

      Specify whether to crawl comments, attachments, and work logs. You can specify one or more of these options.

      Parameters:
      issueSubEntityFilter - Specify whether to crawl comments, attachments, and work logs. You can specify one or more of these options.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • attachmentFieldMappings

      JiraConfiguration.Builder attachmentFieldMappings(Collection<DataSourceToIndexFieldMapping> attachmentFieldMappings)

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

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

    • attachmentFieldMappings

      JiraConfiguration.Builder attachmentFieldMappings(DataSourceToIndexFieldMapping... attachmentFieldMappings)

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

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

    • attachmentFieldMappings

      JiraConfiguration.Builder attachmentFieldMappings(Consumer<DataSourceToIndexFieldMapping.Builder>... attachmentFieldMappings)

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

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

      JiraConfiguration.Builder commentFieldMappings(Collection<DataSourceToIndexFieldMapping> commentFieldMappings)

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

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

    • commentFieldMappings

      JiraConfiguration.Builder commentFieldMappings(DataSourceToIndexFieldMapping... commentFieldMappings)

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

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

    • commentFieldMappings

      JiraConfiguration.Builder commentFieldMappings(Consumer<DataSourceToIndexFieldMapping.Builder>... commentFieldMappings)

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

    • issueFieldMappings

      JiraConfiguration.Builder issueFieldMappings(Collection<DataSourceToIndexFieldMapping> issueFieldMappings)

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

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

    • issueFieldMappings

      JiraConfiguration.Builder issueFieldMappings(DataSourceToIndexFieldMapping... issueFieldMappings)

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

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

    • issueFieldMappings

      JiraConfiguration.Builder issueFieldMappings(Consumer<DataSourceToIndexFieldMapping.Builder>... issueFieldMappings)

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

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

    • projectFieldMappings

      JiraConfiguration.Builder projectFieldMappings(Collection<DataSourceToIndexFieldMapping> projectFieldMappings)

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

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

    • projectFieldMappings

      JiraConfiguration.Builder projectFieldMappings(DataSourceToIndexFieldMapping... projectFieldMappings)

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

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

    • projectFieldMappings

      JiraConfiguration.Builder projectFieldMappings(Consumer<DataSourceToIndexFieldMapping.Builder>... projectFieldMappings)

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

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

    • workLogFieldMappings

      JiraConfiguration.Builder workLogFieldMappings(Collection<DataSourceToIndexFieldMapping> workLogFieldMappings)

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

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

    • workLogFieldMappings

      JiraConfiguration.Builder workLogFieldMappings(DataSourceToIndexFieldMapping... workLogFieldMappings)

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

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

    • workLogFieldMappings

      JiraConfiguration.Builder workLogFieldMappings(Consumer<DataSourceToIndexFieldMapping.Builder>... workLogFieldMappings)

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

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

      JiraConfiguration.Builder inclusionPatterns(Collection<String> inclusionPatterns)

      A list of regular expression patterns to include certain file paths, file names, and file types in your Jira data source. 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 pattern and an 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 file paths, file names, and file types in your Jira data source. 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 pattern and an 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

      JiraConfiguration.Builder inclusionPatterns(String... inclusionPatterns)

      A list of regular expression patterns to include certain file paths, file names, and file types in your Jira data source. 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 pattern and an 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 file paths, file names, and file types in your Jira data source. 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 pattern and an 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

      JiraConfiguration.Builder exclusionPatterns(Collection<String> exclusionPatterns)

      A list of regular expression patterns to exclude certain file paths, file names, and file types in your Jira data source. 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 pattern and an 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 file paths, file names, and file types in your Jira data source. 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 pattern and an 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

      JiraConfiguration.Builder exclusionPatterns(String... exclusionPatterns)

      A list of regular expression patterns to exclude certain file paths, file names, and file types in your Jira data source. 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 pattern and an 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 file paths, file names, and file types in your Jira data source. 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 pattern and an 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.

    • vpcConfiguration

      JiraConfiguration.Builder vpcConfiguration(DataSourceVpcConfiguration vpcConfiguration)

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

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

    • vpcConfiguration

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

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