JiraConfiguration (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.services.kendra.model.JiraConfiguration

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<JiraConfiguration.Builder,JiraConfiguration>
```
@Generated(value="software.amazon.awssdk:codegen")
public final class JiraConfiguration
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<JiraConfiguration.Builder,JiraConfiguration>
```
Provides the configuration information to connect to Jira as your data source.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface JiraConfiguration.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`JiraConfiguration.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`List<DataSourceToIndexFieldMapping>`	`attachmentFieldMappings()` A list of `DataSourceToIndexFieldMapping` objects that map attributes or field names of Jira attachments to Amazon Kendra index field names.
`static JiraConfiguration.Builder`	`builder()`
`List<DataSourceToIndexFieldMapping>`	`commentFieldMappings()` A list of `DataSourceToIndexFieldMapping` objects that map attributes or field names of Jira comments to Amazon Kendra index field names.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`List<String>`	`exclusionPatterns()` A list of regular expression patterns to exclude certain file paths, file names, and file types in your Jira data source.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasAttachmentFieldMappings()` For responses, this returns true if the service returned a value for the AttachmentFieldMappings property.
`boolean`	`hasCommentFieldMappings()` For responses, this returns true if the service returned a value for the CommentFieldMappings property.
`boolean`	`hasExclusionPatterns()` For responses, this returns true if the service returned a value for the ExclusionPatterns property.
`int`	`hashCode()`
`boolean`	`hasInclusionPatterns()` For responses, this returns true if the service returned a value for the InclusionPatterns property.
`boolean`	`hasIssueFieldMappings()` For responses, this returns true if the service returned a value for the IssueFieldMappings property.
`boolean`	`hasIssueSubEntityFilter()` For responses, this returns true if the service returned a value for the IssueSubEntityFilter property.
`boolean`	`hasIssueType()` For responses, this returns true if the service returned a value for the IssueType property.
`boolean`	`hasProject()` For responses, this returns true if the service returned a value for the Project property.
`boolean`	`hasProjectFieldMappings()` For responses, this returns true if the service returned a value for the ProjectFieldMappings property.
`boolean`	`hasStatus()` For responses, this returns true if the service returned a value for the Status property.
`boolean`	`hasWorkLogFieldMappings()` For responses, this returns true if the service returned a value for the WorkLogFieldMappings property.
`List<String>`	`inclusionPatterns()` A list of regular expression patterns to include certain file paths, file names, and file types in your Jira data source.
`List<DataSourceToIndexFieldMapping>`	`issueFieldMappings()` A list of `DataSourceToIndexFieldMapping` objects that map attributes or field names of Jira issues to Amazon Kendra index field names.
`List<IssueSubEntity>`	`issueSubEntityFilter()` Specify whether to crawl comments, attachments, and work logs.
`List<String>`	`issueSubEntityFilterAsStrings()` Specify whether to crawl comments, attachments, and work logs.
`List<String>`	`issueType()` Specify which issue types to crawl in your Jira data source.
`String`	`jiraAccountUrl()` The URL of the Jira account.
`List<String>`	`project()` Specify which projects to crawl in your Jira data source.
`List<DataSourceToIndexFieldMapping>`	`projectFieldMappings()` A list of `DataSourceToIndexFieldMapping` objects that map attributes or field names of Jira projects to Amazon Kendra index field names.
`List<SdkField<?>>`	`sdkFields()`
`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.
`static Class<? extends JiraConfiguration.Builder>`	`serializableBuilderClass()`
`List<String>`	`status()` Specify which statuses to crawl in your Jira data source.
`JiraConfiguration.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`Boolean`	`useChangeLog()` `TRUE` to use the Jira change log to determine which documents require updating in the index.
`DataSourceVpcConfiguration`	`vpcConfiguration()` Configuration information for an Amazon Virtual Private Cloud to connect to your Jira.
`List<DataSourceToIndexFieldMapping>`	`workLogFieldMappings()` A list of `DataSourceToIndexFieldMapping` objects that map attributes or field names of Jira work logs to Amazon Kendra index field names.

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - jiraAccountUrl
```
public final String jiraAccountUrl()
```
    The URL of the Jira account. For example, company.atlassian.net.
    
    Returns:
    
    The URL of the Jira account. For example, company.atlassian.net.
  - secretArn
```
public final 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.
    Returns:
    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.
  - useChangeLog
```
public final 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.
    
    Returns:
    
    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.
  - hasProject
```
public final boolean hasProject()
```
    For responses, this returns true if the service returned a value for the Project property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - project
```
public final List<String> project()
```
    Specify which projects to crawl in your Jira data source. You can specify one or more Jira project IDs.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasProject() method.
    
    Returns:
    
    Specify which projects to crawl in your Jira data source. You can specify one or more Jira project IDs.
  - hasIssueType
```
public final boolean hasIssueType()
```
    For responses, this returns true if the service returned a value for the IssueType property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - issueType
```
public final List<String> issueType()
```
    Specify which issue types to crawl in your Jira data source. You can specify one or more of these options to crawl.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasIssueType() method.
    
    Returns:
    
    Specify which issue types to crawl in your Jira data source. You can specify one or more of these options to crawl.
  - hasStatus
```
public final boolean hasStatus()
```
    For responses, this returns true if the service returned a value for the Status property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - status
```
public final List<String> status()
```
    Specify which statuses to crawl in your Jira data source. You can specify one or more of these options to crawl.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasStatus() method.
    
    Returns:
    
    Specify which statuses to crawl in your Jira data source. You can specify one or more of these options to crawl.
  - issueSubEntityFilter
```
public final List<IssueSubEntity> issueSubEntityFilter()
```
    Specify whether to crawl comments, attachments, and work logs. You can specify one or more of these options.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasIssueSubEntityFilter() method.
    
    Returns:
    
    Specify whether to crawl comments, attachments, and work logs. You can specify one or more of these options.
  - hasIssueSubEntityFilter
```
public final boolean hasIssueSubEntityFilter()
```
    For responses, this returns true if the service returned a value for the IssueSubEntityFilter property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - issueSubEntityFilterAsStrings
```
public final List<String> issueSubEntityFilterAsStrings()
```
    Specify whether to crawl comments, attachments, and work logs. You can specify one or more of these options.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasIssueSubEntityFilter() method.
    
    Returns:
    
    Specify whether to crawl comments, attachments, and work logs. You can specify one or more of these options.
  - hasAttachmentFieldMappings
```
public final boolean hasAttachmentFieldMappings()
```
    For responses, this returns true if the service returned a value for the AttachmentFieldMappings property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - attachmentFieldMappings
```
public final List<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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAttachmentFieldMappings() method.
    
    Returns:
    
    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.
  - hasCommentFieldMappings
```
public final boolean hasCommentFieldMappings()
```
    For responses, this returns true if the service returned a value for the CommentFieldMappings property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - commentFieldMappings
```
public final List<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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasCommentFieldMappings() method.
    
    Returns:
    
    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.
  - hasIssueFieldMappings
```
public final boolean hasIssueFieldMappings()
```
    For responses, this returns true if the service returned a value for the IssueFieldMappings property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - issueFieldMappings
```
public final List<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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasIssueFieldMappings() method.
    
    Returns:
    
    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.
  - hasProjectFieldMappings
```
public final boolean hasProjectFieldMappings()
```
    For responses, this returns true if the service returned a value for the ProjectFieldMappings property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - projectFieldMappings
```
public final List<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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasProjectFieldMappings() method.
    
    Returns:
    
    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.
  - hasWorkLogFieldMappings
```
public final boolean hasWorkLogFieldMappings()
```
    For responses, this returns true if the service returned a value for the WorkLogFieldMappings property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - workLogFieldMappings
```
public final List<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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasWorkLogFieldMappings() method.
    
    Returns:
    
    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.
  - hasInclusionPatterns
```
public final boolean hasInclusionPatterns()
```
    For responses, this returns true if the service returned a value for the InclusionPatterns property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - inclusionPatterns
```
public final List<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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasInclusionPatterns() method.
    
    Returns:
    
    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.
  - hasExclusionPatterns
```
public final boolean hasExclusionPatterns()
```
    For responses, this returns true if the service returned a value for the ExclusionPatterns property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - exclusionPatterns
```
public final List<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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasExclusionPatterns() method.
    
    Returns:
    
    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.
  - vpcConfiguration
```
public final DataSourceVpcConfiguration vpcConfiguration()
```
    Configuration information for an Amazon Virtual Private Cloud to connect to your Jira. For more information, see Configuring a VPC.
    
    Returns:
    
    Configuration information for an Amazon Virtual Private Cloud to connect to your Jira. For more information, see Configuring a VPC.
  - toBuilder
```
public JiraConfiguration.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<JiraConfiguration.Builder,JiraConfiguration>
  - builder
```
public static JiraConfiguration.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends JiraConfiguration.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final 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
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class JiraConfiguration

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

jiraAccountUrl

secretArn

useChangeLog

hasProject

project

hasIssueType

issueType

hasStatus

status

issueSubEntityFilter

hasIssueSubEntityFilter

issueSubEntityFilterAsStrings

hasAttachmentFieldMappings

attachmentFieldMappings

hasCommentFieldMappings

commentFieldMappings

hasIssueFieldMappings

issueFieldMappings

hasProjectFieldMappings

projectFieldMappings

hasWorkLogFieldMappings

workLogFieldMappings

hasInclusionPatterns

inclusionPatterns

hasExclusionPatterns

exclusionPatterns

vpcConfiguration

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields