/* * 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; /** *

* Deletes a job execution. *

*

* Requires permission to access the DeleteJobExecution action. *

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

* The ID of the job whose execution on a particular device will be deleted. *

*

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

* The name of the thing whose job execution will be deleted. *

*

* Constraints:
* Length: 1 - 128
* Pattern: [a-zA-Z0-9:_-]+
*/ 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 namespace used to indicate that a job is a customer-managed job. *

*

* When you specify a value for this parameter, Amazon Web Services IoT Core * sends jobs notifications to MQTT topics that contain the value in the * following format. *

*

* $aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/ *

* *

* The namespaceId feature is in public preview. *

* *

* Constraints:
* Pattern: [a-zA-Z0-9_-]+
*/ private String namespaceId; /** *

* The ID of the job whose execution on a particular device will be deleted. *

*

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

* The ID of the job whose execution on a particular device will be * deleted. *

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

* The ID of the job whose execution on a particular device will be deleted. *

*

* Constraints:
* Length: 1 - 64
* Pattern: [a-zA-Z0-9_-]+
* * @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. *

*

* 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 ID of the job whose execution on a particular device will * be deleted. *

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

* The name of the thing whose job execution will be deleted. *

*

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

* The name of the thing whose job execution will be deleted. *

*/ public String getThingName() { return thingName; } /** *

* The name of the thing whose job execution will be deleted. *

*

* Constraints:
* Length: 1 - 128
* Pattern: [a-zA-Z0-9:_-]+
* * @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. *

*

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

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

* The name of the thing whose job execution will be deleted. *

* @return A reference to this updated object so that method calls can be * chained together. */ public DeleteJobExecutionRequest withThingName(String thingName) { this.thingName = 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. *

* * @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 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. *

*/ 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. *

*

* Returns a reference to this object so that method calls can be chained * together. * * @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 A reference to this updated object so that method calls can be * chained together. */ public DeleteJobExecutionRequest withExecutionNumber(Long executionNumber) { this.executionNumber = 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. *

* * * @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 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 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. *

* */ 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. *

* *

* Returns a reference to this object so that method calls can be chained * together. * * @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 A reference to this updated object so that method calls can be * chained together. */ public DeleteJobExecutionRequest withForce(Boolean force) { this.force = force; return this; } /** *

* The namespace used to indicate that a job is a customer-managed job. *

*

* When you specify a value for this parameter, Amazon Web Services IoT Core * sends jobs notifications to MQTT topics that contain the value in the * following format. *

*

* $aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/ *

* *

* The namespaceId feature is in public preview. *

* *

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

* The namespace used to indicate that a job is a customer-managed * job. *

*

* When you specify a value for this parameter, Amazon Web Services * IoT Core sends jobs notifications to MQTT topics that contain the * value in the following format. *

*

* $aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/ *

* *

* The namespaceId feature is in public preview. *

* */ public String getNamespaceId() { return namespaceId; } /** *

* The namespace used to indicate that a job is a customer-managed job. *

*

* When you specify a value for this parameter, Amazon Web Services IoT Core * sends jobs notifications to MQTT topics that contain the value in the * following format. *

*

* $aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/ *

* *

* The namespaceId feature is in public preview. *

* *

* Constraints:
* Pattern: [a-zA-Z0-9_-]+
* * @param namespaceId

* The namespace used to indicate that a job is a * customer-managed job. *

*

* When you specify a value for this parameter, Amazon Web * Services IoT Core sends jobs notifications to MQTT topics that * contain the value in the following format. *

*

* $aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/ *

* *

* The namespaceId feature is in public preview. *

* */ public void setNamespaceId(String namespaceId) { this.namespaceId = namespaceId; } /** *

* The namespace used to indicate that a job is a customer-managed job. *

*

* When you specify a value for this parameter, Amazon Web Services IoT Core * sends jobs notifications to MQTT topics that contain the value in the * following format. *

*

* $aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/ *

* *

* The namespaceId feature is in public preview. *

* *

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

* Constraints:
* Pattern: [a-zA-Z0-9_-]+
* * @param namespaceId

* The namespace used to indicate that a job is a * customer-managed job. *

*

* When you specify a value for this parameter, Amazon Web * Services IoT Core sends jobs notifications to MQTT topics that * contain the value in the following format. *

*

* $aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/ *

* *

* The namespaceId feature is in public preview. *

* * @return A reference to this updated object so that method calls can be * chained together. */ public DeleteJobExecutionRequest withNamespaceId(String namespaceId) { this.namespaceId = namespaceId; 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 (getThingName() != null) sb.append("thingName: " + getThingName() + ","); if (getExecutionNumber() != null) sb.append("executionNumber: " + getExecutionNumber() + ","); if (getForce() != null) sb.append("force: " + getForce() + ","); if (getNamespaceId() != null) sb.append("namespaceId: " + getNamespaceId()); 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 + ((getThingName() == null) ? 0 : getThingName().hashCode()); hashCode = prime * hashCode + ((getExecutionNumber() == null) ? 0 : getExecutionNumber().hashCode()); hashCode = prime * hashCode + ((getForce() == null) ? 0 : getForce().hashCode()); hashCode = prime * hashCode + ((getNamespaceId() == null) ? 0 : getNamespaceId().hashCode()); return hashCode; } @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; if (other.getNamespaceId() == null ^ this.getNamespaceId() == null) return false; if (other.getNamespaceId() != null && other.getNamespaceId().equals(this.getNamespaceId()) == false) return false; return true; } }