Interface DeleteOtaUpdateRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<DeleteOtaUpdateRequest.Builder,
,DeleteOtaUpdateRequest> IotRequest.Builder
,SdkBuilder<DeleteOtaUpdateRequest.Builder,
,DeleteOtaUpdateRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
DeleteOtaUpdateRequest
public static interface DeleteOtaUpdateRequest.Builder
extends IotRequest.Builder, SdkPojo, CopyableBuilder<DeleteOtaUpdateRequest.Builder,DeleteOtaUpdateRequest>
-
Method Summary
Modifier and TypeMethodDescriptiondeleteStream
(Boolean deleteStream) When true, the stream created by the OTAUpdate process is deleted when the OTA update is deleted.forceDeleteAWSJob
(Boolean forceDeleteAWSJob) When true, deletes the IoT job created by the OTAUpdate process even if it is "IN_PROGRESS".otaUpdateId
(String otaUpdateId) The ID of the OTA update to delete.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.iot.model.IotRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
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.
-
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.
-
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.
-
overrideConfiguration
DeleteOtaUpdateRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
DeleteOtaUpdateRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-