Package software.amazon.awssdk.services.amplify.model

Interface StartJobRequest.Builder

    • 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 name of the branch to use for the job.

        Parameters:
        branchName - The name of the branch to use 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 the job.

        Parameters:
        jobReason - A descriptive reason for starting the 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.