pub struct CreateJobFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to CreateJob
.
Creates a job. A job is a set of instructions that AWS Deadline Cloud uses to schedule and run work on available workers. For more information, see Deadline Cloud jobs.
Implementations§
Source§impl CreateJobFluentBuilder
impl CreateJobFluentBuilder
Sourcepub fn as_input(&self) -> &CreateJobInputBuilder
pub fn as_input(&self) -> &CreateJobInputBuilder
Access the CreateJob as a reference.
Sourcepub async fn send(
self,
) -> Result<CreateJobOutput, SdkError<CreateJobError, HttpResponse>>
pub async fn send( self, ) -> Result<CreateJobOutput, SdkError<CreateJobError, HttpResponse>>
Sends the request and returns the response.
If an error occurs, an SdkError
will be returned with additional details that
can be matched against.
By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.
Sourcepub fn customize(
self,
) -> CustomizableOperation<CreateJobOutput, CreateJobError, Self>
pub fn customize( self, ) -> CustomizableOperation<CreateJobOutput, CreateJobError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
Sourcepub fn farm_id(self, input: impl Into<String>) -> Self
pub fn farm_id(self, input: impl Into<String>) -> Self
The farm ID of the farm to connect to the job.
Sourcepub fn set_farm_id(self, input: Option<String>) -> Self
pub fn set_farm_id(self, input: Option<String>) -> Self
The farm ID of the farm to connect to the job.
Sourcepub fn get_farm_id(&self) -> &Option<String>
pub fn get_farm_id(&self) -> &Option<String>
The farm ID of the farm to connect to the job.
Sourcepub fn queue_id(self, input: impl Into<String>) -> Self
pub fn queue_id(self, input: impl Into<String>) -> Self
The ID of the queue that the job is submitted to.
Sourcepub fn set_queue_id(self, input: Option<String>) -> Self
pub fn set_queue_id(self, input: Option<String>) -> Self
The ID of the queue that the job is submitted to.
Sourcepub fn get_queue_id(&self) -> &Option<String>
pub fn get_queue_id(&self) -> &Option<String>
The ID of the queue that the job is submitted to.
Sourcepub fn client_token(self, input: impl Into<String>) -> Self
pub fn client_token(self, input: impl Into<String>) -> Self
The unique token which the server uses to recognize retries of the same request.
Sourcepub fn set_client_token(self, input: Option<String>) -> Self
pub fn set_client_token(self, input: Option<String>) -> Self
The unique token which the server uses to recognize retries of the same request.
Sourcepub fn get_client_token(&self) -> &Option<String>
pub fn get_client_token(&self) -> &Option<String>
The unique token which the server uses to recognize retries of the same request.
Sourcepub fn set_template(self, input: Option<String>) -> Self
pub fn set_template(self, input: Option<String>) -> Self
The job template to use for this job.
Sourcepub fn get_template(&self) -> &Option<String>
pub fn get_template(&self) -> &Option<String>
The job template to use for this job.
Sourcepub fn template_type(self, input: JobTemplateType) -> Self
pub fn template_type(self, input: JobTemplateType) -> Self
The file type for the job template.
Sourcepub fn set_template_type(self, input: Option<JobTemplateType>) -> Self
pub fn set_template_type(self, input: Option<JobTemplateType>) -> Self
The file type for the job template.
Sourcepub fn get_template_type(&self) -> &Option<JobTemplateType>
pub fn get_template_type(&self) -> &Option<JobTemplateType>
The file type for the job template.
Sourcepub fn priority(self, input: i32) -> Self
pub fn priority(self, input: i32) -> Self
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 set_priority(self, input: Option<i32>) -> Self
pub fn set_priority(self, input: Option<i32>) -> Self
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 get_priority(&self) -> &Option<i32>
pub fn get_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, k: impl Into<String>, v: JobParameter) -> Self
pub fn parameters(self, k: impl Into<String>, v: JobParameter) -> Self
Adds a key-value pair to parameters
.
To override the contents of this collection use set_parameters
.
The parameters for the job.
Sourcepub fn set_parameters(
self,
input: Option<HashMap<String, JobParameter>>,
) -> Self
pub fn set_parameters( self, input: Option<HashMap<String, JobParameter>>, ) -> Self
The parameters for the job.
Sourcepub fn get_parameters(&self) -> &Option<HashMap<String, JobParameter>>
pub fn get_parameters(&self) -> &Option<HashMap<String, JobParameter>>
The parameters for the job.
Sourcepub fn attachments(self, input: Attachments) -> Self
pub fn attachments(self, input: Attachments) -> Self
The attachments for the job. Attach files required for the job to run to a render job.
Sourcepub fn set_attachments(self, input: Option<Attachments>) -> Self
pub fn set_attachments(self, input: Option<Attachments>) -> Self
The attachments for the job. Attach files required for the job to run to a render job.
Sourcepub fn get_attachments(&self) -> &Option<Attachments>
pub fn get_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, input: impl Into<String>) -> Self
pub fn storage_profile_id(self, input: impl Into<String>) -> Self
The storage profile ID for the storage profile to connect to the job.
Sourcepub fn set_storage_profile_id(self, input: Option<String>) -> Self
pub fn set_storage_profile_id(self, input: Option<String>) -> Self
The storage profile ID for the storage profile to connect to the job.
Sourcepub fn get_storage_profile_id(&self) -> &Option<String>
pub fn get_storage_profile_id(&self) -> &Option<String>
The storage profile ID for the storage profile to connect to the job.
Sourcepub fn target_task_run_status(self, input: CreateJobTargetTaskRunStatus) -> Self
pub fn target_task_run_status(self, input: CreateJobTargetTaskRunStatus) -> Self
The initial job status when it is created. Jobs that are created with a SUSPENDED
status will not run until manually requeued.
Sourcepub fn set_target_task_run_status(
self,
input: Option<CreateJobTargetTaskRunStatus>,
) -> Self
pub fn set_target_task_run_status( self, input: Option<CreateJobTargetTaskRunStatus>, ) -> Self
The initial job status when it is created. Jobs that are created with a SUSPENDED
status will not run until manually requeued.
Sourcepub fn get_target_task_run_status(
&self,
) -> &Option<CreateJobTargetTaskRunStatus>
pub fn get_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, 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 each task.
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 each task.
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 each task.
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.
Trait Implementations§
Source§impl Clone for CreateJobFluentBuilder
impl Clone for CreateJobFluentBuilder
Source§fn clone(&self) -> CreateJobFluentBuilder
fn clone(&self) -> CreateJobFluentBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreAuto Trait Implementations§
impl Freeze for CreateJobFluentBuilder
impl !RefUnwindSafe for CreateJobFluentBuilder
impl Send for CreateJobFluentBuilder
impl Sync for CreateJobFluentBuilder
impl Unpin for CreateJobFluentBuilder
impl !UnwindSafe for CreateJobFluentBuilder
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);