DeleteJobExecutionRequest (AWS SDK for Android

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.iot.model.DeleteJobExecutionRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable
```
public class DeleteJobExecutionRequest
extends AmazonWebServiceRequest
implements java.io.Serializable
```
Deletes a job execution.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

DeleteJobExecutionRequest()

Constructors
Constructor and Description
`DeleteJobExecutionRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object obj)`
`java.lang.Long`	`getExecutionNumber()` The ID of the job execution to be deleted.
`java.lang.Boolean`	`getForce()` (Optional) When true, you can delete a job execution which is "IN_PROGRESS".
`java.lang.String`	`getJobId()` The ID of the job whose execution on a particular device will be deleted.
`java.lang.String`	`getNamespaceId()` The namespace used to indicate that a job is a customer-managed job.
`java.lang.String`	`getThingName()` The name of the thing whose job execution will be deleted.
`int`	`hashCode()`
`java.lang.Boolean`	`isForce()` (Optional) When true, you can delete a job execution which is "IN_PROGRESS".
`void`	`setExecutionNumber(java.lang.Long executionNumber)` The ID of the job execution to be deleted.
`void`	`setForce(java.lang.Boolean force)` (Optional) When true, you can delete a job execution which is "IN_PROGRESS".
`void`	`setJobId(java.lang.String jobId)` The ID of the job whose execution on a particular device will be deleted.
`void`	`setNamespaceId(java.lang.String namespaceId)` The namespace used to indicate that a job is a customer-managed job.
`void`	`setThingName(java.lang.String thingName)` The name of the thing whose job execution will be deleted.
`java.lang.String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`DeleteJobExecutionRequest`	`withExecutionNumber(java.lang.Long executionNumber)` The ID of the job execution to be deleted.
`DeleteJobExecutionRequest`	`withForce(java.lang.Boolean force)` (Optional) When true, you can delete a job execution which is "IN_PROGRESS".
`DeleteJobExecutionRequest`	`withJobId(java.lang.String jobId)` The ID of the job whose execution on a particular device will be deleted.
`DeleteJobExecutionRequest`	`withNamespaceId(java.lang.String namespaceId)` The namespace used to indicate that a job is a customer-managed job.
`DeleteJobExecutionRequest`	`withThingName(java.lang.String thingName)` The name of the thing whose job execution will be deleted.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest
clone, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - DeleteJobExecutionRequest
```
public DeleteJobExecutionRequest()
```
- Method Detail
  - getJobId
```
public java.lang.String getJobId()
```
    The ID of the job whose execution on a particular device will be deleted.
    
    Constraints:
    Length: 1 - 64
    Pattern: [a-zA-Z0-9_-]+
    
    Returns:
    
    The ID of the job whose execution on a particular device will be deleted.
  - setJobId
```
public void setJobId(java.lang.String jobId)
```
    The ID of the job whose execution on a particular device will be deleted.
    
    Constraints:
    Length: 1 - 64
    Pattern: [a-zA-Z0-9_-]+
    
    Parameters:
    
    jobId -
    The ID of the job whose execution on a particular device will be deleted.
  - withJobId
```
public DeleteJobExecutionRequest withJobId(java.lang.String 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_-]+
    
    Parameters:
    
    jobId -
    The ID of the job whose execution on a particular device will be deleted.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getThingName
```
public java.lang.String getThingName()
```
    The name of the thing whose job execution will be deleted.
    
    Constraints:
    Length: 1 - 128
    Pattern: [a-zA-Z0-9:_-]+
    
    Returns:
    
    The name of the thing whose job execution will be deleted.
  - setThingName
```
public void setThingName(java.lang.String thingName)
```
    The name of the thing whose job execution will be deleted.
    
    Constraints:
    Length: 1 - 128
    Pattern: [a-zA-Z0-9:_-]+
    
    Parameters:
    
    thingName -
    The name of the thing whose job execution will be deleted.
  - withThingName
```
public DeleteJobExecutionRequest withThingName(java.lang.String 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:_-]+
    
    Parameters:
    
    thingName -
    The name of the thing whose job execution will be deleted.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getExecutionNumber
```
public java.lang.Long getExecutionNumber()
```
    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:
    
    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.
  - setExecutionNumber
```
public void setExecutionNumber(java.lang.Long 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.
    
    Parameters:
    
    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.
  - withExecutionNumber
```
public DeleteJobExecutionRequest withExecutionNumber(java.lang.Long 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.
    
    Parameters:
    
    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 updated object so that method calls can be chained together.
  - isForce
```
public java.lang.Boolean isForce()
```
    (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:
    
    (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.
  - getForce
```
public java.lang.Boolean getForce()
```
    (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:
    
    (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.
  - setForce
```
public void setForce(java.lang.Boolean 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.
    
    Parameters:
    
    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.
  - withForce
```
public DeleteJobExecutionRequest withForce(java.lang.Boolean 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.
    
    Parameters:
    
    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 updated object so that method calls can be chained together.
  - getNamespaceId
```
public java.lang.String getNamespaceId()
```
    The namespace used to indicate that a job is a customer-managed job.
    
    When you specify a value for this parameter, AWS 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:
    Length: 1 - 64
    Pattern: [a-zA-Z0-9_-]+
    
    Returns:
    
    The namespace used to indicate that a job is a customer-managed job.
    
    When you specify a value for this parameter, AWS 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.
  - setNamespaceId
```
public void setNamespaceId(java.lang.String namespaceId)
```
    The namespace used to indicate that a job is a customer-managed job.
    
    When you specify a value for this parameter, AWS 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:
    Length: 1 - 64
    Pattern: [a-zA-Z0-9_-]+
    
    Parameters:
    
    namespaceId -
    The namespace used to indicate that a job is a customer-managed job.
    
    When you specify a value for this parameter, AWS 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.
  - withNamespaceId
```
public DeleteJobExecutionRequest withNamespaceId(java.lang.String namespaceId)
```
    The namespace used to indicate that a job is a customer-managed job.
    
    When you specify a value for this parameter, AWS 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:
    Length: 1 - 64
    Pattern: [a-zA-Z0-9_-]+
    
    Parameters:
    
    namespaceId -
    The namespace used to indicate that a job is a customer-managed job.
    
    When you specify a value for this parameter, AWS 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 updated object so that method calls can be chained together.
  - toString
```
public java.lang.String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object

Class DeleteJobExecutionRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

DeleteJobExecutionRequest

Method Detail

getJobId

setJobId

withJobId

getThingName

setThingName

withThingName

getExecutionNumber

setExecutionNumber

withExecutionNumber

isForce

getForce

setForce

withForce

getNamespaceId

setNamespaceId

withNamespaceId

toString

hashCode

equals