#[non_exhaustive]pub struct CreateJobInput {Show 13 fields
pub farm_id: Option<String>,
pub queue_id: Option<String>,
pub client_token: Option<String>,
pub template: Option<String>,
pub template_type: Option<JobTemplateType>,
pub priority: Option<i32>,
pub parameters: Option<HashMap<String, JobParameter>>,
pub attachments: Option<Attachments>,
pub storage_profile_id: Option<String>,
pub target_task_run_status: Option<CreateJobTargetTaskRunStatus>,
pub max_failed_tasks_count: Option<i32>,
pub max_retries_per_task: Option<i32>,
pub source_job_id: Option<String>,
}
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.farm_id: Option<String>
The farm ID of the farm to connect to the job.
queue_id: Option<String>
The ID of the queue that the job is submitted to.
client_token: Option<String>
The unique token which the server uses to recognize retries of the same request.
template: Option<String>
The job template to use for this job.
template_type: Option<JobTemplateType>
The file type for the job template.
priority: Option<i32>
The priority of the job on a scale of 0 to 100. The highest priority (first scheduled) is 100. When two jobs have the same priority, the oldest job is scheduled first.
parameters: Option<HashMap<String, JobParameter>>
The parameters for the job.
attachments: Option<Attachments>
The attachments for the job. Attach files required for the job to run to a render job.
storage_profile_id: Option<String>
The storage profile ID for the storage profile to connect to the job.
target_task_run_status: Option<CreateJobTargetTaskRunStatus>
The initial job status when it is created. Jobs that are created with a SUSPENDED
status will not run until manually requeued.
max_failed_tasks_count: Option<i32>
The number of task failures before the job stops running and is marked as FAILED
.
max_retries_per_task: Option<i32>
The maximum number of retries for each task.
source_job_id: Option<String>
The job ID for the source job.
Implementations§
Source§impl CreateJobInput
impl CreateJobInput
Sourcepub fn client_token(&self) -> Option<&str>
pub fn client_token(&self) -> Option<&str>
The unique token which the server uses to recognize retries of the same request.
Sourcepub fn template_type(&self) -> Option<&JobTemplateType>
pub fn template_type(&self) -> Option<&JobTemplateType>
The file type for the job template.
Sourcepub fn priority(&self) -> Option<i32>
pub fn priority(&self) -> Option<i32>
The priority of the job on a scale of 0 to 100. The highest priority (first scheduled) is 100. When two jobs have the same priority, the oldest job is scheduled first.
Sourcepub fn parameters(&self) -> Option<&HashMap<String, JobParameter>>
pub fn parameters(&self) -> Option<&HashMap<String, JobParameter>>
The parameters for the job.
Sourcepub fn attachments(&self) -> Option<&Attachments>
pub fn attachments(&self) -> Option<&Attachments>
The attachments for the job. Attach files required for the job to run to a render job.
Sourcepub fn storage_profile_id(&self) -> Option<&str>
pub fn storage_profile_id(&self) -> Option<&str>
The storage profile ID for the storage profile to connect to the job.
Sourcepub fn target_task_run_status(&self) -> Option<&CreateJobTargetTaskRunStatus>
pub fn target_task_run_status(&self) -> Option<&CreateJobTargetTaskRunStatus>
The initial job status when it is created. Jobs that are created with a SUSPENDED
status will not run until manually requeued.
Sourcepub fn max_failed_tasks_count(&self) -> Option<i32>
pub fn 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) -> Option<i32>
pub fn max_retries_per_task(&self) -> Option<i32>
The maximum number of retries for each task.
Sourcepub fn source_job_id(&self) -> Option<&str>
pub fn source_job_id(&self) -> Option<&str>
The job ID for the source job.
Source§impl CreateJobInput
impl CreateJobInput
Sourcepub fn builder() -> CreateJobInputBuilder
pub fn builder() -> CreateJobInputBuilder
Creates a new builder-style object to manufacture CreateJobInput
.
Trait Implementations§
Source§impl Clone for CreateJobInput
impl Clone for CreateJobInput
Source§fn clone(&self) -> CreateJobInput
fn clone(&self) -> CreateJobInput
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for CreateJobInput
impl Debug for CreateJobInput
Source§impl PartialEq for CreateJobInput
impl PartialEq for CreateJobInput
impl StructuralPartialEq for CreateJobInput
Auto Trait Implementations§
impl Freeze for CreateJobInput
impl RefUnwindSafe for CreateJobInput
impl Send for CreateJobInput
impl Sync for CreateJobInput
impl Unpin for CreateJobInput
impl UnwindSafe for CreateJobInput
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);