#[non_exhaustive]pub struct MediaAnalysisJobDescription {
pub job_id: String,
pub job_name: Option<String>,
pub operations_config: Option<MediaAnalysisOperationsConfig>,
pub status: MediaAnalysisJobStatus,
pub failure_details: Option<MediaAnalysisJobFailureDetails>,
pub creation_timestamp: DateTime,
pub completion_timestamp: Option<DateTime>,
pub input: Option<MediaAnalysisInput>,
pub output_config: Option<MediaAnalysisOutputConfig>,
pub kms_key_id: Option<String>,
pub results: Option<MediaAnalysisResults>,
pub manifest_summary: Option<MediaAnalysisManifestSummary>,
}
Expand description
Description for a media analysis 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.job_id: String
The identifier for a media analysis job.
job_name: Option<String>
The name of a media analysis job.
operations_config: Option<MediaAnalysisOperationsConfig>
Operation configurations that were provided during job creation.
status: MediaAnalysisJobStatus
The status of the media analysis job being retrieved.
failure_details: Option<MediaAnalysisJobFailureDetails>
Details about the error that resulted in failure of the job.
creation_timestamp: DateTime
The Unix date and time when the job was started.
completion_timestamp: Option<DateTime>
The Unix date and time when the job finished.
input: Option<MediaAnalysisInput>
Reference to the input manifest that was provided in the job creation request.
output_config: Option<MediaAnalysisOutputConfig>
Output configuration that was provided in the creation request.
kms_key_id: Option<String>
KMS Key that was provided in the creation request.
results: Option<MediaAnalysisResults>
Output manifest that contains prediction results.
manifest_summary: Option<MediaAnalysisManifestSummary>
Provides statistics on input manifest and errors identified in the input manifest.
Implementations§
Source§impl MediaAnalysisJobDescription
impl MediaAnalysisJobDescription
Sourcepub fn operations_config(&self) -> Option<&MediaAnalysisOperationsConfig>
pub fn operations_config(&self) -> Option<&MediaAnalysisOperationsConfig>
Operation configurations that were provided during job creation.
Sourcepub fn status(&self) -> &MediaAnalysisJobStatus
pub fn status(&self) -> &MediaAnalysisJobStatus
The status of the media analysis job being retrieved.
Sourcepub fn failure_details(&self) -> Option<&MediaAnalysisJobFailureDetails>
pub fn failure_details(&self) -> Option<&MediaAnalysisJobFailureDetails>
Details about the error that resulted in failure of the job.
Sourcepub fn creation_timestamp(&self) -> &DateTime
pub fn creation_timestamp(&self) -> &DateTime
The Unix date and time when the job was started.
Sourcepub fn completion_timestamp(&self) -> Option<&DateTime>
pub fn completion_timestamp(&self) -> Option<&DateTime>
The Unix date and time when the job finished.
Sourcepub fn input(&self) -> Option<&MediaAnalysisInput>
pub fn input(&self) -> Option<&MediaAnalysisInput>
Reference to the input manifest that was provided in the job creation request.
Sourcepub fn output_config(&self) -> Option<&MediaAnalysisOutputConfig>
pub fn output_config(&self) -> Option<&MediaAnalysisOutputConfig>
Output configuration that was provided in the creation request.
Sourcepub fn kms_key_id(&self) -> Option<&str>
pub fn kms_key_id(&self) -> Option<&str>
KMS Key that was provided in the creation request.
Sourcepub fn results(&self) -> Option<&MediaAnalysisResults>
pub fn results(&self) -> Option<&MediaAnalysisResults>
Output manifest that contains prediction results.
Sourcepub fn manifest_summary(&self) -> Option<&MediaAnalysisManifestSummary>
pub fn manifest_summary(&self) -> Option<&MediaAnalysisManifestSummary>
Provides statistics on input manifest and errors identified in the input manifest.
Source§impl MediaAnalysisJobDescription
impl MediaAnalysisJobDescription
Sourcepub fn builder() -> MediaAnalysisJobDescriptionBuilder
pub fn builder() -> MediaAnalysisJobDescriptionBuilder
Creates a new builder-style object to manufacture MediaAnalysisJobDescription
.
Trait Implementations§
Source§impl Clone for MediaAnalysisJobDescription
impl Clone for MediaAnalysisJobDescription
Source§fn clone(&self) -> MediaAnalysisJobDescription
fn clone(&self) -> MediaAnalysisJobDescription
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for MediaAnalysisJobDescription
impl Debug for MediaAnalysisJobDescription
impl StructuralPartialEq for MediaAnalysisJobDescription
Auto Trait Implementations§
impl Freeze for MediaAnalysisJobDescription
impl RefUnwindSafe for MediaAnalysisJobDescription
impl Send for MediaAnalysisJobDescription
impl Sync for MediaAnalysisJobDescription
impl Unpin for MediaAnalysisJobDescription
impl UnwindSafe for MediaAnalysisJobDescription
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);