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

Interface CreateOtaUpdateRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<CreateOtaUpdateRequest.Builder,CreateOtaUpdateRequest>, IotRequest.Builder, SdkBuilder<CreateOtaUpdateRequest.Builder,CreateOtaUpdateRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CreateOtaUpdateRequest
public static interface CreateOtaUpdateRequest.Builder extends IotRequest.Builder, SdkPojo, CopyableBuilder<CreateOtaUpdateRequest.Builder,CreateOtaUpdateRequest>

  • Method Details

    • otaUpdateId

      CreateOtaUpdateRequest.Builder otaUpdateId(String 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

      CreateOtaUpdateRequest.Builder description(String 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

      CreateOtaUpdateRequest.Builder targets(Collection<String> 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

      CreateOtaUpdateRequest.Builder targets(String... 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

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

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

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

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

    • targetSelection

      CreateOtaUpdateRequest.Builder 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). 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

      CreateOtaUpdateRequest.Builder 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). 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 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:

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

    • awsJobAbortConfig

      CreateOtaUpdateRequest.Builder awsJobAbortConfig(AwsJobAbortConfig 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 the AwsJobAbortConfig.Builder avoiding the need to create one manually via AwsJobAbortConfig.builder().

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

      Parameters:
      awsJobAbortConfig - a consumer that will call methods on AwsJobAbortConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • awsJobTimeoutConfig

      CreateOtaUpdateRequest.Builder awsJobTimeoutConfig(AwsJobTimeoutConfig 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 to TIMED_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 to IN_PROGRESS. If the job execution status is not set to another terminal state before the timer expires, it will be automatically set to TIMED_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 IN_PROGRESS. If the job execution status is not set to another terminal state before the timer expires, it will be automatically set to TIMED_OUT.

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

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

      Parameters:
      awsJobTimeoutConfig - a consumer that will call methods on AwsJobTimeoutConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • files

      CreateOtaUpdateRequest.Builder files(Collection<OTAUpdateFile> 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

      CreateOtaUpdateRequest.Builder files(OTAUpdateFile... 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

      CreateOtaUpdateRequest.Builder files(Consumer<OTAUpdateFile.Builder>... files)

      The files to be streamed by 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 files(List<OTAUpdateFile>).

      Parameters:
      files - 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:

    • roleArn

      CreateOtaUpdateRequest.Builder roleArn(String 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

      CreateOtaUpdateRequest.Builder additionalParameters(Map<String,String> 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

      CreateOtaUpdateRequest.Builder tags(Collection<Tag> 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

      CreateOtaUpdateRequest.Builder tags(Tag... 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

      CreateOtaUpdateRequest.Builder tags(Consumer<Tag.Builder>... tags)

      Metadata which can be used to manage updates.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tags(List<Tag>).

      Parameters:
      tags - a consumer that will call methods on Tag.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 interface AwsRequest.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 interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.