com.amazonaws.services.amplify.model

Class StartJobRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.amplify.model.StartJobRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class StartJobRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Request structure for Start job request.

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
StartJobRequest()

Method Summary

Modifier and Type	Method and Description
StartJobRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getAppId() Unique Id for an Amplify App.
String	getBranchName() Name for the branch, for the Job.
String	getCommitId() Commit Id from 3rd party repository provider for the Job.
String	getCommitMessage() Commit message from 3rd party repository provider for the Job.
Date	getCommitTime() Commit date / time for the Job.
String	getJobId() Unique Id for an existing job.
String	getJobReason() Descriptive reason for starting this job.
String	getJobType() Type for the Job.
int	hashCode()
void	setAppId(String appId) Unique Id for an Amplify App.
void	setBranchName(String branchName) Name for the branch, for the Job.
void	setCommitId(String commitId) Commit Id from 3rd party repository provider for the Job.
void	setCommitMessage(String commitMessage) Commit message from 3rd party repository provider for the Job.
void	setCommitTime(Date commitTime) Commit date / time for the Job.
void	setJobId(String jobId) Unique Id for an existing job.
void	setJobReason(String jobReason) Descriptive reason for starting this job.
void	setJobType(String jobType) Type for the Job.
String	toString() Returns a string representation of this object.
StartJobRequest	withAppId(String appId) Unique Id for an Amplify App.
StartJobRequest	withBranchName(String branchName) Name for the branch, for the Job.
StartJobRequest	withCommitId(String commitId) Commit Id from 3rd party repository provider for the Job.
StartJobRequest	withCommitMessage(String commitMessage) Commit message from 3rd party repository provider for the Job.
StartJobRequest	withCommitTime(Date commitTime) Commit date / time for the Job.
StartJobRequest	withJobId(String jobId) Unique Id for an existing job.
StartJobRequest	withJobReason(String jobReason) Descriptive reason for starting this job.
StartJobRequest	withJobType(JobType jobType) Type for the Job.
StartJobRequest	withJobType(String jobType) Type for the Job.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

StartJobRequest

public StartJobRequest()

Method Detail

setAppId

public void setAppId(String appId)

Unique Id for an Amplify App.

Parameters:

appId - Unique Id for an Amplify App.

getAppId

public String getAppId()

Unique Id for an Amplify App.

Returns:

Unique Id for an Amplify App.

withAppId

public StartJobRequest withAppId(String appId)

Unique Id for an Amplify App.

Parameters:

appId - Unique Id for an Amplify App.

Returns:

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

setBranchName

public void setBranchName(String branchName)

Name for the branch, for the Job.

Parameters:

branchName - Name for the branch, for the Job.

getBranchName

public String getBranchName()

Name for the branch, for the Job.

Returns:

Name for the branch, for the Job.

withBranchName

public StartJobRequest withBranchName(String branchName)

Name for the branch, for the Job.

Parameters:

branchName - Name for the branch, for the Job.

Returns:

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

setJobId

public void setJobId(String jobId)

Unique Id for an existing job. Required for "RETRY" JobType.

Parameters:

jobId - Unique Id for an existing job. Required for "RETRY" JobType.

getJobId

public String getJobId()

Unique Id for an existing job. Required for "RETRY" JobType.

Returns:

Unique Id for an existing job. Required for "RETRY" JobType.

withJobId

public StartJobRequest withJobId(String jobId)

Unique Id for an existing job. Required for "RETRY" JobType.

Parameters:

jobId - Unique Id for an existing job. Required for "RETRY" JobType.

Returns:

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

setJobType

public void setJobType(String jobType)

Type for the Job. Available JobTypes are: \n "RELEASE": Start a new job with the latest change from the specified branch. Only available for apps that have connected to a repository. "RETRY": Retry an existing job. JobId is required for this type of job.

Parameters:

jobType - Type for the Job. Available JobTypes are: \n "RELEASE": Start a new job with the latest change from the specified branch. Only available for apps that have connected to a repository. "RETRY": Retry an existing job. JobId is required for this type of job.

See Also:

JobType

getJobType

public String getJobType()

Type for the Job. Available JobTypes are: \n "RELEASE": Start a new job with the latest change from the specified branch. Only available for apps that have connected to a repository. "RETRY": Retry an existing job. JobId is required for this type of job.

Returns:

Type for the Job. Available JobTypes are: \n "RELEASE": Start a new job with the latest change from the specified branch. Only available for apps that have connected to a repository. "RETRY": Retry an existing job. JobId is required for this type of job.

See Also:

JobType

withJobType

public StartJobRequest withJobType(String jobType)

Type for the Job. Available JobTypes are: \n "RELEASE": Start a new job with the latest change from the specified branch. Only available for apps that have connected to a repository. "RETRY": Retry an existing job. JobId is required for this type of job.

Parameters:

jobType - Type for the Job. Available JobTypes are: \n "RELEASE": Start a new job with the latest change from the specified branch. Only available for apps that have connected to a repository. "RETRY": Retry an existing job. JobId is required for this type of job.

Returns:

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

See Also:

JobType

withJobType

public StartJobRequest withJobType(JobType jobType)

Type for the Job. Available JobTypes are: \n "RELEASE": Start a new job with the latest change from the specified branch. Only available for apps that have connected to a repository. "RETRY": Retry an existing job. JobId is required for this type of job.

Parameters:

jobType - Type for the Job. Available JobTypes are: \n "RELEASE": Start a new job with the latest change from the specified branch. Only available for apps that have connected to a repository. "RETRY": Retry an existing job. JobId is required for this type of job.

Returns:

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

See Also:

JobType

setJobReason

public void setJobReason(String jobReason)

Descriptive reason for starting this job.

Parameters:

jobReason - Descriptive reason for starting this job.

getJobReason

public String getJobReason()

Descriptive reason for starting this job.

Returns:

Descriptive reason for starting this job.

withJobReason

public StartJobRequest withJobReason(String jobReason)

Descriptive reason for starting this job.

Parameters:

jobReason - Descriptive reason for starting this job.

Returns:

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

setCommitId

public void setCommitId(String commitId)

Commit Id from 3rd party repository provider for the Job.

Parameters:

commitId - Commit Id from 3rd party repository provider for the Job.

getCommitId

public String getCommitId()

Commit Id from 3rd party repository provider for the Job.

Returns:

Commit Id from 3rd party repository provider for the Job.

withCommitId

public StartJobRequest withCommitId(String commitId)

Commit Id from 3rd party repository provider for the Job.

Parameters:

commitId - Commit Id from 3rd party repository provider for the Job.

Returns:

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

setCommitMessage

public void setCommitMessage(String commitMessage)

Commit message from 3rd party repository provider for the Job.

Parameters:

commitMessage - Commit message from 3rd party repository provider for the Job.

getCommitMessage

public String getCommitMessage()

Commit message from 3rd party repository provider for the Job.

Returns:

Commit message from 3rd party repository provider for the Job.

withCommitMessage

public StartJobRequest withCommitMessage(String commitMessage)

Commit message from 3rd party repository provider for the Job.

Parameters:

commitMessage - Commit message from 3rd party repository provider for the Job.

Returns:

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

setCommitTime

public void setCommitTime(Date commitTime)

Commit date / time for the Job.

Parameters:

commitTime - Commit date / time for the Job.

getCommitTime

public Date getCommitTime()

Commit date / time for the Job.

Returns:

Commit date / time for the Job.

withCommitTime

public StartJobRequest withCommitTime(Date commitTime)

Commit date / time for the Job.

Parameters:

commitTime - Commit date / time for the Job.

Returns:

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

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public StartJobRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()