/* * Copyright 2010-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.iot.model; import java.io.Serializable; import com.amazonaws.AmazonWebServiceRequest; /** *

* Cancels a job. *

*

* Requires permission to access the CancelJob action. *

*/ public class CancelJobRequest extends AmazonWebServiceRequest implements Serializable { /** *

* The unique identifier you assigned to this job when it was created. *

*

* Constraints:
* Length: 1 - 64
* Pattern: [a-zA-Z0-9_-]+
*/ private String jobId; /** *

* (Optional)A reason code string that explains why the job was canceled. *

*

* Constraints:
* Length: - 128
* Pattern: [\p{Upper}\p{Digit}_]+
*/ private String reasonCode; /** *

* An optional comment string describing why the job was canceled. *

*

* Constraints:
* Length: - 2028
* Pattern: [^\p{C}]+
*/ private String comment; /** *

* (Optional) If true job executions with status "IN_PROGRESS" * and "QUEUED" are canceled, otherwise only job executions with status * "QUEUED" are canceled. The default is false. *

*

* Canceling a job which is "IN_PROGRESS", will cause a device which is * executing the job to be unable to update the job execution status. Use * caution and ensure that each device executing a job which is canceled is * able to recover to a valid state. *

*/ private Boolean force; /** *

* The unique identifier you assigned to this job when it was created. *

*

* Constraints:
* Length: 1 - 64
* Pattern: [a-zA-Z0-9_-]+
* * @return

* The unique identifier you assigned to this job when it was * created. *

*/ public String getJobId() { return jobId; } /** *

* The unique identifier you assigned to this job when it was created. *

*

* Constraints:
* Length: 1 - 64
* Pattern: [a-zA-Z0-9_-]+
* * @param jobId

* The unique identifier you assigned to this job when it was * created. *

*/ public void setJobId(String jobId) { this.jobId = jobId; } /** *

* The unique identifier you assigned to this job when it was created. *

*

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

* Constraints:
* Length: 1 - 64
* Pattern: [a-zA-Z0-9_-]+
* * @param jobId

* The unique identifier you assigned to this job when it was * created. *

* @return A reference to this updated object so that method calls can be * chained together. */ public CancelJobRequest withJobId(String jobId) { this.jobId = jobId; return this; } /** *

* (Optional)A reason code string that explains why the job was canceled. *

*

* Constraints:
* Length: - 128
* Pattern: [\p{Upper}\p{Digit}_]+
* * @return

* (Optional)A reason code string that explains why the job was * canceled. *

*/ public String getReasonCode() { return reasonCode; } /** *

* (Optional)A reason code string that explains why the job was canceled. *

*

* Constraints:
* Length: - 128
* Pattern: [\p{Upper}\p{Digit}_]+
* * @param reasonCode

* (Optional)A reason code string that explains why the job was * canceled. *

*/ public void setReasonCode(String reasonCode) { this.reasonCode = reasonCode; } /** *

* (Optional)A reason code string that explains why the job was canceled. *

*

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

* Constraints:
* Length: - 128
* Pattern: [\p{Upper}\p{Digit}_]+
* * @param reasonCode

* (Optional)A reason code string that explains why the job was * canceled. *

* @return A reference to this updated object so that method calls can be * chained together. */ public CancelJobRequest withReasonCode(String reasonCode) { this.reasonCode = reasonCode; return this; } /** *

* An optional comment string describing why the job was canceled. *

*

* Constraints:
* Length: - 2028
* Pattern: [^\p{C}]+
* * @return

* An optional comment string describing why the job was canceled. *

*/ public String getComment() { return comment; } /** *

* An optional comment string describing why the job was canceled. *

*

* Constraints:
* Length: - 2028
* Pattern: [^\p{C}]+
* * @param comment

* An optional comment string describing why the job was * canceled. *

*/ public void setComment(String comment) { this.comment = comment; } /** *

* An optional comment string describing why the job was canceled. *

*

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

* Constraints:
* Length: - 2028
* Pattern: [^\p{C}]+
* * @param comment

* An optional comment string describing why the job was * canceled. *

* @return A reference to this updated object so that method calls can be * chained together. */ public CancelJobRequest withComment(String comment) { this.comment = comment; return this; } /** *

* (Optional) If true job executions with status "IN_PROGRESS" * and "QUEUED" are canceled, otherwise only job executions with status * "QUEUED" are canceled. The default is false. *

*

* Canceling a job which is "IN_PROGRESS", will cause a device which is * executing the job to be unable to update the job execution status. Use * caution and ensure that each device executing a job which is canceled is * able to recover to a valid state. *

* * @return

* (Optional) If true job executions with status * "IN_PROGRESS" and "QUEUED" are canceled, otherwise only job * executions with status "QUEUED" are canceled. The default is * false. *

*

* Canceling a job which is "IN_PROGRESS", will cause a device which * is executing the job to be unable to update the job execution * status. Use caution and ensure that each device executing a job * which is canceled is able to recover to a valid state. *

*/ public Boolean isForce() { return force; } /** *

* (Optional) If true job executions with status "IN_PROGRESS" * and "QUEUED" are canceled, otherwise only job executions with status * "QUEUED" are canceled. The default is false. *

*

* Canceling a job which is "IN_PROGRESS", will cause a device which is * executing the job to be unable to update the job execution status. Use * caution and ensure that each device executing a job which is canceled is * able to recover to a valid state. *

* * @return

* (Optional) If true job executions with status * "IN_PROGRESS" and "QUEUED" are canceled, otherwise only job * executions with status "QUEUED" are canceled. The default is * false. *

*

* Canceling a job which is "IN_PROGRESS", will cause a device which * is executing the job to be unable to update the job execution * status. Use caution and ensure that each device executing a job * which is canceled is able to recover to a valid state. *

*/ public Boolean getForce() { return force; } /** *

* (Optional) If true job executions with status "IN_PROGRESS" * and "QUEUED" are canceled, otherwise only job executions with status * "QUEUED" are canceled. The default is false. *

*

* Canceling a job which is "IN_PROGRESS", will cause a device which is * executing the job to be unable to update the job execution status. Use * caution and ensure that each device executing a job which is canceled is * able to recover to a valid state. *

* * @param force

* (Optional) If true job executions with status * "IN_PROGRESS" and "QUEUED" are canceled, otherwise only job * executions with status "QUEUED" are canceled. The default is * false. *

*

* Canceling a job which is "IN_PROGRESS", will cause a device * which is executing the job to be unable to update the job * execution status. Use caution and ensure that each device * executing a job which is canceled is able to recover to a * valid state. *

*/ public void setForce(Boolean force) { this.force = force; } /** *

* (Optional) If true job executions with status "IN_PROGRESS" * and "QUEUED" are canceled, otherwise only job executions with status * "QUEUED" are canceled. The default is false. *

*

* Canceling a job which is "IN_PROGRESS", will cause a device which is * executing the job to be unable to update the job execution status. Use * caution and ensure that each device executing a job which is canceled is * able to recover to a valid state. *

*

* Returns a reference to this object so that method calls can be chained * together. * * @param force

* (Optional) If true job executions with status * "IN_PROGRESS" and "QUEUED" are canceled, otherwise only job * executions with status "QUEUED" are canceled. The default is * false. *

*

* Canceling a job which is "IN_PROGRESS", will cause a device * which is executing the job to be unable to update the job * execution status. Use caution and ensure that each device * executing a job which is canceled is able to recover to a * valid state. *

* @return A reference to this updated object so that method calls can be * chained together. */ public CancelJobRequest withForce(Boolean force) { this.force = force; return this; } /** * Returns a string representation of this object; useful for testing and * debugging. * * @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: " + getJobId() + ","); if (getReasonCode() != null) sb.append("reasonCode: " + getReasonCode() + ","); if (getComment() != null) sb.append("comment: " + getComment() + ","); if (getForce() != null) sb.append("force: " + getForce()); sb.append("}"); return sb.toString(); } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getJobId() == null) ? 0 : getJobId().hashCode()); hashCode = prime * hashCode + ((getReasonCode() == null) ? 0 : getReasonCode().hashCode()); hashCode = prime * hashCode + ((getComment() == null) ? 0 : getComment().hashCode()); hashCode = prime * hashCode + ((getForce() == null) ? 0 : getForce().hashCode()); return hashCode; } @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.getReasonCode() == null ^ this.getReasonCode() == null) return false; if (other.getReasonCode() != null && other.getReasonCode().equals(this.getReasonCode()) == false) return false; if (other.getComment() == null ^ this.getComment() == null) return false; if (other.getComment() != null && other.getComment().equals(this.getComment()) == false) return false; if (other.getForce() == null ^ this.getForce() == null) return false; if (other.getForce() != null && other.getForce().equals(this.getForce()) == false) return false; return true; } }