Interface StartCommandExecutionRequest.Builder

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

  • Method Details

    • targetArn

      StartCommandExecutionRequest.Builder targetArn(String targetArn)

      The Amazon Resource Number (ARN) of the device where the command execution is occurring.

      Parameters:
      targetArn - The Amazon Resource Number (ARN) of the device where the command execution is occurring.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • commandArn

      StartCommandExecutionRequest.Builder commandArn(String commandArn)

      The Amazon Resource Number (ARN) of the command. For example, arn:aws:iot:<region>:<accountid>:command/<commandName>

      Parameters:
      commandArn - The Amazon Resource Number (ARN) of the command. For example, arn:aws:iot:<region>:<accountid>:command/<commandName>
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • parameters

      StartCommandExecutionRequest.Builder parameters(Map<String,CommandParameterValue> parameters)

      A list of parameters that are required by the StartCommandExecution API when performing the command on a device.

      Parameters:
      parameters - A list of parameters that are required by the StartCommandExecution API when performing the command on a device.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • executionTimeoutSeconds

      StartCommandExecutionRequest.Builder executionTimeoutSeconds(Long executionTimeoutSeconds)

      Specifies the amount of time in second the device has to finish the command execution. A timer is started as soon as the command execution is created. If the command execution status is not set to another terminal state before the timer expires, it will automatically update to TIMED_OUT.

      Parameters:
      executionTimeoutSeconds - Specifies the amount of time in second the device has to finish the command execution. A timer is started as soon as the command execution is created. If the command execution status is not set to another terminal state before the timer expires, it will automatically update to TIMED_OUT.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • clientToken

      StartCommandExecutionRequest.Builder clientToken(String clientToken)

      The client token is used to implement idempotency. It ensures that the request completes no more than one time. If you retry a request with the same token and the same parameters, the request will complete successfully. However, if you retry the request using the same token but different parameters, an HTTP 409 conflict occurs. If you omit this value, Amazon Web Services SDKs will automatically generate a unique client request.

      Parameters:
      clientToken - The client token is used to implement idempotency. It ensures that the request completes no more than one time. If you retry a request with the same token and the same parameters, the request will complete successfully. However, if you retry the request using the same token but different parameters, an HTTP 409 conflict occurs. If you omit this value, Amazon Web Services SDKs will automatically generate a unique client request.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

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

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