#[non_exhaustive]pub struct JiraConfiguration {Show 15 fields
pub jira_account_url: String,
pub secret_arn: String,
pub use_change_log: bool,
pub project: Option<Vec<String>>,
pub issue_type: Option<Vec<String>>,
pub status: Option<Vec<String>>,
pub issue_sub_entity_filter: Option<Vec<IssueSubEntity>>,
pub attachment_field_mappings: Option<Vec<DataSourceToIndexFieldMapping>>,
pub comment_field_mappings: Option<Vec<DataSourceToIndexFieldMapping>>,
pub issue_field_mappings: Option<Vec<DataSourceToIndexFieldMapping>>,
pub project_field_mappings: Option<Vec<DataSourceToIndexFieldMapping>>,
pub work_log_field_mappings: Option<Vec<DataSourceToIndexFieldMapping>>,
pub inclusion_patterns: Option<Vec<String>>,
pub exclusion_patterns: Option<Vec<String>>,
pub vpc_configuration: Option<DataSourceVpcConfiguration>,
}Expand description
Provides the configuration information to connect to Jira as your data source.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.jira_account_url: StringThe URL of the Jira account. For example, company.atlassian.net.
secret_arn: StringThe 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.
use_change_log: boolTRUE 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.
project: Option<Vec<String>>Specify which projects to crawl in your Jira data source. You can specify one or more Jira project IDs.
issue_type: Option<Vec<String>>Specify which issue types to crawl in your Jira data source. You can specify one or more of these options to crawl.
status: Option<Vec<String>>Specify which statuses to crawl in your Jira data source. You can specify one or more of these options to crawl.
issue_sub_entity_filter: Option<Vec<IssueSubEntity>>Specify whether to crawl comments, attachments, and work logs. You can specify one or more of these options.
attachment_field_mappings: Option<Vec<DataSourceToIndexFieldMapping>>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.
comment_field_mappings: Option<Vec<DataSourceToIndexFieldMapping>>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.
issue_field_mappings: Option<Vec<DataSourceToIndexFieldMapping>>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.
project_field_mappings: Option<Vec<DataSourceToIndexFieldMapping>>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.
work_log_field_mappings: Option<Vec<DataSourceToIndexFieldMapping>>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.
inclusion_patterns: Option<Vec<String>>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.
exclusion_patterns: Option<Vec<String>>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.
vpc_configuration: Option<DataSourceVpcConfiguration>Configuration information for an Amazon Virtual Private Cloud to connect to your Jira. For more information, see Configuring a VPC.
Implementations§
Source§impl JiraConfiguration
impl JiraConfiguration
Sourcepub fn jira_account_url(&self) -> &str
pub fn jira_account_url(&self) -> &str
The URL of the Jira account. For example, company.atlassian.net.
Sourcepub fn secret_arn(&self) -> &str
pub fn secret_arn(&self) -> &str
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.
Sourcepub fn use_change_log(&self) -> bool
pub fn use_change_log(&self) -> bool
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.
Sourcepub fn project(&self) -> &[String]
pub fn project(&self) -> &[String]
Specify which projects to crawl in your Jira data source. You can specify one or more Jira project IDs.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .project.is_none().
Sourcepub fn issue_type(&self) -> &[String]
pub fn issue_type(&self) -> &[String]
Specify which issue types to crawl in your Jira data source. You can specify one or more of these options to crawl.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .issue_type.is_none().
Sourcepub fn status(&self) -> &[String]
pub fn status(&self) -> &[String]
Specify which statuses to crawl in your Jira data source. You can specify one or more of these options to crawl.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .status.is_none().
Sourcepub fn issue_sub_entity_filter(&self) -> &[IssueSubEntity]
pub fn issue_sub_entity_filter(&self) -> &[IssueSubEntity]
Specify whether to crawl comments, attachments, and work logs. You can specify one or more of these options.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .issue_sub_entity_filter.is_none().
Sourcepub fn attachment_field_mappings(&self) -> &[DataSourceToIndexFieldMapping]
pub fn attachment_field_mappings(&self) -> &[DataSourceToIndexFieldMapping]
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.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .attachment_field_mappings.is_none().
Sourcepub fn comment_field_mappings(&self) -> &[DataSourceToIndexFieldMapping]
pub fn comment_field_mappings(&self) -> &[DataSourceToIndexFieldMapping]
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.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .comment_field_mappings.is_none().
Sourcepub fn issue_field_mappings(&self) -> &[DataSourceToIndexFieldMapping]
pub fn issue_field_mappings(&self) -> &[DataSourceToIndexFieldMapping]
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.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .issue_field_mappings.is_none().
Sourcepub fn project_field_mappings(&self) -> &[DataSourceToIndexFieldMapping]
pub fn project_field_mappings(&self) -> &[DataSourceToIndexFieldMapping]
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.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .project_field_mappings.is_none().
Sourcepub fn work_log_field_mappings(&self) -> &[DataSourceToIndexFieldMapping]
pub fn work_log_field_mappings(&self) -> &[DataSourceToIndexFieldMapping]
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.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .work_log_field_mappings.is_none().
Sourcepub fn inclusion_patterns(&self) -> &[String]
pub fn inclusion_patterns(&self) -> &[String]
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.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .inclusion_patterns.is_none().
Sourcepub fn exclusion_patterns(&self) -> &[String]
pub fn exclusion_patterns(&self) -> &[String]
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.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .exclusion_patterns.is_none().
Sourcepub fn vpc_configuration(&self) -> Option<&DataSourceVpcConfiguration>
pub fn vpc_configuration(&self) -> Option<&DataSourceVpcConfiguration>
Configuration information for an Amazon Virtual Private Cloud to connect to your Jira. For more information, see Configuring a VPC.
Source§impl JiraConfiguration
impl JiraConfiguration
Sourcepub fn builder() -> JiraConfigurationBuilder
pub fn builder() -> JiraConfigurationBuilder
Creates a new builder-style object to manufacture JiraConfiguration.
Trait Implementations§
Source§impl Clone for JiraConfiguration
impl Clone for JiraConfiguration
Source§fn clone(&self) -> JiraConfiguration
fn clone(&self) -> JiraConfiguration
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for JiraConfiguration
impl Debug for JiraConfiguration
Source§impl PartialEq for JiraConfiguration
impl PartialEq for JiraConfiguration
impl StructuralPartialEq for JiraConfiguration
Auto Trait Implementations§
impl Freeze for JiraConfiguration
impl RefUnwindSafe for JiraConfiguration
impl Send for JiraConfiguration
impl Sync for JiraConfiguration
impl Unpin for JiraConfiguration
impl UnwindSafe for JiraConfiguration
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);