Struct aws_sdk_amplify::operation::start_job::StartJobInput

#[non_exhaustive]
pub struct StartJobInput {
    pub app_id: Option<String>,
    pub branch_name: Option<String>,
    pub job_id: Option<String>,
    pub job_type: Option<JobType>,
    pub job_reason: Option<String>,
    pub commit_id: Option<String>,
    pub commit_message: Option<String>,
    pub commit_time: Option<DateTime>,
}

The request structure for the start job request.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

app_id: Option<String>

The unique ID for an Amplify app.

branch_name: Option<String>

The name of the branch to use for the job.

job_id: Option<String>

The unique ID for an existing job. This is required if the value of jobType is RETRY.

job_type: 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.

job_reason: Option<String>

A descriptive reason for starting the job.

commit_id: Option<String>

The commit ID from a third-party repository provider for the job.

commit_message: Option<String>

The commit message from a third-party repository provider for the job.

commit_time: Option<DateTime>

The commit date and time for the job.

Implementations

impl StartJobInput

pub fn app_id(&self) -> Option<&str>

The unique ID for an Amplify app.

pub fn branch_name(&self) -> Option<&str>

The name of the branch to use for the job.

pub fn job_id(&self) -> Option<&str>

The unique ID for an existing job. This is required if the value of jobType is RETRY.

pub fn 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.

pub fn job_reason(&self) -> Option<&str>

A descriptive reason for starting the job.

pub fn commit_id(&self) -> Option<&str>

The commit ID from a third-party repository provider for the job.

pub fn commit_message(&self) -> Option<&str>

The commit message from a third-party repository provider for the job.

pub fn commit_time(&self) -> Option<&DateTime>

The commit date and time for the job.

impl StartJobInput

pub fn builder() -> StartJobInputBuilder

Creates a new builder-style object to manufacture StartJobInput.

Trait Implementations

impl Clone for StartJobInput

fn clone(&self) -> StartJobInput

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for StartJobInput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for StartJobInput

fn eq(&self, other: &StartJobInput) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for StartJobInput