java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.iotjobsdataplane.model.IotJobsDataPlaneRequest
    - - software.amazon.awssdk.services.iotjobsdataplane.model.StartCommandExecutionRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<StartCommandExecutionRequest.Builder,StartCommandExecutionRequest>

@Generated("software.amazon.awssdk:codegen")
public final class StartCommandExecutionRequest
extends IotJobsDataPlaneRequest
implements ToCopyableBuilder<StartCommandExecutionRequest.Builder,StartCommandExecutionRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface StartCommandExecutionRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static StartCommandExecutionRequest.Builder`	`builder()`
`String`	`clientToken()`	The client token is used to implement idempotency.
`String`	`commandArn()`	The Amazon Resource Number (ARN) of the command.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`Long`	`executionTimeoutSeconds()`	Specifies the amount of time in second the device has to finish the command execution.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasParameters()`	For responses, this returns true if the service returned a value for the Parameters property.
`Map<String,CommandParameterValue>`	`parameters()`	A list of parameters that are required by the `StartCommandExecution` API when performing the command on a device.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends StartCommandExecutionRequest.Builder>`	`serializableBuilderClass()`
`String`	`targetArn()`	The Amazon Resource Number (ARN) of the device where the command execution is occurring.
`StartCommandExecutionRequest.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - targetArn
```
public final String targetArn()
```
    The Amazon Resource Number (ARN) of the device where the command execution is occurring.
    
    Returns:
    
    The Amazon Resource Number (ARN) of the device where the command execution is occurring.
  - commandArn
```
public final String commandArn()
```
    The Amazon Resource Number (ARN) of the command. For example, arn:aws:iot:<region>:<accountid>:command/<commandName>
    
    Returns:
    
    The Amazon Resource Number (ARN) of the command. For example, arn:aws:iot:<region>:<accountid>:command/<commandName>
  - hasParameters
```
public final boolean hasParameters()
```
    For responses, this returns true if the service returned a value for the Parameters property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - parameters
```
public final Map<String,CommandParameterValue> parameters()
```
    A list of parameters that are required by the StartCommandExecution API when performing the command on a device.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasParameters() method.
    
    Returns:
    
    A list of parameters that are required by the StartCommandExecution API when performing the command on a device.
  - executionTimeoutSeconds
```
public final 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.
    
    Returns:
    
    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.
  - clientToken
```
public final 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.
    
    Returns:
    
    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.
  - toBuilder
```
public StartCommandExecutionRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<StartCommandExecutionRequest.Builder,StartCommandExecutionRequest>
    
    Specified by:
    
    toBuilder in class IotJobsDataPlaneRequest
  - builder
```
public static StartCommandExecutionRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends StartCommandExecutionRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class StartCommandExecutionRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

targetArn

commandArn

hasParameters

parameters

executionTimeoutSeconds

clientToken

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField