#[non_exhaustive]pub struct JobExecution {
pub job_id: Option<String>,
pub thing_name: Option<String>,
pub status: Option<JobExecutionStatus>,
pub status_details: Option<HashMap<String, String>>,
pub queued_at: i64,
pub started_at: Option<i64>,
pub last_updated_at: i64,
pub approximate_seconds_before_timed_out: Option<i64>,
pub version_number: i64,
pub execution_number: Option<i64>,
pub job_document: Option<String>,
}Expand description
Contains data about a job execution.
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: Option<String>The unique identifier you assigned to this job when it was created.
thing_name: Option<String>The name of the thing that is executing the job.
status: Option<JobExecutionStatus>The status of the job execution. Can be one of: "QUEUED", "IN_PROGRESS", "FAILED", "SUCCESS", "CANCELED", "TIMED_OUT", "REJECTED", or "REMOVED".
status_details: Option<HashMap<String, String>>A collection of name/value pairs that describe the status of the job execution.
The maximum length of the value in the name/value pair is 1,024 characters.
queued_at: i64The time, in seconds since the epoch, when the job execution was enqueued.
started_at: Option<i64>The time, in seconds since the epoch, when the job execution was started.
last_updated_at: i64The time, in seconds since the epoch, when the job execution was last updated.
approximate_seconds_before_timed_out: Option<i64>The estimated number of seconds that remain before the job execution status will be changed to TIMED_OUT. The actual job execution timeout can occur up to 60 seconds later than the estimated duration.
version_number: i64The version of the job execution. Job execution versions are incremented each time they are updated by a device.
execution_number: Option<i64>A number that identifies a particular job execution on a particular device. It can be used later in commands that return or update job execution information.
job_document: Option<String>The content of the job document.
Implementations§
Source§impl JobExecution
impl JobExecution
Sourcepub fn job_id(&self) -> Option<&str>
pub fn job_id(&self) -> Option<&str>
The unique identifier you assigned to this job when it was created.
Sourcepub fn thing_name(&self) -> Option<&str>
pub fn thing_name(&self) -> Option<&str>
The name of the thing that is executing the job.
Sourcepub fn status(&self) -> Option<&JobExecutionStatus>
pub fn status(&self) -> Option<&JobExecutionStatus>
The status of the job execution. Can be one of: "QUEUED", "IN_PROGRESS", "FAILED", "SUCCESS", "CANCELED", "TIMED_OUT", "REJECTED", or "REMOVED".
Sourcepub fn status_details(&self) -> Option<&HashMap<String, String>>
pub fn status_details(&self) -> Option<&HashMap<String, String>>
A collection of name/value pairs that describe the status of the job execution.
The maximum length of the value in the name/value pair is 1,024 characters.
Sourcepub fn queued_at(&self) -> i64
pub fn queued_at(&self) -> i64
The time, in seconds since the epoch, when the job execution was enqueued.
Sourcepub fn started_at(&self) -> Option<i64>
pub fn started_at(&self) -> Option<i64>
The time, in seconds since the epoch, when the job execution was started.
Sourcepub fn last_updated_at(&self) -> i64
pub fn last_updated_at(&self) -> i64
The time, in seconds since the epoch, when the job execution was last updated.
Sourcepub fn approximate_seconds_before_timed_out(&self) -> Option<i64>
pub fn approximate_seconds_before_timed_out(&self) -> Option<i64>
The estimated number of seconds that remain before the job execution status will be changed to TIMED_OUT. The actual job execution timeout can occur up to 60 seconds later than the estimated duration.
Sourcepub fn version_number(&self) -> i64
pub fn version_number(&self) -> i64
The version of the job execution. Job execution versions are incremented each time they are updated by a device.
Sourcepub fn execution_number(&self) -> Option<i64>
pub fn execution_number(&self) -> Option<i64>
A number that identifies a particular job execution on a particular device. It can be used later in commands that return or update job execution information.
Sourcepub fn job_document(&self) -> Option<&str>
pub fn job_document(&self) -> Option<&str>
The content of the job document.
Source§impl JobExecution
impl JobExecution
Sourcepub fn builder() -> JobExecutionBuilder
pub fn builder() -> JobExecutionBuilder
Creates a new builder-style object to manufacture JobExecution.
Trait Implementations§
Source§impl Clone for JobExecution
impl Clone for JobExecution
Source§fn clone(&self) -> JobExecution
fn clone(&self) -> JobExecution
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for JobExecution
impl Debug for JobExecution
Source§impl PartialEq for JobExecution
impl PartialEq for JobExecution
impl StructuralPartialEq for JobExecution
Auto Trait Implementations§
impl Freeze for JobExecution
impl RefUnwindSafe for JobExecution
impl Send for JobExecution
impl Sync for JobExecution
impl Unpin for JobExecution
impl UnwindSafe for JobExecution
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);