#[non_exhaustive]pub struct JobSummaryBuilder { /* private fields */ }
Expand description
A builder for JobSummary
.
Implementations§
Source§impl JobSummaryBuilder
impl JobSummaryBuilder
Sourcepub fn set_job_id(self, input: Option<String>) -> Self
pub fn set_job_id(self, input: Option<String>) -> Self
The job ID.
Sourcepub fn get_job_id(&self) -> &Option<String>
pub fn get_job_id(&self) -> &Option<String>
The job ID.
Sourcepub fn lifecycle_status(self, input: JobLifecycleStatus) -> Self
pub fn lifecycle_status(self, input: JobLifecycleStatus) -> Self
The life cycle status.
This field is required.Sourcepub fn set_lifecycle_status(self, input: Option<JobLifecycleStatus>) -> Self
pub fn set_lifecycle_status(self, input: Option<JobLifecycleStatus>) -> Self
The life cycle status.
Sourcepub fn get_lifecycle_status(&self) -> &Option<JobLifecycleStatus>
pub fn get_lifecycle_status(&self) -> &Option<JobLifecycleStatus>
The life cycle status.
Sourcepub fn lifecycle_status_message(self, input: impl Into<String>) -> Self
pub fn lifecycle_status_message(self, input: impl Into<String>) -> Self
The life cycle status message.
This field is required.Sourcepub fn set_lifecycle_status_message(self, input: Option<String>) -> Self
pub fn set_lifecycle_status_message(self, input: Option<String>) -> Self
The life cycle status message.
Sourcepub fn get_lifecycle_status_message(&self) -> &Option<String>
pub fn get_lifecycle_status_message(&self) -> &Option<String>
The life cycle status message.
Sourcepub fn set_priority(self, input: Option<i32>) -> Self
pub fn set_priority(self, input: Option<i32>) -> Self
The job priority.
Sourcepub fn get_priority(&self) -> &Option<i32>
pub fn get_priority(&self) -> &Option<i32>
The job priority.
Sourcepub fn created_at(self, input: DateTime) -> Self
pub fn created_at(self, input: DateTime) -> Self
The date and time the resource was created.
This field is required.Sourcepub fn set_created_at(self, input: Option<DateTime>) -> Self
pub fn set_created_at(self, input: Option<DateTime>) -> Self
The date and time the resource was created.
Sourcepub fn get_created_at(&self) -> &Option<DateTime>
pub fn get_created_at(&self) -> &Option<DateTime>
The date and time the resource was created.
Sourcepub fn created_by(self, input: impl Into<String>) -> Self
pub fn created_by(self, input: impl Into<String>) -> Self
The user or system that created this resource.
This field is required.Sourcepub fn set_created_by(self, input: Option<String>) -> Self
pub fn set_created_by(self, input: Option<String>) -> Self
The user or system that created this resource.
Sourcepub fn get_created_by(&self) -> &Option<String>
pub fn get_created_by(&self) -> &Option<String>
The user or system that created this resource.
Sourcepub fn updated_at(self, input: DateTime) -> Self
pub fn updated_at(self, input: DateTime) -> Self
The date and time the resource was updated.
Sourcepub fn set_updated_at(self, input: Option<DateTime>) -> Self
pub fn set_updated_at(self, input: Option<DateTime>) -> Self
The date and time the resource was updated.
Sourcepub fn get_updated_at(&self) -> &Option<DateTime>
pub fn get_updated_at(&self) -> &Option<DateTime>
The date and time the resource was updated.
Sourcepub fn updated_by(self, input: impl Into<String>) -> Self
pub fn updated_by(self, input: impl Into<String>) -> Self
The user or system that updated this resource.
Sourcepub fn set_updated_by(self, input: Option<String>) -> Self
pub fn set_updated_by(self, input: Option<String>) -> Self
The user or system that updated this resource.
Sourcepub fn get_updated_by(&self) -> &Option<String>
pub fn get_updated_by(&self) -> &Option<String>
The user or system that updated this resource.
Sourcepub fn started_at(self, input: DateTime) -> Self
pub fn started_at(self, input: DateTime) -> Self
The date and time the resource started running.
Sourcepub fn set_started_at(self, input: Option<DateTime>) -> Self
pub fn set_started_at(self, input: Option<DateTime>) -> Self
The date and time the resource started running.
Sourcepub fn get_started_at(&self) -> &Option<DateTime>
pub fn get_started_at(&self) -> &Option<DateTime>
The date and time the resource started running.
Sourcepub fn set_ended_at(self, input: Option<DateTime>) -> Self
pub fn set_ended_at(self, input: Option<DateTime>) -> Self
The date and time the resource ended running.
Sourcepub fn get_ended_at(&self) -> &Option<DateTime>
pub fn get_ended_at(&self) -> &Option<DateTime>
The date and time the resource ended running.
Sourcepub fn task_run_status(self, input: TaskRunStatus) -> Self
pub fn task_run_status(self, input: TaskRunStatus) -> Self
The task run status for the job.
-
PENDING
–pending and waiting for resources. -
READY
–ready to be processed. -
ASSIGNED
–assigned and will run next on a worker. -
SCHEDULED
–scheduled to be run on a worker. -
INTERRUPTING
–being interrupted. -
RUNNING
–running on a worker. -
SUSPENDED
–the task is suspended. -
CANCELED
–the task has been canceled. -
FAILED
–the task has failed. -
SUCCEEDED
–the task has succeeded.
Sourcepub fn set_task_run_status(self, input: Option<TaskRunStatus>) -> Self
pub fn set_task_run_status(self, input: Option<TaskRunStatus>) -> Self
The task run status for the job.
-
PENDING
–pending and waiting for resources. -
READY
–ready to be processed. -
ASSIGNED
–assigned and will run next on a worker. -
SCHEDULED
–scheduled to be run on a worker. -
INTERRUPTING
–being interrupted. -
RUNNING
–running on a worker. -
SUSPENDED
–the task is suspended. -
CANCELED
–the task has been canceled. -
FAILED
–the task has failed. -
SUCCEEDED
–the task has succeeded.
Sourcepub fn get_task_run_status(&self) -> &Option<TaskRunStatus>
pub fn get_task_run_status(&self) -> &Option<TaskRunStatus>
The task run status for the job.
-
PENDING
–pending and waiting for resources. -
READY
–ready to be processed. -
ASSIGNED
–assigned and will run next on a worker. -
SCHEDULED
–scheduled to be run on a worker. -
INTERRUPTING
–being interrupted. -
RUNNING
–running on a worker. -
SUSPENDED
–the task is suspended. -
CANCELED
–the task has been canceled. -
FAILED
–the task has failed. -
SUCCEEDED
–the task has succeeded.
Sourcepub fn target_task_run_status(self, input: JobTargetTaskRunStatus) -> Self
pub fn target_task_run_status(self, input: JobTargetTaskRunStatus) -> Self
The task status to start with on the job.
Sourcepub fn set_target_task_run_status(
self,
input: Option<JobTargetTaskRunStatus>,
) -> Self
pub fn set_target_task_run_status( self, input: Option<JobTargetTaskRunStatus>, ) -> Self
The task status to start with on the job.
Sourcepub fn get_target_task_run_status(&self) -> &Option<JobTargetTaskRunStatus>
pub fn get_target_task_run_status(&self) -> &Option<JobTargetTaskRunStatus>
The task status to start with on the job.
Sourcepub fn task_run_status_counts(self, k: TaskRunStatus, v: i32) -> Self
pub fn task_run_status_counts(self, k: TaskRunStatus, v: i32) -> Self
Adds a key-value pair to task_run_status_counts
.
To override the contents of this collection use set_task_run_status_counts
.
The number of tasks running on the job.
Sourcepub fn set_task_run_status_counts(
self,
input: Option<HashMap<TaskRunStatus, i32>>,
) -> Self
pub fn set_task_run_status_counts( self, input: Option<HashMap<TaskRunStatus, i32>>, ) -> Self
The number of tasks running on the job.
Sourcepub fn get_task_run_status_counts(&self) -> &Option<HashMap<TaskRunStatus, i32>>
pub fn get_task_run_status_counts(&self) -> &Option<HashMap<TaskRunStatus, i32>>
The number of tasks running on the job.
Sourcepub fn max_failed_tasks_count(self, input: i32) -> Self
pub fn max_failed_tasks_count(self, input: i32) -> Self
The number of task failures before the job stops running and is marked as FAILED
.
Sourcepub fn set_max_failed_tasks_count(self, input: Option<i32>) -> Self
pub fn set_max_failed_tasks_count(self, input: Option<i32>) -> Self
The number of task failures before the job stops running and is marked as FAILED
.
Sourcepub fn get_max_failed_tasks_count(&self) -> &Option<i32>
pub fn get_max_failed_tasks_count(&self) -> &Option<i32>
The number of task failures before the job stops running and is marked as FAILED
.
Sourcepub fn max_retries_per_task(self, input: i32) -> Self
pub fn max_retries_per_task(self, input: i32) -> Self
The maximum number of retries for a job.
Sourcepub fn set_max_retries_per_task(self, input: Option<i32>) -> Self
pub fn set_max_retries_per_task(self, input: Option<i32>) -> Self
The maximum number of retries for a job.
Sourcepub fn get_max_retries_per_task(&self) -> &Option<i32>
pub fn get_max_retries_per_task(&self) -> &Option<i32>
The maximum number of retries for a job.
Sourcepub fn source_job_id(self, input: impl Into<String>) -> Self
pub fn source_job_id(self, input: impl Into<String>) -> Self
The job ID for the source job.
Sourcepub fn set_source_job_id(self, input: Option<String>) -> Self
pub fn set_source_job_id(self, input: Option<String>) -> Self
The job ID for the source job.
Sourcepub fn get_source_job_id(&self) -> &Option<String>
pub fn get_source_job_id(&self) -> &Option<String>
The job ID for the source job.
Sourcepub fn build(self) -> Result<JobSummary, BuildError>
pub fn build(self) -> Result<JobSummary, BuildError>
Consumes the builder and constructs a JobSummary
.
This method will fail if any of the following fields are not set:
Trait Implementations§
Source§impl Clone for JobSummaryBuilder
impl Clone for JobSummaryBuilder
Source§fn clone(&self) -> JobSummaryBuilder
fn clone(&self) -> JobSummaryBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for JobSummaryBuilder
impl Debug for JobSummaryBuilder
Source§impl Default for JobSummaryBuilder
impl Default for JobSummaryBuilder
Source§fn default() -> JobSummaryBuilder
fn default() -> JobSummaryBuilder
Source§impl PartialEq for JobSummaryBuilder
impl PartialEq for JobSummaryBuilder
impl StructuralPartialEq for JobSummaryBuilder
Auto Trait Implementations§
impl Freeze for JobSummaryBuilder
impl RefUnwindSafe for JobSummaryBuilder
impl Send for JobSummaryBuilder
impl Sync for JobSummaryBuilder
impl Unpin for JobSummaryBuilder
impl UnwindSafe for JobSummaryBuilder
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>
Returns self
with the
fg()
set to
Color::BrightBlack
.
§Example
println!("{}", value.bright_black());
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>
Returns self
with the
fg()
set to
Color::BrightGreen
.
§Example
println!("{}", value.bright_green());
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Returns self
with the
fg()
set to
Color::BrightYellow
.
§Example
println!("{}", value.bright_yellow());
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>
Returns self
with the
fg()
set to
Color::BrightMagenta
.
§Example
println!("{}", value.bright_magenta());
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>
Returns self
with the
fg()
set to
Color::BrightWhite
.
§Example
println!("{}", value.bright_white());
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>
Returns self
with the
bg()
set to
Color::BrightBlack
.
§Example
println!("{}", value.on_bright_black());
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>
Returns self
with the
bg()
set to
Color::BrightGreen
.
§Example
println!("{}", value.on_bright_green());
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightYellow
.
§Example
println!("{}", value.on_bright_yellow());
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightBlue
.
§Example
println!("{}", value.on_bright_blue());
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightMagenta
.
§Example
println!("{}", value.on_bright_magenta());
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightCyan
.
§Example
println!("{}", value.on_bright_cyan());
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightWhite
.
§Example
println!("{}", value.on_bright_white());
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 underline(&self) -> Painted<&T>
fn underline(&self) -> Painted<&T>
Returns self
with the
attr()
set to
Attribute::Underline
.
§Example
println!("{}", value.underline());
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Returns self
with the
attr()
set to
Attribute::RapidBlink
.
§Example
println!("{}", value.rapid_blink());
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);