Package software.amazon.awssdk.services.iot.model

Class DeleteOtaUpdateRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.iot.model.IotRequest

software.amazon.awssdk.services.iot.model.DeleteOtaUpdateRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DeleteOtaUpdateRequest.Builder,DeleteOtaUpdateRequest>

@Generated("software.amazon.awssdk:codegen")
public final class DeleteOtaUpdateRequest
extends IotRequest
implements ToCopyableBuilder<DeleteOtaUpdateRequest.Builder,DeleteOtaUpdateRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DeleteOtaUpdateRequest.Builder

Method Summary

Modifier and Type	Method	Description
static DeleteOtaUpdateRequest.Builder	builder()
Boolean	deleteStream()	When true, the stream created by the OTAUpdate process is deleted when the OTA update is deleted.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
Boolean	forceDeleteAWSJob()	When true, deletes the IoT job created by the OTAUpdate process even if it is "IN_PROGRESS".
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	otaUpdateId()	The ID of the OTA update to delete.
List<SdkField<?>>	sdkFields()
static Class<? extends DeleteOtaUpdateRequest.Builder>	serializableBuilderClass()
DeleteOtaUpdateRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

otaUpdateId

public final String otaUpdateId()

The ID of the OTA update to delete.

Returns:

The ID of the OTA update to delete.

deleteStream

public final 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.

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.

forceDeleteAWSJob

public final 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.

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.

toBuilder

public DeleteOtaUpdateRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DeleteOtaUpdateRequest.Builder,DeleteOtaUpdateRequest>

Specified by:

toBuilder in class IotRequest

builder

public static DeleteOtaUpdateRequest.Builder builder()

serializableBuilderClass

public static Class<? extends DeleteOtaUpdateRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo