Struct aws_sdk_amplify::client::fluent_builders::StartJob
source · [−]pub struct StartJob { /* private fields */ }Expand description
Fluent builder constructing a request to StartJob.
Starts a new job for a branch of an Amplify app.
Implementations
sourceimpl StartJob
impl StartJob
sourcepub async fn customize(
self
) -> Result<CustomizableOperation<StartJob, AwsResponseRetryClassifier>, SdkError<StartJobError>>
pub async fn customize(
self
) -> Result<CustomizableOperation<StartJob, AwsResponseRetryClassifier>, SdkError<StartJobError>>
Consume this builder, creating a customizable operation that can be modified before being sent. The operation’s inner http::Request can be modified as well.
sourcepub async fn send(self) -> Result<StartJobOutput, SdkError<StartJobError>>
pub async fn send(self) -> Result<StartJobOutput, SdkError<StartJobError>>
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 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 branch_name(self, input: impl Into<String>) -> Self
pub fn branch_name(self, input: impl Into<String>) -> Self
The branch name for the job.
sourcepub fn set_branch_name(self, input: Option<String>) -> Self
pub fn set_branch_name(self, input: Option<String>) -> Self
The branch name 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 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 job_reason(self, input: impl Into<String>) -> Self
pub fn job_reason(self, input: impl Into<String>) -> Self
A descriptive reason for starting this 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 this 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 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 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.