#[non_exhaustive]pub struct DataSourceSyncJob {
pub execution_id: Option<String>,
pub start_time: Option<DateTime>,
pub end_time: Option<DateTime>,
pub status: Option<DataSourceSyncJobStatus>,
pub error: Option<ErrorDetail>,
pub data_source_error_code: Option<String>,
pub metrics: Option<DataSourceSyncJobMetrics>,
}
Expand description
Provides information about an Amazon Q Business data source connector synchronization job.
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.execution_id: Option<String>
The identifier of a data source synchronization job.
start_time: Option<DateTime>
The Unix time stamp when the data source synchronization job started.
end_time: Option<DateTime>
The Unix timestamp when the synchronization job completed.
status: Option<DataSourceSyncJobStatus>
The status of the synchronization job. When the Status
field is set to SUCCEEDED
, the synchronization job is done. If the status code is FAILED
, the ErrorCode
and ErrorMessage
fields give you the reason for the failure.
error: Option<ErrorDetail>
If the Status
field is set to FAILED
, the ErrorCode
field indicates the reason the synchronization failed.
data_source_error_code: Option<String>
If the reason that the synchronization failed is due to an error with the underlying data source, this field contains a code that identifies the error.
metrics: Option<DataSourceSyncJobMetrics>
Maps a batch delete document request to a specific data source sync job. This is optional and should only be supplied when documents are deleted by a data source connector.
Implementations§
Source§impl DataSourceSyncJob
impl DataSourceSyncJob
Sourcepub fn execution_id(&self) -> Option<&str>
pub fn execution_id(&self) -> Option<&str>
The identifier of a data source synchronization job.
Sourcepub fn start_time(&self) -> Option<&DateTime>
pub fn start_time(&self) -> Option<&DateTime>
The Unix time stamp when the data source synchronization job started.
Sourcepub fn end_time(&self) -> Option<&DateTime>
pub fn end_time(&self) -> Option<&DateTime>
The Unix timestamp when the synchronization job completed.
Sourcepub fn status(&self) -> Option<&DataSourceSyncJobStatus>
pub fn status(&self) -> Option<&DataSourceSyncJobStatus>
The status of the synchronization job. When the Status
field is set to SUCCEEDED
, the synchronization job is done. If the status code is FAILED
, the ErrorCode
and ErrorMessage
fields give you the reason for the failure.
Sourcepub fn error(&self) -> Option<&ErrorDetail>
pub fn error(&self) -> Option<&ErrorDetail>
If the Status
field is set to FAILED
, the ErrorCode
field indicates the reason the synchronization failed.
Sourcepub fn data_source_error_code(&self) -> Option<&str>
pub fn data_source_error_code(&self) -> Option<&str>
If the reason that the synchronization failed is due to an error with the underlying data source, this field contains a code that identifies the error.
Sourcepub fn metrics(&self) -> Option<&DataSourceSyncJobMetrics>
pub fn metrics(&self) -> Option<&DataSourceSyncJobMetrics>
Maps a batch delete document request to a specific data source sync job. This is optional and should only be supplied when documents are deleted by a data source connector.
Source§impl DataSourceSyncJob
impl DataSourceSyncJob
Sourcepub fn builder() -> DataSourceSyncJobBuilder
pub fn builder() -> DataSourceSyncJobBuilder
Creates a new builder-style object to manufacture DataSourceSyncJob
.
Trait Implementations§
Source§impl Clone for DataSourceSyncJob
impl Clone for DataSourceSyncJob
Source§fn clone(&self) -> DataSourceSyncJob
fn clone(&self) -> DataSourceSyncJob
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for DataSourceSyncJob
impl Debug for DataSourceSyncJob
Source§impl PartialEq for DataSourceSyncJob
impl PartialEq for DataSourceSyncJob
impl StructuralPartialEq for DataSourceSyncJob
Auto Trait Implementations§
impl Freeze for DataSourceSyncJob
impl RefUnwindSafe for DataSourceSyncJob
impl Send for DataSourceSyncJob
impl Sync for DataSourceSyncJob
impl Unpin for DataSourceSyncJob
impl UnwindSafe for DataSourceSyncJob
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);