software.amazon.awssdk.services.amplify.model

Interface StartJobRequest.Builder

All Superinterfaces:

AmplifyRequest.Builder, AwsRequest.Builder, Buildable, CopyableBuilder<StartJobRequest.Builder,StartJobRequest>, SdkBuilder<StartJobRequest.Builder,StartJobRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

StartJobRequest

public static interface StartJobRequest.Builder
extends AmplifyRequest.Builder, SdkPojo, CopyableBuilder<StartJobRequest.Builder,StartJobRequest>

Method Summary

Modifier and Type	Method and Description
StartJobRequest.Builder	appId(String appId) The unique ID for an Amplify app.
StartJobRequest.Builder	branchName(String branchName) The branch name for the job.
StartJobRequest.Builder	commitId(String commitId) The commit ID from a third-party repository provider for the job.
StartJobRequest.Builder	commitMessage(String commitMessage) The commit message from a third-party repository provider for the job.
StartJobRequest.Builder	commitTime(Instant commitTime) The commit date and time for the job.
StartJobRequest.Builder	jobId(String jobId) The unique ID for an existing job.
StartJobRequest.Builder	jobReason(String jobReason) A descriptive reason for starting this job.
StartJobRequest.Builder	jobType(JobType jobType) Describes the type for the job.
StartJobRequest.Builder	jobType(String jobType) Describes the type for the job.
StartJobRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
StartJobRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Methods inherited from interface software.amazon.awssdk.services.amplify.model.AmplifyRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

appId

StartJobRequest.Builder appId(String appId)

The unique ID for an Amplify app.

Parameters:

appId - The unique ID for an Amplify app.

Returns:

Returns a reference to this object so that method calls can be chained together.

branchName

StartJobRequest.Builder branchName(String branchName)

The branch name for the job.

Parameters:

branchName - The branch name for the job.

Returns:

Returns a reference to this object so that method calls can be chained together.

jobId

StartJobRequest.Builder jobId(String jobId)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

jobType

StartJobRequest.Builder jobType(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

JobType, JobType

jobType

StartJobRequest.Builder jobType(JobType 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

JobType, JobType

jobReason

StartJobRequest.Builder jobReason(String jobReason)

A descriptive reason for starting this job.

Parameters:

jobReason - A descriptive reason for starting this job.

Returns:

Returns a reference to this object so that method calls can be chained together.

commitId

StartJobRequest.Builder commitId(String commitId)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

commitMessage

StartJobRequest.Builder commitMessage(String commitMessage)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

commitTime

StartJobRequest.Builder commitTime(Instant commitTime)

The commit date and time for the job.

Parameters:

commitTime - The commit date and time for the job.

Returns:

Returns a reference to this object so that method calls can be chained together.

overrideConfiguration

StartJobRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

StartJobRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder