com.amazonaws.services.amplify.model.StartJobRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-amplify Show documentation
/*
* Copyright 2020-2025 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.amplify.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
* The request structure for the start job request.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class StartJobRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The unique ID for an Amplify app.
*
*/
private String appId;
/**
*
* The name of the branch to use for the job.
*
*/
private String branchName;
/**
*
* The unique ID for an existing job. This is required if the value of jobType is RETRY.
*
*/
private String jobId;
/**
*
* 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.
*
*/
private String jobType;
/**
*
* A descriptive reason for starting the job.
*
*/
private String jobReason;
/**
*
* The commit ID from a third-party repository provider for the job.
*
*/
private String commitId;
/**
*
* The commit message from a third-party repository provider for the job.
*
*/
private String commitMessage;
/**
*
* The commit date and time for the job.
*
*/
private java.util.Date commitTime;
/**
*
* The unique ID for an Amplify app.
*
*
* @param appId
* The unique ID for an Amplify app.
*/
public void setAppId(String appId) {
this.appId = appId;
}
/**
*
* The unique ID for an Amplify app.
*
*
* @return The unique ID for an Amplify app.
*/
public String getAppId() {
return this.appId;
}
/**
*
* The unique ID for an Amplify app.
*
*
* @param appId
* The unique ID for an Amplify app.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StartJobRequest withAppId(String appId) {
setAppId(appId);
return this;
}
/**
*
* The name of the branch to use for the job.
*
*
* @param branchName
* The name of the branch to use for the job.
*/
public void setBranchName(String branchName) {
this.branchName = branchName;
}
/**
*
* The name of the branch to use for the job.
*
*
* @return The name of the branch to use for the job.
*/
public String getBranchName() {
return this.branchName;
}
/**
*
* The name of the branch to use for the job.
*
*
* @param branchName
* The name of the branch to use for the job.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StartJobRequest withBranchName(String branchName) {
setBranchName(branchName);
return this;
}
/**
*
* The unique ID for an existing job. This is required if the value of jobType is RETRY.
*
*
* @param jobId
* The unique ID for an existing job. This is required if the value of jobType is
* RETRY.
*/
public void setJobId(String jobId) {
this.jobId = jobId;
}
/**
*
* The unique ID for an existing job. This is required if the value of jobType is RETRY.
*
*
* @return The unique ID for an existing job. This is required if the value of jobType is
* RETRY.
*/
public String getJobId() {
return this.jobId;
}
/**
*
* The unique ID for an existing job. This is required if the value of jobType is RETRY.
*
*
* @param jobId
* The unique ID for an existing job. This is required if the value of jobType is
* RETRY.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StartJobRequest withJobId(String jobId) {
setJobId(jobId);
return this;
}
/**
*
* 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.
*
*
* @param 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.
* @see JobType
*/
public void setJobType(String jobType) {
this.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.
*
*
* @return 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.
* @see JobType
*/
public String getJobType() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
* @see JobType
*/
public StartJobRequest withJobType(String jobType) {
setJobType(jobType);
return this;
}
/**
*
* 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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
* @see JobType
*/
public StartJobRequest withJobType(JobType jobType) {
this.jobType = jobType.toString();
return this;
}
/**
*
* A descriptive reason for starting the job.
*
*
* @param jobReason
* A descriptive reason for starting the job.
*/
public void setJobReason(String jobReason) {
this.jobReason = jobReason;
}
/**
*
* A descriptive reason for starting the job.
*
*
* @return A descriptive reason for starting the job.
*/
public String getJobReason() {
return this.jobReason;
}
/**
*
* A descriptive reason for starting the job.
*
*
* @param jobReason
* A descriptive reason for starting the job.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StartJobRequest withJobReason(String jobReason) {
setJobReason(jobReason);
return this;
}
/**
*
* The commit ID from a third-party repository provider for the job.
*
*
* @param commitId
* The commit ID from a third-party repository provider for the job.
*/
public void setCommitId(String commitId) {
this.commitId = commitId;
}
/**
*
* The commit ID from a third-party repository provider for the job.
*
*
* @return The commit ID from a third-party repository provider for the job.
*/
public String getCommitId() {
return this.commitId;
}
/**
*
* The commit ID from a third-party repository provider for the job.
*
*
* @param commitId
* The commit ID from a third-party repository provider for the job.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StartJobRequest withCommitId(String commitId) {
setCommitId(commitId);
return this;
}
/**
*
* The commit message from a third-party repository provider for the job.
*
*
* @param commitMessage
* The commit message from a third-party repository provider for the job.
*/
public void setCommitMessage(String commitMessage) {
this.commitMessage = commitMessage;
}
/**
*
* The commit message from a third-party repository provider for the job.
*
*
* @return The commit message from a third-party repository provider for the job.
*/
public String getCommitMessage() {
return this.commitMessage;
}
/**
*
* The commit message from a third-party repository provider for the job.
*
*
* @param commitMessage
* The commit message from a third-party repository provider for the job.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StartJobRequest withCommitMessage(String commitMessage) {
setCommitMessage(commitMessage);
return this;
}
/**
*
* The commit date and time for the job.
*
*
* @param commitTime
* The commit date and time for the job.
*/
public void setCommitTime(java.util.Date commitTime) {
this.commitTime = commitTime;
}
/**
*
* The commit date and time for the job.
*
*
* @return The commit date and time for the job.
*/
public java.util.Date getCommitTime() {
return this.commitTime;
}
/**
*
* The commit date and time for the job.
*
*
* @param commitTime
* The commit date and time for the job.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StartJobRequest withCommitTime(java.util.Date commitTime) {
setCommitTime(commitTime);
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getAppId() != null)
sb.append("AppId: ").append(getAppId()).append(",");
if (getBranchName() != null)
sb.append("BranchName: ").append(getBranchName()).append(",");
if (getJobId() != null)
sb.append("JobId: ").append(getJobId()).append(",");
if (getJobType() != null)
sb.append("JobType: ").append(getJobType()).append(",");
if (getJobReason() != null)
sb.append("JobReason: ").append(getJobReason()).append(",");
if (getCommitId() != null)
sb.append("CommitId: ").append(getCommitId()).append(",");
if (getCommitMessage() != null)
sb.append("CommitMessage: ").append(getCommitMessage()).append(",");
if (getCommitTime() != null)
sb.append("CommitTime: ").append(getCommitTime());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof StartJobRequest == false)
return false;
StartJobRequest other = (StartJobRequest) obj;
if (other.getAppId() == null ^ this.getAppId() == null)
return false;
if (other.getAppId() != null && other.getAppId().equals(this.getAppId()) == false)
return false;
if (other.getBranchName() == null ^ this.getBranchName() == null)
return false;
if (other.getBranchName() != null && other.getBranchName().equals(this.getBranchName()) == false)
return false;
if (other.getJobId() == null ^ this.getJobId() == null)
return false;
if (other.getJobId() != null && other.getJobId().equals(this.getJobId()) == false)
return false;
if (other.getJobType() == null ^ this.getJobType() == null)
return false;
if (other.getJobType() != null && other.getJobType().equals(this.getJobType()) == false)
return false;
if (other.getJobReason() == null ^ this.getJobReason() == null)
return false;
if (other.getJobReason() != null && other.getJobReason().equals(this.getJobReason()) == false)
return false;
if (other.getCommitId() == null ^ this.getCommitId() == null)
return false;
if (other.getCommitId() != null && other.getCommitId().equals(this.getCommitId()) == false)
return false;
if (other.getCommitMessage() == null ^ this.getCommitMessage() == null)
return false;
if (other.getCommitMessage() != null && other.getCommitMessage().equals(this.getCommitMessage()) == false)
return false;
if (other.getCommitTime() == null ^ this.getCommitTime() == null)
return false;
if (other.getCommitTime() != null && other.getCommitTime().equals(this.getCommitTime()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getAppId() == null) ? 0 : getAppId().hashCode());
hashCode = prime * hashCode + ((getBranchName() == null) ? 0 : getBranchName().hashCode());
hashCode = prime * hashCode + ((getJobId() == null) ? 0 : getJobId().hashCode());
hashCode = prime * hashCode + ((getJobType() == null) ? 0 : getJobType().hashCode());
hashCode = prime * hashCode + ((getJobReason() == null) ? 0 : getJobReason().hashCode());
hashCode = prime * hashCode + ((getCommitId() == null) ? 0 : getCommitId().hashCode());
hashCode = prime * hashCode + ((getCommitMessage() == null) ? 0 : getCommitMessage().hashCode());
hashCode = prime * hashCode + ((getCommitTime() == null) ? 0 : getCommitTime().hashCode());
return hashCode;
}
@Override
public StartJobRequest clone() {
return (StartJobRequest) super.clone();
}
}