com.amazonaws.services.iot.model

Class DeleteOTAUpdateRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.iot.model.DeleteOTAUpdateRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class DeleteOTAUpdateRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
DeleteOTAUpdateRequest()

Method Summary

Modifier and Type	Method and Description
DeleteOTAUpdateRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
Boolean	getDeleteStream() When true, the stream created by the OTAUpdate process is deleted when the OTA update is deleted.
Boolean	getForceDeleteAWSJob() When true, deletes the IoT job created by the OTAUpdate process even if it is "IN_PROGRESS".
String	getOtaUpdateId() The ID of the OTA update to delete.
int	hashCode()
Boolean	isDeleteStream() When true, the stream created by the OTAUpdate process is deleted when the OTA update is deleted.
Boolean	isForceDeleteAWSJob() When true, deletes the IoT job created by the OTAUpdate process even if it is "IN_PROGRESS".
void	setDeleteStream(Boolean deleteStream) When true, the stream created by the OTAUpdate process is deleted when the OTA update is deleted.
void	setForceDeleteAWSJob(Boolean forceDeleteAWSJob) When true, deletes the IoT job created by the OTAUpdate process even if it is "IN_PROGRESS".
void	setOtaUpdateId(String otaUpdateId) The ID of the OTA update to delete.
String	toString() Returns a string representation of this object.
DeleteOTAUpdateRequest	withDeleteStream(Boolean deleteStream) When true, the stream created by the OTAUpdate process is deleted when the OTA update is deleted.
DeleteOTAUpdateRequest	withForceDeleteAWSJob(Boolean forceDeleteAWSJob) When true, deletes the IoT job created by the OTAUpdate process even if it is "IN_PROGRESS".
DeleteOTAUpdateRequest	withOtaUpdateId(String otaUpdateId) The ID of the OTA update to delete.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DeleteOTAUpdateRequest

public DeleteOTAUpdateRequest()

Method Detail

setOtaUpdateId

public void setOtaUpdateId(String otaUpdateId)

The ID of the OTA update to delete.

Parameters:

otaUpdateId - The ID of the OTA update to delete.

getOtaUpdateId

public String getOtaUpdateId()

The ID of the OTA update to delete.

Returns:

The ID of the OTA update to delete.

withOtaUpdateId

public DeleteOTAUpdateRequest withOtaUpdateId(String otaUpdateId)

The ID of the OTA update to delete.

Parameters:

otaUpdateId - The ID of the OTA update to delete.

Returns:

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

setDeleteStream

public void setDeleteStream(Boolean deleteStream)

When true, the stream created by the OTAUpdate process is deleted when the OTA update is deleted. Ignored if the stream specified in the OTAUpdate is supplied by the user.

Parameters:

deleteStream - When true, the stream created by the OTAUpdate process is deleted when the OTA update is deleted. Ignored if the stream specified in the OTAUpdate is supplied by the user.

getDeleteStream

public Boolean getDeleteStream()

When true, the stream created by the OTAUpdate process is deleted when the OTA update is deleted. Ignored if the stream specified in the OTAUpdate is supplied by the user.

Returns:

When true, the stream created by the OTAUpdate process is deleted when the OTA update is deleted. Ignored if the stream specified in the OTAUpdate is supplied by the user.

withDeleteStream

public DeleteOTAUpdateRequest withDeleteStream(Boolean deleteStream)

When true, the stream created by the OTAUpdate process is deleted when the OTA update is deleted. Ignored if the stream specified in the OTAUpdate is supplied by the user.

Parameters:

deleteStream - When true, the stream created by the OTAUpdate process is deleted when the OTA update is deleted. Ignored if the stream specified in the OTAUpdate is supplied by the user.

Returns:

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

isDeleteStream

public Boolean isDeleteStream()

When true, the stream created by the OTAUpdate process is deleted when the OTA update is deleted. Ignored if the stream specified in the OTAUpdate is supplied by the user.

Returns:

When true, the stream created by the OTAUpdate process is deleted when the OTA update is deleted. Ignored if the stream specified in the OTAUpdate is supplied by the user.

setForceDeleteAWSJob

public void setForceDeleteAWSJob(Boolean forceDeleteAWSJob)

When true, deletes the IoT job created by the OTAUpdate process even if it is "IN_PROGRESS". Otherwise, if the job is not in a terminal state ("COMPLETED" or "CANCELED") an exception will occur. The default is false.

Parameters:

forceDeleteAWSJob - When true, deletes the IoT job created by the OTAUpdate process even if it is "IN_PROGRESS". Otherwise, if the job is not in a terminal state ("COMPLETED" or "CANCELED") an exception will occur. The default is false.

getForceDeleteAWSJob

public Boolean getForceDeleteAWSJob()

When true, deletes the IoT job created by the OTAUpdate process even if it is "IN_PROGRESS". Otherwise, if the job is not in a terminal state ("COMPLETED" or "CANCELED") an exception will occur. The default is false.

Returns:

When true, deletes the IoT job created by the OTAUpdate process even if it is "IN_PROGRESS". Otherwise, if the job is not in a terminal state ("COMPLETED" or "CANCELED") an exception will occur. The default is false.

withForceDeleteAWSJob

public DeleteOTAUpdateRequest withForceDeleteAWSJob(Boolean forceDeleteAWSJob)

When true, deletes the IoT job created by the OTAUpdate process even if it is "IN_PROGRESS". Otherwise, if the job is not in a terminal state ("COMPLETED" or "CANCELED") an exception will occur. The default is false.

Parameters:

forceDeleteAWSJob - When true, deletes the IoT job created by the OTAUpdate process even if it is "IN_PROGRESS". Otherwise, if the job is not in a terminal state ("COMPLETED" or "CANCELED") an exception will occur. The default is false.

Returns:

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

isForceDeleteAWSJob

public Boolean isForceDeleteAWSJob()

When true, deletes the IoT job created by the OTAUpdate process even if it is "IN_PROGRESS". Otherwise, if the job is not in a terminal state ("COMPLETED" or "CANCELED") an exception will occur. The default is false.

Returns:

When true, deletes the IoT job created by the OTAUpdate process even if it is "IN_PROGRESS". Otherwise, if the job is not in a terminal state ("COMPLETED" or "CANCELED") an exception will occur. The default is false.

toString

public String toString()

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.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public DeleteOTAUpdateRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()