software.amazon.awssdk.services.iot.model

Interface OTAUpdateInfo.Builder

All Superinterfaces:

Buildable, CopyableBuilder<OTAUpdateInfo.Builder,OTAUpdateInfo>, SdkBuilder<OTAUpdateInfo.Builder,OTAUpdateInfo>, SdkPojo

Enclosing class:

OTAUpdateInfo

public static interface OTAUpdateInfo.Builder
extends SdkPojo, CopyableBuilder<OTAUpdateInfo.Builder,OTAUpdateInfo>

Method Summary

Modifier and Type	Method and Description
OTAUpdateInfo.Builder	additionalParameters(Map<String,String> additionalParameters) A collection of name/value pairs
OTAUpdateInfo.Builder	awsIotJobArn(String awsIotJobArn) The IoT job ARN associated with the OTA update.
OTAUpdateInfo.Builder	awsIotJobId(String awsIotJobId) The IoT job ID associated with the OTA update.
OTAUpdateInfo.Builder	awsJobExecutionsRolloutConfig(AwsJobExecutionsRolloutConfig awsJobExecutionsRolloutConfig) Configuration for the rollout of OTA updates.
default OTAUpdateInfo.Builder	awsJobExecutionsRolloutConfig(Consumer<AwsJobExecutionsRolloutConfig.Builder> awsJobExecutionsRolloutConfig) Configuration for the rollout of OTA updates.
OTAUpdateInfo.Builder	awsJobPresignedUrlConfig(AwsJobPresignedUrlConfig awsJobPresignedUrlConfig) Configuration information for pre-signed URLs.
default OTAUpdateInfo.Builder	awsJobPresignedUrlConfig(Consumer<AwsJobPresignedUrlConfig.Builder> awsJobPresignedUrlConfig) Configuration information for pre-signed URLs.
OTAUpdateInfo.Builder	creationDate(Instant creationDate) The date when the OTA update was created.
OTAUpdateInfo.Builder	description(String description) A description of the OTA update.
default OTAUpdateInfo.Builder	errorInfo(Consumer<ErrorInfo.Builder> errorInfo) Error information associated with the OTA update.
OTAUpdateInfo.Builder	errorInfo(ErrorInfo errorInfo) Error information associated with the OTA update.
OTAUpdateInfo.Builder	lastModifiedDate(Instant lastModifiedDate) The date when the OTA update was last updated.
OTAUpdateInfo.Builder	otaUpdateArn(String otaUpdateArn) The OTA update ARN.
OTAUpdateInfo.Builder	otaUpdateFiles(Collection<OTAUpdateFile> otaUpdateFiles) A list of files associated with the OTA update.
OTAUpdateInfo.Builder	otaUpdateFiles(Consumer<OTAUpdateFile.Builder>... otaUpdateFiles) A list of files associated with the OTA update.
OTAUpdateInfo.Builder	otaUpdateFiles(OTAUpdateFile... otaUpdateFiles) A list of files associated with the OTA update.
OTAUpdateInfo.Builder	otaUpdateId(String otaUpdateId) The OTA update ID.
OTAUpdateInfo.Builder	otaUpdateStatus(OTAUpdateStatus otaUpdateStatus) The status of the OTA update.
OTAUpdateInfo.Builder	otaUpdateStatus(String otaUpdateStatus) The status of the OTA update.
OTAUpdateInfo.Builder	protocols(Collection<Protocol> protocols) The protocol used to transfer the OTA update image.
OTAUpdateInfo.Builder	protocols(Protocol... protocols) The protocol used to transfer the OTA update image.
OTAUpdateInfo.Builder	protocolsWithStrings(Collection<String> protocols) The protocol used to transfer the OTA update image.
OTAUpdateInfo.Builder	protocolsWithStrings(String... protocols) The protocol used to transfer the OTA update image.
OTAUpdateInfo.Builder	targets(Collection<String> targets) The targets of the OTA update.
OTAUpdateInfo.Builder	targets(String... targets) The targets of the OTA update.
OTAUpdateInfo.Builder	targetSelection(String targetSelection) Specifies whether the OTA update will continue to run (CONTINUOUS), or will be complete after all those things specified as targets have completed the OTA update (SNAPSHOT).
OTAUpdateInfo.Builder	targetSelection(TargetSelection targetSelection) Specifies whether the OTA update will continue to run (CONTINUOUS), or will be complete after all those things specified as targets have completed the OTA update (SNAPSHOT).

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

