com.amazonaws.services.iot.model.DeleteJobExecutionRequest 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 DeleteJobExecutionRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The ID of the job whose execution on a particular device will be deleted.
*
*/
private String jobId;
/**
*
* The name of the thing whose job execution will be deleted.
*
*/
private String thingName;
/**
*
* The ID of the job execution to be deleted. The executionNumber refers to the execution of a
* particular job on a particular device.
*
*
* Note that once a job execution is deleted, the executionNumber may be reused by IoT, so be sure you
* get and use the correct value here.
*
*/
private Long executionNumber;
/**
*
* (Optional) When true, you can delete a job execution which is "IN_PROGRESS". Otherwise, you can only delete a job
* execution which is in a terminal state ("SUCCEEDED", "FAILED", "REJECTED", "REMOVED" or "CANCELED") or an
* exception will occur. The default is false.
*
*
*
* Deleting a job execution which is "IN_PROGRESS", will cause the device to be unable to access job information or
* update the job execution status. Use caution and ensure that the device is able to recover to a valid state.
*
*
*/
private Boolean force;
/**
*
* The ID of the job whose execution on a particular device will be deleted.
*
*
* @param jobId
* The ID of the job whose execution on a particular device will be deleted.
*/
public void setJobId(String jobId) {
this.jobId = jobId;
}
/**
*
* The ID of the job whose execution on a particular device will be deleted.
*
*
* @return The ID of the job whose execution on a particular device will be deleted.
*/
public String getJobId() {
return this.jobId;
}
/**
*
* The ID of the job whose execution on a particular device will be deleted.
*
*
* @param jobId
* The ID of the job whose execution on a particular device will be deleted.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DeleteJobExecutionRequest withJobId(String jobId) {
setJobId(jobId);
return this;
}
/**
*
* The name of the thing whose job execution will be deleted.
*
*
* @param thingName
* The name of the thing whose job execution will be deleted.
*/
public void setThingName(String thingName) {
this.thingName = thingName;
}
/**
*
* The name of the thing whose job execution will be deleted.
*
*
* @return The name of the thing whose job execution will be deleted.
*/
public String getThingName() {
return this.thingName;
}
/**
*
* The name of the thing whose job execution will be deleted.
*
*
* @param thingName
* The name of the thing whose job execution will be deleted.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DeleteJobExecutionRequest withThingName(String thingName) {
setThingName(thingName);
return this;
}
/**
*
* The ID of the job execution to be deleted. The executionNumber refers to the execution of a
* particular job on a particular device.
*
*
* Note that once a job execution is deleted, the executionNumber may be reused by IoT, so be sure you
* get and use the correct value here.
*
*
* @param executionNumber
* The ID of the job execution to be deleted. The executionNumber refers to the execution of a
* particular job on a particular device.
*
* Note that once a job execution is deleted, the executionNumber may be reused by IoT, so be
* sure you get and use the correct value here.
*/
public void setExecutionNumber(Long executionNumber) {
this.executionNumber = executionNumber;
}
/**
*
* The ID of the job execution to be deleted. The executionNumber refers to the execution of a
* particular job on a particular device.
*
*
* Note that once a job execution is deleted, the executionNumber may be reused by IoT, so be sure you
* get and use the correct value here.
*
*
* @return The ID of the job execution to be deleted. The executionNumber refers to the execution of a
* particular job on a particular device.
*
* Note that once a job execution is deleted, the executionNumber may be reused by IoT, so be
* sure you get and use the correct value here.
*/
public Long getExecutionNumber() {
return this.executionNumber;
}
/**
*
* The ID of the job execution to be deleted. The executionNumber refers to the execution of a
* particular job on a particular device.
*
*
* Note that once a job execution is deleted, the executionNumber may be reused by IoT, so be sure you
* get and use the correct value here.
*
*
* @param executionNumber
* The ID of the job execution to be deleted. The executionNumber refers to the execution of a
* particular job on a particular device.
*
* Note that once a job execution is deleted, the executionNumber may be reused by IoT, so be
* sure you get and use the correct value here.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DeleteJobExecutionRequest withExecutionNumber(Long executionNumber) {
setExecutionNumber(executionNumber);
return this;
}
/**
*
* (Optional) When true, you can delete a job execution which is "IN_PROGRESS". Otherwise, you can only delete a job
* execution which is in a terminal state ("SUCCEEDED", "FAILED", "REJECTED", "REMOVED" or "CANCELED") or an
* exception will occur. The default is false.
*
*
*
* Deleting a job execution which is "IN_PROGRESS", will cause the device to be unable to access job information or
* update the job execution status. Use caution and ensure that the device is able to recover to a valid state.
*
*
*
* @param force
* (Optional) When true, you can delete a job execution which is "IN_PROGRESS". Otherwise, you can only
* delete a job execution which is in a terminal state ("SUCCEEDED", "FAILED", "REJECTED", "REMOVED" or
* "CANCELED") or an exception will occur. The default is false.
*
* Deleting a job execution which is "IN_PROGRESS", will cause the device to be unable to access job
* information or update the job execution status. Use caution and ensure that the device is able to recover
* to a valid state.
*
*/
public void setForce(Boolean force) {
this.force = force;
}
/**
*
* (Optional) When true, you can delete a job execution which is "IN_PROGRESS". Otherwise, you can only delete a job
* execution which is in a terminal state ("SUCCEEDED", "FAILED", "REJECTED", "REMOVED" or "CANCELED") or an
* exception will occur. The default is false.
*
*
*
* Deleting a job execution which is "IN_PROGRESS", will cause the device to be unable to access job information or
* update the job execution status. Use caution and ensure that the device is able to recover to a valid state.
*
*
*
* @return (Optional) When true, you can delete a job execution which is "IN_PROGRESS". Otherwise, you can only
* delete a job execution which is in a terminal state ("SUCCEEDED", "FAILED", "REJECTED", "REMOVED" or
* "CANCELED") or an exception will occur. The default is false.
*
* Deleting a job execution which is "IN_PROGRESS", will cause the device to be unable to access job
* information or update the job execution status. Use caution and ensure that the device is able to recover
* to a valid state.
*
*/
public Boolean getForce() {
return this.force;
}
/**
*
* (Optional) When true, you can delete a job execution which is "IN_PROGRESS". Otherwise, you can only delete a job
* execution which is in a terminal state ("SUCCEEDED", "FAILED", "REJECTED", "REMOVED" or "CANCELED") or an
* exception will occur. The default is false.
*
*
*
* Deleting a job execution which is "IN_PROGRESS", will cause the device to be unable to access job information or
* update the job execution status. Use caution and ensure that the device is able to recover to a valid state.
*
*
*
* @param force
* (Optional) When true, you can delete a job execution which is "IN_PROGRESS". Otherwise, you can only
* delete a job execution which is in a terminal state ("SUCCEEDED", "FAILED", "REJECTED", "REMOVED" or
* "CANCELED") or an exception will occur. The default is false.
*
* Deleting a job execution which is "IN_PROGRESS", will cause the device to be unable to access job
* information or update the job execution status. Use caution and ensure that the device is able to recover
* to a valid state.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DeleteJobExecutionRequest withForce(Boolean force) {
setForce(force);
return this;
}
/**
*
* (Optional) When true, you can delete a job execution which is "IN_PROGRESS". Otherwise, you can only delete a job
* execution which is in a terminal state ("SUCCEEDED", "FAILED", "REJECTED", "REMOVED" or "CANCELED") or an
* exception will occur. The default is false.
*
*
*
* Deleting a job execution which is "IN_PROGRESS", will cause the device to be unable to access job information or
* update the job execution status. Use caution and ensure that the device is able to recover to a valid state.
*
*
*
* @return (Optional) When true, you can delete a job execution which is "IN_PROGRESS". Otherwise, you can only
* delete a job execution which is in a terminal state ("SUCCEEDED", "FAILED", "REJECTED", "REMOVED" or
* "CANCELED") or an exception will occur. The default is false.
*
* Deleting a job execution which is "IN_PROGRESS", will cause the device to be unable to access job
* information or update the job execution status. Use caution and ensure that the device 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 (getThingName() != null)
sb.append("ThingName: ").append(getThingName()).append(",");
if (getExecutionNumber() != null)
sb.append("ExecutionNumber: ").append(getExecutionNumber()).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 DeleteJobExecutionRequest == false)
return false;
DeleteJobExecutionRequest other = (DeleteJobExecutionRequest) obj;
if (other.getJobId() == null ^ this.getJobId() == null)
return false;
if (other.getJobId() != null && other.getJobId().equals(this.getJobId()) == false)
return false;
if (other.getThingName() == null ^ this.getThingName() == null)
return false;
if (other.getThingName() != null && other.getThingName().equals(this.getThingName()) == false)
return false;
if (other.getExecutionNumber() == null ^ this.getExecutionNumber() == null)
return false;
if (other.getExecutionNumber() != null && other.getExecutionNumber().equals(this.getExecutionNumber()) == 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 + ((getThingName() == null) ? 0 : getThingName().hashCode());
hashCode = prime * hashCode + ((getExecutionNumber() == null) ? 0 : getExecutionNumber().hashCode());
hashCode = prime * hashCode + ((getForce() == null) ? 0 : getForce().hashCode());
return hashCode;
}
@Override
public DeleteJobExecutionRequest clone() {
return (DeleteJobExecutionRequest) super.clone();
}
}