/* * Copyright 2018-2023 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.batch.model; import java.io.Serializable; import javax.annotation.Generated; import com.amazonaws.AmazonWebServiceRequest; /** *
* Contains the parameters for CancelJob
.
*
* The Batch job ID of the job to cancel. *
*/ private String jobId; /** ** A message to attach to the job that explains the reason for canceling it. This message is returned by future * DescribeJobs operations on the job. This message is also recorded in the Batch activity logs. *
*/ private String reason; /** ** The Batch job ID of the job to cancel. *
* * @param jobId * The Batch job ID of the job to cancel. */ public void setJobId(String jobId) { this.jobId = jobId; } /** ** The Batch job ID of the job to cancel. *
* * @return The Batch job ID of the job to cancel. */ public String getJobId() { return this.jobId; } /** ** The Batch job ID of the job to cancel. *
* * @param jobId * The Batch job ID of the job to cancel. * @return Returns a reference to this object so that method calls can be chained together. */ public CancelJobRequest withJobId(String jobId) { setJobId(jobId); return this; } /** ** A message to attach to the job that explains the reason for canceling it. This message is returned by future * DescribeJobs operations on the job. This message is also recorded in the Batch activity logs. *
* * @param reason * A message to attach to the job that explains the reason for canceling it. This message is returned by * future DescribeJobs operations on the job. This message is also recorded in the Batch activity * logs. */ public void setReason(String reason) { this.reason = reason; } /** ** A message to attach to the job that explains the reason for canceling it. This message is returned by future * DescribeJobs operations on the job. This message is also recorded in the Batch activity logs. *
* * @return A message to attach to the job that explains the reason for canceling it. This message is returned by * future DescribeJobs operations on the job. This message is also recorded in the Batch activity * logs. */ public String getReason() { return this.reason; } /** ** A message to attach to the job that explains the reason for canceling it. This message is returned by future * DescribeJobs operations on the job. This message is also recorded in the Batch activity logs. *
* * @param reason * A message to attach to the job that explains the reason for canceling it. This message is returned by * future DescribeJobs operations on the job. This message is also recorded in the Batch activity * logs. * @return Returns a reference to this object so that method calls can be chained together. */ public CancelJobRequest withReason(String reason) { setReason(reason); 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 (getJobId() != null) sb.append("JobId: ").append(getJobId()).append(","); if (getReason() != null) sb.append("Reason: ").append(getReason()); sb.append("}"); return sb.toString(); } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof CancelJobRequest == false) return false; CancelJobRequest other = (CancelJobRequest) obj; if (other.getJobId() == null ^ this.getJobId() == null) return false; if (other.getJobId() != null && other.getJobId().equals(this.getJobId()) == false) return false; if (other.getReason() == null ^ this.getReason() == null) return false; if (other.getReason() != null && other.getReason().equals(this.getReason()) == false) return false; return true; } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getJobId() == null) ? 0 : getJobId().hashCode()); hashCode = prime * hashCode + ((getReason() == null) ? 0 : getReason().hashCode()); return hashCode; } @Override public CancelJobRequest clone() { return (CancelJobRequest) super.clone(); } }