Interface CreateOtaUpdateRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<CreateOtaUpdateRequest.Builder,
,CreateOtaUpdateRequest> IotRequest.Builder
,SdkBuilder<CreateOtaUpdateRequest.Builder,
,CreateOtaUpdateRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
CreateOtaUpdateRequest
-
Method Summary
Modifier and TypeMethodDescriptionadditionalParameters
(Map<String, String> additionalParameters) A list of additional OTA update parameters, which are name-value pairs.default CreateOtaUpdateRequest.Builder
awsJobAbortConfig
(Consumer<AwsJobAbortConfig.Builder> awsJobAbortConfig) The criteria that determine when and how a job abort takes place.awsJobAbortConfig
(AwsJobAbortConfig awsJobAbortConfig) The criteria that determine when and how a job abort takes place.default CreateOtaUpdateRequest.Builder
awsJobExecutionsRolloutConfig
(Consumer<AwsJobExecutionsRolloutConfig.Builder> awsJobExecutionsRolloutConfig) Configuration for the rollout of OTA updates.awsJobExecutionsRolloutConfig
(AwsJobExecutionsRolloutConfig awsJobExecutionsRolloutConfig) Configuration for the rollout of OTA updates.default CreateOtaUpdateRequest.Builder
awsJobPresignedUrlConfig
(Consumer<AwsJobPresignedUrlConfig.Builder> awsJobPresignedUrlConfig) Configuration information for pre-signed URLs.awsJobPresignedUrlConfig
(AwsJobPresignedUrlConfig awsJobPresignedUrlConfig) Configuration information for pre-signed URLs.default CreateOtaUpdateRequest.Builder
awsJobTimeoutConfig
(Consumer<AwsJobTimeoutConfig.Builder> awsJobTimeoutConfig) Specifies the amount of time each device has to finish its execution of the job.awsJobTimeoutConfig
(AwsJobTimeoutConfig awsJobTimeoutConfig) Specifies the amount of time each device has to finish its execution of the job.description
(String description) The description of the OTA update.files
(Collection<OTAUpdateFile> files) The files to be streamed by the OTA update.files
(Consumer<OTAUpdateFile.Builder>... files) The files to be streamed by the OTA update.files
(OTAUpdateFile... files) The files to be streamed by the OTA update.otaUpdateId
(String otaUpdateId) The ID of the OTA update to be created.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.protocols
(Collection<Protocol> protocols) The protocol used to transfer the OTA update image.The protocol used to transfer the OTA update image.protocolsWithStrings
(String... protocols) The protocol used to transfer the OTA update image.protocolsWithStrings
(Collection<String> protocols) The protocol used to transfer the OTA update image.The IAM role that grants Amazon Web Services IoT Core access to the Amazon S3, IoT jobs and Amazon Web Services Code Signing resources to create an OTA update job.tags
(Collection<Tag> tags) Metadata which can be used to manage updates.tags
(Consumer<Tag.Builder>... tags) Metadata which can be used to manage updates.Metadata which can be used to manage updates.The devices targeted to receive OTA updates.targets
(Collection<String> targets) The devices targeted to receive OTA updates.targetSelection
(String targetSelection) Specifies whether the update will continue to run (CONTINUOUS), or will be complete after all the things specified as targets have completed the update (SNAPSHOT).targetSelection
(TargetSelection targetSelection) Specifies whether the update will continue to run (CONTINUOUS), or will be complete after all the things specified as targets have completed the update (SNAPSHOT).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 be created.
- Parameters:
otaUpdateId
- The ID of the OTA update to be created.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
description
The description of the OTA update.
- Parameters:
description
- The description of the OTA update.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
targets
The devices targeted to receive OTA updates.
- Parameters:
targets
- The devices targeted to receive OTA updates.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
targets
The devices targeted to receive OTA updates.
- Parameters:
targets
- The devices targeted to receive OTA updates.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
protocolsWithStrings
The protocol used to transfer the OTA update image. Valid values are [HTTP], [MQTT], [HTTP, MQTT]. When both HTTP and MQTT are specified, the target device can choose the protocol.
- Parameters:
protocols
- The protocol used to transfer the OTA update image. Valid values are [HTTP], [MQTT], [HTTP, MQTT]. When both HTTP and MQTT are specified, the target device can choose the protocol.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
protocolsWithStrings
The protocol used to transfer the OTA update image. Valid values are [HTTP], [MQTT], [HTTP, MQTT]. When both HTTP and MQTT are specified, the target device can choose the protocol.
- Parameters:
protocols
- The protocol used to transfer the OTA update image. Valid values are [HTTP], [MQTT], [HTTP, MQTT]. When both HTTP and MQTT are specified, the target device can choose the protocol.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
protocols
The protocol used to transfer the OTA update image. Valid values are [HTTP], [MQTT], [HTTP, MQTT]. When both HTTP and MQTT are specified, the target device can choose the protocol.
- Parameters:
protocols
- The protocol used to transfer the OTA update image. Valid values are [HTTP], [MQTT], [HTTP, MQTT]. When both HTTP and MQTT are specified, the target device can choose the protocol.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
protocols
The protocol used to transfer the OTA update image. Valid values are [HTTP], [MQTT], [HTTP, MQTT]. When both HTTP and MQTT are specified, the target device can choose the protocol.
- Parameters:
protocols
- The protocol used to transfer the OTA update image. Valid values are [HTTP], [MQTT], [HTTP, MQTT]. When both HTTP and MQTT are specified, the target device can choose the protocol.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
targetSelection
Specifies whether the update will continue to run (CONTINUOUS), or will be complete after all the things specified as targets have completed the update (SNAPSHOT). If continuous, the update may also be run on a thing when a change is detected in a target. For example, an update will run on a thing when the thing is added to a target group, even after the update was completed by all things originally in the group. Valid values: CONTINUOUS | SNAPSHOT.
- Parameters:
targetSelection
- Specifies whether the update will continue to run (CONTINUOUS), or will be complete after all the things specified as targets have completed the update (SNAPSHOT). If continuous, the update may also be run on a thing when a change is detected in a target. For example, an update will run on a thing when the thing is added to a target group, even after the update was completed by all things originally in the group. Valid values: CONTINUOUS | SNAPSHOT.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
targetSelection
Specifies whether the update will continue to run (CONTINUOUS), or will be complete after all the things specified as targets have completed the update (SNAPSHOT). If continuous, the update may also be run on a thing when a change is detected in a target. For example, an update will run on a thing when the thing is added to a target group, even after the update was completed by all things originally in the group. Valid values: CONTINUOUS | SNAPSHOT.
- Parameters:
targetSelection
- Specifies whether the update will continue to run (CONTINUOUS), or will be complete after all the things specified as targets have completed the update (SNAPSHOT). If continuous, the update may also be run on a thing when a change is detected in a target. For example, an update will run on a thing when the thing is added to a target group, even after the update was completed by all things originally in the group. Valid values: CONTINUOUS | SNAPSHOT.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
awsJobExecutionsRolloutConfig
CreateOtaUpdateRequest.Builder awsJobExecutionsRolloutConfig(AwsJobExecutionsRolloutConfig awsJobExecutionsRolloutConfig) Configuration for the rollout of OTA updates.
- Parameters:
awsJobExecutionsRolloutConfig
- Configuration for the rollout of OTA updates.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
awsJobExecutionsRolloutConfig
default CreateOtaUpdateRequest.Builder awsJobExecutionsRolloutConfig(Consumer<AwsJobExecutionsRolloutConfig.Builder> awsJobExecutionsRolloutConfig) Configuration for the rollout of OTA updates.
This is a convenience method that creates an instance of theAwsJobExecutionsRolloutConfig.Builder
avoiding the need to create one manually viaAwsJobExecutionsRolloutConfig.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toawsJobExecutionsRolloutConfig(AwsJobExecutionsRolloutConfig)
.- Parameters:
awsJobExecutionsRolloutConfig
- a consumer that will call methods onAwsJobExecutionsRolloutConfig.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
awsJobPresignedUrlConfig
CreateOtaUpdateRequest.Builder awsJobPresignedUrlConfig(AwsJobPresignedUrlConfig awsJobPresignedUrlConfig) Configuration information for pre-signed URLs.
- Parameters:
awsJobPresignedUrlConfig
- Configuration information for pre-signed URLs.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
awsJobPresignedUrlConfig
default CreateOtaUpdateRequest.Builder awsJobPresignedUrlConfig(Consumer<AwsJobPresignedUrlConfig.Builder> awsJobPresignedUrlConfig) Configuration information for pre-signed URLs.
This is a convenience method that creates an instance of theAwsJobPresignedUrlConfig.Builder
avoiding the need to create one manually viaAwsJobPresignedUrlConfig.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toawsJobPresignedUrlConfig(AwsJobPresignedUrlConfig)
.- Parameters:
awsJobPresignedUrlConfig
- a consumer that will call methods onAwsJobPresignedUrlConfig.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
awsJobAbortConfig
The criteria that determine when and how a job abort takes place.
- Parameters:
awsJobAbortConfig
- The criteria that determine when and how a job abort takes place.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
awsJobAbortConfig
default CreateOtaUpdateRequest.Builder awsJobAbortConfig(Consumer<AwsJobAbortConfig.Builder> awsJobAbortConfig) The criteria that determine when and how a job abort takes place.
This is a convenience method that creates an instance of theAwsJobAbortConfig.Builder
avoiding the need to create one manually viaAwsJobAbortConfig.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toawsJobAbortConfig(AwsJobAbortConfig)
.- Parameters:
awsJobAbortConfig
- a consumer that will call methods onAwsJobAbortConfig.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
awsJobTimeoutConfig
Specifies the amount of time each device has to finish its execution of the job. A timer is started when the job execution status is set to
IN_PROGRESS
. If the job execution status is not set to another terminal state before the timer expires, it will be automatically set toTIMED_OUT
.- Parameters:
awsJobTimeoutConfig
- Specifies the amount of time each device has to finish its execution of the job. A timer is started when the job execution status is set toIN_PROGRESS
. If the job execution status is not set to another terminal state before the timer expires, it will be automatically set toTIMED_OUT
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
awsJobTimeoutConfig
default CreateOtaUpdateRequest.Builder awsJobTimeoutConfig(Consumer<AwsJobTimeoutConfig.Builder> awsJobTimeoutConfig) Specifies the amount of time each device has to finish its execution of the job. A timer is started when the job execution status is set to
This is a convenience method that creates an instance of theIN_PROGRESS
. If the job execution status is not set to another terminal state before the timer expires, it will be automatically set toTIMED_OUT
.AwsJobTimeoutConfig.Builder
avoiding the need to create one manually viaAwsJobTimeoutConfig.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toawsJobTimeoutConfig(AwsJobTimeoutConfig)
.- Parameters:
awsJobTimeoutConfig
- a consumer that will call methods onAwsJobTimeoutConfig.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
files
The files to be streamed by the OTA update.
- Parameters:
files
- The files to be streamed by the OTA update.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
files
The files to be streamed by the OTA update.
- Parameters:
files
- The files to be streamed by the OTA update.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
files
The files to be streamed by the OTA update.
This is a convenience method that creates an instance of theOTAUpdateFile.Builder
avoiding the need to create one manually viaOTAUpdateFile.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tofiles(List<OTAUpdateFile>)
.- Parameters:
files
- a consumer that will call methods onOTAUpdateFile.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
roleArn
The IAM role that grants Amazon Web Services IoT Core access to the Amazon S3, IoT jobs and Amazon Web Services Code Signing resources to create an OTA update job.
- Parameters:
roleArn
- The IAM role that grants Amazon Web Services IoT Core access to the Amazon S3, IoT jobs and Amazon Web Services Code Signing resources to create an OTA update job.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
additionalParameters
A list of additional OTA update parameters, which are name-value pairs. They won't be sent to devices as a part of the Job document.
- Parameters:
additionalParameters
- A list of additional OTA update parameters, which are name-value pairs. They won't be sent to devices as a part of the Job document.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
Metadata which can be used to manage updates.
- Parameters:
tags
- Metadata which can be used to manage updates.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
Metadata which can be used to manage updates.
- Parameters:
tags
- Metadata which can be used to manage updates.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
Metadata which can be used to manage updates.
This is a convenience method that creates an instance of theTag.Builder
avoiding the need to create one manually viaTag.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed totags(List<Tag>)
.- Parameters:
tags
- a consumer that will call methods onTag.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
overrideConfiguration
CreateOtaUpdateRequest.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
CreateOtaUpdateRequest.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.
-