Interface GetCommandExecutionResponse.Builder

All Superinterfaces:
AwsResponse.Builder, Buildable, CopyableBuilder<GetCommandExecutionResponse.Builder,GetCommandExecutionResponse>, IotResponse.Builder, SdkBuilder<GetCommandExecutionResponse.Builder,GetCommandExecutionResponse>, SdkPojo, SdkResponse.Builder
Enclosing class:
GetCommandExecutionResponse
@Mutable @NotThreadSafe public static interface GetCommandExecutionResponse.Builder extends IotResponse.Builder, SdkPojo, CopyableBuilder<GetCommandExecutionResponse.Builder,GetCommandExecutionResponse>

  • Method Details

    • executionId

      GetCommandExecutionResponse.Builder executionId(String executionId)

      The unique identifier of the command execution.

      Parameters:
      executionId - The unique identifier of the command execution.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • commandArn

      GetCommandExecutionResponse.Builder commandArn(String commandArn)

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

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

    • targetArn

      GetCommandExecutionResponse.Builder targetArn(String targetArn)

      The Amazon Resource Number (ARN) of the device on which the command execution is being performed.

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

    • status

      GetCommandExecutionResponse.Builder status(String status)

      The status of the command execution. After your devices receive the command and start performing the operations specified in the command, it can use the UpdateCommandExecution MQTT API to update the status information.

      Parameters:
      status - The status of the command execution. After your devices receive the command and start performing the operations specified in the command, it can use the UpdateCommandExecution MQTT API to update the status information.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • status

      GetCommandExecutionResponse.Builder status(CommandExecutionStatus status)

      The status of the command execution. After your devices receive the command and start performing the operations specified in the command, it can use the UpdateCommandExecution MQTT API to update the status information.

      Parameters:
      status - The status of the command execution. After your devices receive the command and start performing the operations specified in the command, it can use the UpdateCommandExecution MQTT API to update the status information.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • statusReason

      GetCommandExecutionResponse.Builder statusReason(StatusReason statusReason)

      Your devices can use this parameter to provide additional context about the status of a command execution using a reason code and description.

      Parameters:
      statusReason - Your devices can use this parameter to provide additional context about the status of a command execution using a reason code and description.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • statusReason

      default GetCommandExecutionResponse.Builder statusReason(Consumer<StatusReason.Builder> statusReason)

      Your devices can use this parameter to provide additional context about the status of a command execution using a reason code and description.

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

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

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

    • result

      GetCommandExecutionResponse.Builder result(Map<String,CommandExecutionResult> result)

      The result value for the current state of the command execution. The status provides information about the progress of the command execution. The device can use the result field to share additional details about the execution such as a return value of a remote function call.

      If you use the AWS-IoT-FleetWise namespace, then this field is not applicable in the API response.

      Parameters:
      result - The result value for the current state of the command execution. The status provides information about the progress of the command execution. The device can use the result field to share additional details about the execution such as a return value of a remote function call.

      If you use the AWS-IoT-FleetWise namespace, then this field is not applicable in the API response.

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

    • parameters

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

      The list of parameters that the StartCommandExecution API used when performing the command on the device.

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

    • executionTimeoutSeconds

      GetCommandExecutionResponse.Builder executionTimeoutSeconds(Long executionTimeoutSeconds)

      Specifies the amount of time in seconds that the device can take to finish a command execution. A timer starts when 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 seconds that the device can take to finish a command execution. A timer starts when 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.

    • createdAt

      GetCommandExecutionResponse.Builder createdAt(Instant createdAt)

      The timestamp, when the command execution was created.

      Parameters:
      createdAt - The timestamp, when the command execution was created.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • lastUpdatedAt

      GetCommandExecutionResponse.Builder lastUpdatedAt(Instant lastUpdatedAt)

      The timestamp, when the command execution was last updated.

      Parameters:
      lastUpdatedAt - The timestamp, when the command execution was last updated.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • startedAt

      GetCommandExecutionResponse.Builder startedAt(Instant startedAt)

      The timestamp, when the command execution was started.

      Parameters:
      startedAt - The timestamp, when the command execution was started.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • completedAt

      GetCommandExecutionResponse.Builder completedAt(Instant completedAt)

      The timestamp, when the command execution was completed.

      Parameters:
      completedAt - The timestamp, when the command execution was completed.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • timeToLive

      GetCommandExecutionResponse.Builder timeToLive(Instant timeToLive)

      The time to live (TTL) parameter that indicates the duration for which executions will be retained in your account. The default value is six months.

      Parameters:
      timeToLive - The time to live (TTL) parameter that indicates the duration for which executions will be retained in your account. The default value is six months.
      Returns:
      Returns a reference to this object so that method calls can be chained together.