otaUpdateId

OTAUpdateInfo.Builder otaUpdateId(String otaUpdateId)

The OTA update ID.

Parameters:

otaUpdateId - The OTA update ID.

Returns:

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

otaUpdateArn

OTAUpdateInfo.Builder otaUpdateArn(String otaUpdateArn)

The OTA update ARN.

Parameters:

otaUpdateArn - The OTA update ARN.

Returns:

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

creationDate

OTAUpdateInfo.Builder creationDate(Instant creationDate)

The date when the OTA update was created.

Parameters:

creationDate - The date when the OTA update was created.

Returns:

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

lastModifiedDate

OTAUpdateInfo.Builder lastModifiedDate(Instant lastModifiedDate)

The date when the OTA update was last updated.

Parameters:

lastModifiedDate - The date when the OTA update was last updated.

Returns:

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

description

OTAUpdateInfo.Builder description(String description)

A description of the OTA update.

Parameters:

description - A description of the OTA update.

Returns:

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

targets

OTAUpdateInfo.Builder targets(Collection<String> targets)

The targets of the OTA update.

Parameters:

targets - The targets of the OTA update.

Returns:

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

targets

OTAUpdateInfo.Builder targets(String... targets)

The targets of the OTA update.

Parameters:

targets - The targets of the OTA update.

Returns:

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

protocolsWithStrings

OTAUpdateInfo.Builder protocolsWithStrings(Collection<String> 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.

protocolsWithStrings

OTAUpdateInfo.Builder protocolsWithStrings(String... 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

OTAUpdateInfo.Builder protocols(Collection<Protocol> 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

OTAUpdateInfo.Builder protocols(Protocol... 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.

awsJobExecutionsRolloutConfig

OTAUpdateInfo.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 OTAUpdateInfo.Builder awsJobExecutionsRolloutConfig(Consumer<AwsJobExecutionsRolloutConfig.Builder> awsJobExecutionsRolloutConfig)

Configuration for the rollout of OTA updates.

This is a convenience method that creates an instance of the AwsJobExecutionsRolloutConfig.Builder avoiding the need to create one manually via AwsJobExecutionsRolloutConfig.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to awsJobExecutionsRolloutConfig(AwsJobExecutionsRolloutConfig).

Parameters:

awsJobExecutionsRolloutConfig - a consumer that will call methods on AwsJobExecutionsRolloutConfig.Builder

Returns:

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

See Also:

awsJobExecutionsRolloutConfig(AwsJobExecutionsRolloutConfig)

awsJobPresignedUrlConfig

OTAUpdateInfo.Builder awsJobPresignedUrlConfig(AwsJobPresignedUrlConfig awsJobPresignedUrlConfig)

Configuration information for pre-signed URLs. Valid when protocols contains HTTP.

Parameters:

awsJobPresignedUrlConfig - Configuration information for pre-signed URLs. Valid when protocols contains HTTP.

Returns:

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

awsJobPresignedUrlConfig

default OTAUpdateInfo.Builder awsJobPresignedUrlConfig(Consumer<AwsJobPresignedUrlConfig.Builder> awsJobPresignedUrlConfig)

Configuration information for pre-signed URLs. Valid when protocols contains HTTP.

This is a convenience method that creates an instance of the AwsJobPresignedUrlConfig.Builder avoiding the need to create one manually via AwsJobPresignedUrlConfig.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to awsJobPresignedUrlConfig(AwsJobPresignedUrlConfig).

Parameters:

awsJobPresignedUrlConfig - a consumer that will call methods on AwsJobPresignedUrlConfig.Builder

Returns:

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

See Also:

awsJobPresignedUrlConfig(AwsJobPresignedUrlConfig)

targetSelection

OTAUpdateInfo.Builder targetSelection(String targetSelection)

Specifies whether the OTA update will continue to run (CONTINUOUS), or will be complete after all those things specified as targets have completed the OTA update (SNAPSHOT). If continuous, the OTA update may also be run on a thing when a change is detected in a target. For example, an OTA update will run on a thing when the thing is added to a target group, even after the OTA update was completed by all things originally in the group.

Parameters:

targetSelection - Specifies whether the OTA update will continue to run (CONTINUOUS), or will be complete after all those things specified as targets have completed the OTA update (SNAPSHOT). If continuous, the OTA update may also be run on a thing when a change is detected in a target. For example, an OTA update will run on a thing when the thing is added to a target group, even after the OTA update was completed by all things originally in the group.

Returns:

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

See Also:

TargetSelection, TargetSelection

targetSelection

OTAUpdateInfo.Builder targetSelection(TargetSelection targetSelection)

Specifies whether the OTA update will continue to run (CONTINUOUS), or will be complete after all those things specified as targets have completed the OTA update (SNAPSHOT). If continuous, the OTA update may also be run on a thing when a change is detected in a target. For example, an OTA update will run on a thing when the thing is added to a target group, even after the OTA update was completed by all things originally in the group.

Parameters:

targetSelection - Specifies whether the OTA update will continue to run (CONTINUOUS), or will be complete after all those things specified as targets have completed the OTA update (SNAPSHOT). If continuous, the OTA update may also be run on a thing when a change is detected in a target. For example, an OTA update will run on a thing when the thing is added to a target group, even after the OTA update was completed by all things originally in the group.

Returns:

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

See Also:

TargetSelection, TargetSelection

otaUpdateFiles

OTAUpdateInfo.Builder otaUpdateFiles(Collection<OTAUpdateFile> otaUpdateFiles)

A list of files associated with the OTA update.

Parameters:

otaUpdateFiles - A list of files associated with the OTA update.

Returns:

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

otaUpdateFiles

OTAUpdateInfo.Builder otaUpdateFiles(OTAUpdateFile... otaUpdateFiles)

A list of files associated with the OTA update.

Parameters:

otaUpdateFiles - A list of files associated with the OTA update.

Returns:

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

otaUpdateFiles

OTAUpdateInfo.Builder otaUpdateFiles(Consumer<OTAUpdateFile.Builder>... otaUpdateFiles)

A list of files associated with the OTA update.

This is a convenience method that creates an instance of the OTAUpdateFile.Builder avoiding the need to create one manually via OTAUpdateFile.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #otaUpdateFiles(List).

Parameters:

otaUpdateFiles - a consumer that will call methods on OTAUpdateFile.Builder

Returns:

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

See Also:

#otaUpdateFiles(java.util.Collection)

otaUpdateStatus

OTAUpdateInfo.Builder otaUpdateStatus(String otaUpdateStatus)

The status of the OTA update.

Parameters:

otaUpdateStatus - The status of the OTA update.

Returns:

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

See Also:

OTAUpdateStatus, OTAUpdateStatus

otaUpdateStatus

OTAUpdateInfo.Builder otaUpdateStatus(OTAUpdateStatus otaUpdateStatus)

The status of the OTA update.

Parameters:

otaUpdateStatus - The status of the OTA update.

Returns:

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

See Also:

OTAUpdateStatus, OTAUpdateStatus

awsIotJobId

OTAUpdateInfo.Builder awsIotJobId(String awsIotJobId)

The IoT job ID associated with the OTA update.

Parameters:

awsIotJobId - The IoT job ID associated with the OTA update.

Returns:

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

awsIotJobArn

OTAUpdateInfo.Builder awsIotJobArn(String awsIotJobArn)

The IoT job ARN associated with the OTA update.

Parameters:

awsIotJobArn - The IoT job ARN associated with the OTA update.

Returns:

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

errorInfo

OTAUpdateInfo.Builder errorInfo(ErrorInfo errorInfo)

Error information associated with the OTA update.

Parameters:

errorInfo - Error information associated with the OTA update.

Returns:

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

errorInfo

default OTAUpdateInfo.Builder errorInfo(Consumer<ErrorInfo.Builder> errorInfo)

Error information associated with the OTA update.

This is a convenience method that creates an instance of the ErrorInfo.Builder avoiding the need to create one manually via ErrorInfo.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to errorInfo(ErrorInfo).

Parameters:

errorInfo - a consumer that will call methods on ErrorInfo.Builder

Returns:

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

See Also:

errorInfo(ErrorInfo)

additionalParameters

OTAUpdateInfo.Builder additionalParameters(Map<String,String> additionalParameters)

A collection of name/value pairs

Parameters:

additionalParameters - A collection of name/value pairs

Returns:

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