Interface CreateOtaTaskRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<CreateOtaTaskRequest.Builder,CreateOtaTaskRequest>, IotManagedIntegrationsRequest.Builder, SdkBuilder<CreateOtaTaskRequest.Builder,CreateOtaTaskRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CreateOtaTaskRequest
@Mutable @NotThreadSafe public static interface CreateOtaTaskRequest.Builder extends IotManagedIntegrationsRequest.Builder, SdkPojo, CopyableBuilder<CreateOtaTaskRequest.Builder,CreateOtaTaskRequest>

  • Method Details

    • description

      CreateOtaTaskRequest.Builder description(String description)

      The description of the over-the-air (OTA) task.

      Parameters:
      description - The description of the over-the-air (OTA) task.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • s3Url

      CreateOtaTaskRequest.Builder s3Url(String s3Url)

      The URL to the Amazon S3 bucket where the over-the-air (OTA) task is stored.

      Parameters:
      s3Url - The URL to the Amazon S3 bucket where the over-the-air (OTA) task is stored.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • protocol

      CreateOtaTaskRequest.Builder protocol(String protocol)

      The connection protocol the over-the-air (OTA) task uses to update the device.

      Parameters:
      protocol - The connection protocol the over-the-air (OTA) task uses to update the device.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • protocol

      CreateOtaTaskRequest.Builder protocol(OtaProtocol protocol)

      The connection protocol the over-the-air (OTA) task uses to update the device.

      Parameters:
      protocol - The connection protocol the over-the-air (OTA) task uses to update the device.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • target

      CreateOtaTaskRequest.Builder target(Collection<String> target)

      The device targeted for the over-the-air (OTA) task.

      Parameters:
      target - The device targeted for the over-the-air (OTA) task.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • target

      CreateOtaTaskRequest.Builder target(String... target)

      The device targeted for the over-the-air (OTA) task.

      Parameters:
      target - The device targeted for the over-the-air (OTA) task.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • taskConfigurationId

      CreateOtaTaskRequest.Builder taskConfigurationId(String taskConfigurationId)

      The identifier for the over-the-air (OTA) task configuration.

      Parameters:
      taskConfigurationId - The identifier for the over-the-air (OTA) task configuration.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • otaMechanism

      CreateOtaTaskRequest.Builder otaMechanism(String otaMechanism)

      The deployment mechanism for the over-the-air (OTA) task.

      Parameters:
      otaMechanism - The deployment mechanism for the over-the-air (OTA) task.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • otaMechanism

      CreateOtaTaskRequest.Builder otaMechanism(OtaMechanism otaMechanism)

      The deployment mechanism for the over-the-air (OTA) task.

      Parameters:
      otaMechanism - The deployment mechanism for the over-the-air (OTA) task.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • otaType

      CreateOtaTaskRequest.Builder otaType(String otaType)

      The frequency type for the over-the-air (OTA) task.

      Parameters:
      otaType - The frequency type for the over-the-air (OTA) task.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • otaType

      CreateOtaTaskRequest.Builder otaType(OtaType otaType)

      The frequency type for the over-the-air (OTA) task.

      Parameters:
      otaType - The frequency type for the over-the-air (OTA) task.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • otaTargetQueryString

      CreateOtaTaskRequest.Builder otaTargetQueryString(String otaTargetQueryString)

      The query string to add things to the thing group.

      Parameters:
      otaTargetQueryString - The query string to add things to the thing group.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • clientToken

      CreateOtaTaskRequest.Builder clientToken(String clientToken)

      An idempotency token. If you retry a request that completed successfully initially using the same client token and parameters, then the retry attempt will succeed without performing any further actions.

      Parameters:
      clientToken - An idempotency token. If you retry a request that completed successfully initially using the same client token and parameters, then the retry attempt will succeed without performing any further actions.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • otaSchedulingConfig

      CreateOtaTaskRequest.Builder otaSchedulingConfig(OtaTaskSchedulingConfig otaSchedulingConfig)
      Sets the value of the OtaSchedulingConfig property for this object.
      Parameters:
      otaSchedulingConfig - The new value for the OtaSchedulingConfig property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • otaSchedulingConfig

      default CreateOtaTaskRequest.Builder otaSchedulingConfig(Consumer<OtaTaskSchedulingConfig.Builder> otaSchedulingConfig)
      Sets the value of the OtaSchedulingConfig property for this object. This is a convenience method that creates an instance of the OtaTaskSchedulingConfig.Builder avoiding the need to create one manually via OtaTaskSchedulingConfig.builder().

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

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

    • otaTaskExecutionRetryConfig

      CreateOtaTaskRequest.Builder otaTaskExecutionRetryConfig(OtaTaskExecutionRetryConfig otaTaskExecutionRetryConfig)
      Sets the value of the OtaTaskExecutionRetryConfig property for this object.
      Parameters:
      otaTaskExecutionRetryConfig - The new value for the OtaTaskExecutionRetryConfig property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • otaTaskExecutionRetryConfig

      default CreateOtaTaskRequest.Builder otaTaskExecutionRetryConfig(Consumer<OtaTaskExecutionRetryConfig.Builder> otaTaskExecutionRetryConfig)
      Sets the value of the OtaTaskExecutionRetryConfig property for this object. This is a convenience method that creates an instance of the OtaTaskExecutionRetryConfig.Builder avoiding the need to create one manually via OtaTaskExecutionRetryConfig.builder().

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

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

    • tags

      CreateOtaTaskRequest.Builder tags(Map<String,String> tags)

      A set of key/value pairs that are used to manage the over-the-air (OTA) task.

      Parameters:
      tags - A set of key/value pairs that are used to manage the over-the-air (OTA) task.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

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

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