pub struct StartJobFluentBuilder { /* private fields */ }Expand description
Fluent builder constructing a request to StartJob.
Starts a new job for a branch of an Amplify app.
Implementations§
Source§impl StartJobFluentBuilder
impl StartJobFluentBuilder
Sourcepub fn as_input(&self) -> &StartJobInputBuilder
pub fn as_input(&self) -> &StartJobInputBuilder
Access the StartJob as a reference.
Sourcepub async fn send(
self,
) -> Result<StartJobOutput, SdkError<StartJobError, HttpResponse>>
pub async fn send( self, ) -> Result<StartJobOutput, SdkError<StartJobError, 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<StartJobOutput, StartJobError, Self>
pub fn customize( self, ) -> CustomizableOperation<StartJobOutput, StartJobError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
Sourcepub fn set_app_id(self, input: Option<String>) -> Self
pub fn set_app_id(self, input: Option<String>) -> Self
The unique ID for an Amplify app.
Sourcepub fn get_app_id(&self) -> &Option<String>
pub fn get_app_id(&self) -> &Option<String>
The unique ID for an Amplify app.
Sourcepub fn branch_name(self, input: impl Into<String>) -> Self
pub fn branch_name(self, input: impl Into<String>) -> Self
The name of the branch to use for the job.
Sourcepub fn set_branch_name(self, input: Option<String>) -> Self
pub fn set_branch_name(self, input: Option<String>) -> Self
The name of the branch to use for the job.
Sourcepub fn get_branch_name(&self) -> &Option<String>
pub fn get_branch_name(&self) -> &Option<String>
The name of the branch to use for the job.
Sourcepub fn job_id(self, input: impl Into<String>) -> Self
pub fn job_id(self, input: impl Into<String>) -> Self
The unique ID for an existing job. This is required if the value of jobType is RETRY.
Sourcepub fn set_job_id(self, input: Option<String>) -> Self
pub fn set_job_id(self, input: Option<String>) -> Self
The unique ID for an existing job. This is required if the value of jobType is RETRY.
Sourcepub fn get_job_id(&self) -> &Option<String>
pub fn get_job_id(&self) -> &Option<String>
The unique ID for an existing job. This is required if the value of jobType is RETRY.
Sourcepub fn job_type(self, input: JobType) -> Self
pub fn job_type(self, input: JobType) -> Self
Describes the type for the job. The job type RELEASE starts a new job with the latest change from the specified branch. This value is available only for apps that are connected to a repository.
The job type RETRY retries an existing job. If the job type value is RETRY, the jobId is also required.
Sourcepub fn set_job_type(self, input: Option<JobType>) -> Self
pub fn set_job_type(self, input: Option<JobType>) -> Self
Describes the type for the job. The job type RELEASE starts a new job with the latest change from the specified branch. This value is available only for apps that are connected to a repository.
The job type RETRY retries an existing job. If the job type value is RETRY, the jobId is also required.
Sourcepub fn get_job_type(&self) -> &Option<JobType>
pub fn get_job_type(&self) -> &Option<JobType>
Describes the type for the job. The job type RELEASE starts a new job with the latest change from the specified branch. This value is available only for apps that are connected to a repository.
The job type RETRY retries an existing job. If the job type value is RETRY, the jobId is also required.
Sourcepub fn job_reason(self, input: impl Into<String>) -> Self
pub fn job_reason(self, input: impl Into<String>) -> Self
A descriptive reason for starting the job.
Sourcepub fn set_job_reason(self, input: Option<String>) -> Self
pub fn set_job_reason(self, input: Option<String>) -> Self
A descriptive reason for starting the job.
Sourcepub fn get_job_reason(&self) -> &Option<String>
pub fn get_job_reason(&self) -> &Option<String>
A descriptive reason for starting the job.
Sourcepub fn commit_id(self, input: impl Into<String>) -> Self
pub fn commit_id(self, input: impl Into<String>) -> Self
The commit ID from a third-party repository provider for the job.
Sourcepub fn set_commit_id(self, input: Option<String>) -> Self
pub fn set_commit_id(self, input: Option<String>) -> Self
The commit ID from a third-party repository provider for the job.
Sourcepub fn get_commit_id(&self) -> &Option<String>
pub fn get_commit_id(&self) -> &Option<String>
The commit ID from a third-party repository provider for the job.
Sourcepub fn commit_message(self, input: impl Into<String>) -> Self
pub fn commit_message(self, input: impl Into<String>) -> Self
The commit message from a third-party repository provider for the job.
Sourcepub fn set_commit_message(self, input: Option<String>) -> Self
pub fn set_commit_message(self, input: Option<String>) -> Self
The commit message from a third-party repository provider for the job.
Sourcepub fn get_commit_message(&self) -> &Option<String>
pub fn get_commit_message(&self) -> &Option<String>
The commit message from a third-party repository provider for the job.
Sourcepub fn commit_time(self, input: DateTime) -> Self
pub fn commit_time(self, input: DateTime) -> Self
The commit date and time for the job.
Sourcepub fn set_commit_time(self, input: Option<DateTime>) -> Self
pub fn set_commit_time(self, input: Option<DateTime>) -> Self
The commit date and time for the job.
Sourcepub fn get_commit_time(&self) -> &Option<DateTime>
pub fn get_commit_time(&self) -> &Option<DateTime>
The commit date and time for the job.
Trait Implementations§
Source§impl Clone for StartJobFluentBuilder
impl Clone for StartJobFluentBuilder
Source§fn clone(&self) -> StartJobFluentBuilder
fn clone(&self) -> StartJobFluentBuilder
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 StartJobFluentBuilder
impl !RefUnwindSafe for StartJobFluentBuilder
impl Send for StartJobFluentBuilder
impl Sync for StartJobFluentBuilder
impl Unpin for StartJobFluentBuilder
impl !UnwindSafe for StartJobFluentBuilder
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);