Interface OTAUpdateInfo.Builder

    • 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.
      • 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.
      • 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.
      • 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
      • 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.
      • 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.