#[non_exhaustive]pub struct DescribeDataSourceOutput {Show 15 fields
pub id: Option<String>,
pub index_id: Option<String>,
pub name: Option<String>,
pub type: Option<DataSourceType>,
pub configuration: Option<DataSourceConfiguration>,
pub vpc_configuration: Option<DataSourceVpcConfiguration>,
pub created_at: Option<DateTime>,
pub updated_at: Option<DateTime>,
pub description: Option<String>,
pub status: Option<DataSourceStatus>,
pub schedule: Option<String>,
pub role_arn: Option<String>,
pub error_message: Option<String>,
pub language_code: Option<String>,
pub custom_document_enrichment_configuration: Option<CustomDocumentEnrichmentConfiguration>,
/* private fields */
}
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.id: Option<String>
The identifier of the data source connector.
index_id: Option<String>
The identifier of the index used with the data source connector.
name: Option<String>
The name for the data source connector.
type: Option<DataSourceType>
The type of the data source. For example, SHAREPOINT
.
configuration: Option<DataSourceConfiguration>
Configuration details for the data source connector. This shows how the data source is configured. The configuration options for a data source depend on the data source provider.
vpc_configuration: Option<DataSourceVpcConfiguration>
Configuration information for an Amazon Virtual Private Cloud to connect to your data source. For more information, see Configuring a VPC.
created_at: Option<DateTime>
The Unix timestamp when the data source connector was created.
updated_at: Option<DateTime>
The Unix timestamp when the data source connector was last updated.
description: Option<String>
The description for the data source connector.
status: Option<DataSourceStatus>
The current status of the data source connector. When the status is ACTIVE
the data source is ready to use. When the status is FAILED
, the ErrorMessage
field contains the reason that the data source failed.
schedule: Option<String>
The schedule for Amazon Kendra to update the index.
role_arn: Option<String>
The Amazon Resource Name (ARN) of the IAM role with permission to access the data source and required resources.
error_message: Option<String>
When the Status
field value is FAILED
, the ErrorMessage
field contains a description of the error that caused the data source to fail.
language_code: Option<String>
The code for a language. This shows a supported language for all documents in the data source. English is supported by default. For more information on supported languages, including their codes, see Adding documents in languages other than English.
custom_document_enrichment_configuration: Option<CustomDocumentEnrichmentConfiguration>
Configuration information for altering document metadata and content during the document ingestion process when you describe a data source.
For more information on how to create, modify and delete document metadata, or make other content alterations when you ingest documents into Amazon Kendra, see Customizing document metadata during the ingestion process.
Implementations§
Source§impl DescribeDataSourceOutput
impl DescribeDataSourceOutput
Sourcepub fn index_id(&self) -> Option<&str>
pub fn index_id(&self) -> Option<&str>
The identifier of the index used with the data source connector.
Sourcepub fn type(&self) -> Option<&DataSourceType>
pub fn type(&self) -> Option<&DataSourceType>
The type of the data source. For example, SHAREPOINT
.
Sourcepub fn configuration(&self) -> Option<&DataSourceConfiguration>
pub fn configuration(&self) -> Option<&DataSourceConfiguration>
Configuration details for the data source connector. This shows how the data source is configured. The configuration options for a data source depend on the data source provider.
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 data source. For more information, see Configuring a VPC.
Sourcepub fn created_at(&self) -> Option<&DateTime>
pub fn created_at(&self) -> Option<&DateTime>
The Unix timestamp when the data source connector was created.
Sourcepub fn updated_at(&self) -> Option<&DateTime>
pub fn updated_at(&self) -> Option<&DateTime>
The Unix timestamp when the data source connector was last updated.
Sourcepub fn description(&self) -> Option<&str>
pub fn description(&self) -> Option<&str>
The description for the data source connector.
Sourcepub fn status(&self) -> Option<&DataSourceStatus>
pub fn status(&self) -> Option<&DataSourceStatus>
The current status of the data source connector. When the status is ACTIVE
the data source is ready to use. When the status is FAILED
, the ErrorMessage
field contains the reason that the data source failed.
Sourcepub fn role_arn(&self) -> Option<&str>
pub fn role_arn(&self) -> Option<&str>
The Amazon Resource Name (ARN) of the IAM role with permission to access the data source and required resources.
Sourcepub fn error_message(&self) -> Option<&str>
pub fn error_message(&self) -> Option<&str>
When the Status
field value is FAILED
, the ErrorMessage
field contains a description of the error that caused the data source to fail.
Sourcepub fn language_code(&self) -> Option<&str>
pub fn language_code(&self) -> Option<&str>
The code for a language. This shows a supported language for all documents in the data source. English is supported by default. For more information on supported languages, including their codes, see Adding documents in languages other than English.
Sourcepub fn custom_document_enrichment_configuration(
&self,
) -> Option<&CustomDocumentEnrichmentConfiguration>
pub fn custom_document_enrichment_configuration( &self, ) -> Option<&CustomDocumentEnrichmentConfiguration>
Configuration information for altering document metadata and content during the document ingestion process when you describe a data source.
For more information on how to create, modify and delete document metadata, or make other content alterations when you ingest documents into Amazon Kendra, see Customizing document metadata during the ingestion process.
Source§impl DescribeDataSourceOutput
impl DescribeDataSourceOutput
Sourcepub fn builder() -> DescribeDataSourceOutputBuilder
pub fn builder() -> DescribeDataSourceOutputBuilder
Creates a new builder-style object to manufacture DescribeDataSourceOutput
.
Trait Implementations§
Source§impl Clone for DescribeDataSourceOutput
impl Clone for DescribeDataSourceOutput
Source§fn clone(&self) -> DescribeDataSourceOutput
fn clone(&self) -> DescribeDataSourceOutput
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for DescribeDataSourceOutput
impl Debug for DescribeDataSourceOutput
Source§impl PartialEq for DescribeDataSourceOutput
impl PartialEq for DescribeDataSourceOutput
Source§impl RequestId for DescribeDataSourceOutput
impl RequestId for DescribeDataSourceOutput
Source§fn request_id(&self) -> Option<&str>
fn request_id(&self) -> Option<&str>
None
if the service could not be reached.impl StructuralPartialEq for DescribeDataSourceOutput
Auto Trait Implementations§
impl Freeze for DescribeDataSourceOutput
impl RefUnwindSafe for DescribeDataSourceOutput
impl Send for DescribeDataSourceOutput
impl Sync for DescribeDataSourceOutput
impl Unpin for DescribeDataSourceOutput
impl UnwindSafe for DescribeDataSourceOutput
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);