com.amazonaws.services.iot.model.DeleteJobRequest Maven / Gradle / Ivy
/*
* Copyright 2015-2020 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 javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class DeleteJobRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The ID of the job to be deleted.
*
*
* After a job deletion is completed, you may reuse this jobId when you create a new job. However, this is not
* recommended, and you must ensure that your devices are not using the jobId to refer to the deleted job.
*
*/
private String jobId;
/**
*
* (Optional) When true, you can delete a job which is "IN_PROGRESS". Otherwise, you can only delete a job which is
* in a terminal state ("COMPLETED" or "CANCELED") or an exception will occur. The default is false.
*
*
*
* Deleting a job which is "IN_PROGRESS", will cause a device which is executing the job to be unable to access job
* information or update the job execution status. Use caution and ensure that each device executing a job which is
* deleted is able to recover to a valid state.
*
*
*/
private Boolean force;
/**
*
* The ID of the job to be deleted.
*
*
* After a job deletion is completed, you may reuse this jobId when you create a new job. However, this is not
* recommended, and you must ensure that your devices are not using the jobId to refer to the deleted job.
*
*
* @param jobId
* The ID of the job to be deleted.
*
* After a job deletion is completed, you may reuse this jobId when you create a new job. However, this is
* not recommended, and you must ensure that your devices are not using the jobId to refer to the deleted
* job.
*/
public void setJobId(String jobId) {
this.jobId = jobId;
}
/**
*
* The ID of the job to be deleted.
*
*
* After a job deletion is completed, you may reuse this jobId when you create a new job. However, this is not
* recommended, and you must ensure that your devices are not using the jobId to refer to the deleted job.
*
*
* @return The ID of the job to be deleted.
*
* After a job deletion is completed, you may reuse this jobId when you create a new job. However, this is
* not recommended, and you must ensure that your devices are not using the jobId to refer to the deleted
* job.
*/
public String getJobId() {
return this.jobId;
}
/**
*
* The ID of the job to be deleted.
*
*
* After a job deletion is completed, you may reuse this jobId when you create a new job. However, this is not
* recommended, and you must ensure that your devices are not using the jobId to refer to the deleted job.
*
*
* @param jobId
* The ID of the job to be deleted.
*
* After a job deletion is completed, you may reuse this jobId when you create a new job. However, this is
* not recommended, and you must ensure that your devices are not using the jobId to refer to the deleted
* job.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DeleteJobRequest withJobId(String jobId) {
setJobId(jobId);
return this;
}
/**
*
* (Optional) When true, you can delete a job which is "IN_PROGRESS". Otherwise, you can only delete a job which is
* in a terminal state ("COMPLETED" or "CANCELED") or an exception will occur. The default is false.
*
*
*
* Deleting a job which is "IN_PROGRESS", will cause a device which is executing the job to be unable to access job
* information or update the job execution status. Use caution and ensure that each device executing a job which is
* deleted is able to recover to a valid state.
*
*
*
* @param force
* (Optional) When true, you can delete a job which is "IN_PROGRESS". Otherwise, you can only delete a job
* which is in a terminal state ("COMPLETED" or "CANCELED") or an exception will occur. The default is
* false.
*
* Deleting a job which is "IN_PROGRESS", will cause a device which is executing the job to be unable to
* access job information or update the job execution status. Use caution and ensure that each device
* executing a job which is deleted is able to recover to a valid state.
*
*/
public void setForce(Boolean force) {
this.force = force;
}
/**
*
* (Optional) When true, you can delete a job which is "IN_PROGRESS". Otherwise, you can only delete a job which is
* in a terminal state ("COMPLETED" or "CANCELED") or an exception will occur. The default is false.
*
*
*
* Deleting a job which is "IN_PROGRESS", will cause a device which is executing the job to be unable to access job
* information or update the job execution status. Use caution and ensure that each device executing a job which is
* deleted is able to recover to a valid state.
*
*
*
* @return (Optional) When true, you can delete a job which is "IN_PROGRESS". Otherwise, you can only delete a job
* which is in a terminal state ("COMPLETED" or "CANCELED") or an exception will occur. The default is
* false.
*
* Deleting a job which is "IN_PROGRESS", will cause a device which is executing the job to be unable to
* access job information or update the job execution status. Use caution and ensure that each device
* executing a job which is deleted is able to recover to a valid state.
*
*/
public Boolean getForce() {
return this.force;
}
/**
*
* (Optional) When true, you can delete a job which is "IN_PROGRESS". Otherwise, you can only delete a job which is
* in a terminal state ("COMPLETED" or "CANCELED") or an exception will occur. The default is false.
*
*
*
* Deleting a job which is "IN_PROGRESS", will cause a device which is executing the job to be unable to access job
* information or update the job execution status. Use caution and ensure that each device executing a job which is
* deleted is able to recover to a valid state.
*
*
*
* @param force
* (Optional) When true, you can delete a job which is "IN_PROGRESS". Otherwise, you can only delete a job
* which is in a terminal state ("COMPLETED" or "CANCELED") or an exception will occur. The default is
* false.
*
* Deleting a job which is "IN_PROGRESS", will cause a device which is executing the job to be unable to
* access job information or update the job execution status. Use caution and ensure that each device
* executing a job which is deleted is able to recover to a valid state.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DeleteJobRequest withForce(Boolean force) {
setForce(force);
return this;
}
/**
*
* (Optional) When true, you can delete a job which is "IN_PROGRESS". Otherwise, you can only delete a job which is
* in a terminal state ("COMPLETED" or "CANCELED") or an exception will occur. The default is false.
*
*
*
* Deleting a job which is "IN_PROGRESS", will cause a device which is executing the job to be unable to access job
* information or update the job execution status. Use caution and ensure that each device executing a job which is
* deleted is able to recover to a valid state.
*
*
*
* @return (Optional) When true, you can delete a job which is "IN_PROGRESS". Otherwise, you can only delete a job
* which is in a terminal state ("COMPLETED" or "CANCELED") or an exception will occur. The default is
* false.
*
* Deleting a job which is "IN_PROGRESS", will cause a device which is executing the job to be unable to
* access job information or update the job execution status. Use caution and ensure that each device
* executing a job which is deleted is able to recover to a valid state.
*
*/
public Boolean isForce() {
return this.force;
}
/**
* 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 (getForce() != null)
sb.append("Force: ").append(getForce());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof DeleteJobRequest == false)
return false;
DeleteJobRequest other = (DeleteJobRequest) obj;
if (other.getJobId() == null ^ this.getJobId() == null)
return false;
if (other.getJobId() != null && other.getJobId().equals(this.getJobId()) == 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;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getJobId() == null) ? 0 : getJobId().hashCode());
hashCode = prime * hashCode + ((getForce() == null) ? 0 : getForce().hashCode());
return hashCode;
}
@Override
public DeleteJobRequest clone() {
return (DeleteJobRequest) super.clone();
}
}