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

Class ListCommandExecutionsRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.iot.model.IotRequest

software.amazon.awssdk.services.iot.model.ListCommandExecutionsRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListCommandExecutionsRequest.Builder,ListCommandExecutionsRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ListCommandExecutionsRequest.Builder

Method Summary

Modifier and Type	Method	Description
static ListCommandExecutionsRequest.Builder	builder()
String	commandArn()	The Amazon Resource Number (ARN) of the command.
TimeFilter	completedTimeFilter()	List all command executions that completed any time before or after the date and time that you specify.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	maxResults()	The maximum number of results to return in this operation.
CommandNamespace	namespace()	The namespace of the command.
String	namespaceAsString()	The namespace of the command.
String	nextToken()	To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends ListCommandExecutionsRequest.Builder>	serializableBuilderClass()
SortOrder	sortOrder()	Specify whether to list the command executions that were created in the ascending or descending order.
String	sortOrderAsString()	Specify whether to list the command executions that were created in the ascending or descending order.
TimeFilter	startedTimeFilter()	List all command executions that started any time before or after the date and time that you specify.
CommandExecutionStatus	status()	List all command executions for the device that have a particular status.
String	statusAsString()	List all command executions for the device that have a particular status.
String	targetArn()	The Amazon Resource Number (ARN) of the target device.
ListCommandExecutionsRequest.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

maxResults

public final Integer maxResults()

The maximum number of results to return in this operation.

Returns:

The maximum number of results to return in this operation.

nextToken

public final String nextToken()

To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

Returns:

To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

namespace

public final CommandNamespace namespace()

The namespace of the command.

If the service returns an enum value that is not available in the current SDK version, namespace will return CommandNamespace.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from namespaceAsString().

Returns:

The namespace of the command.

See Also:

CommandNamespace

namespaceAsString

public final String namespaceAsString()

The namespace of the command.

If the service returns an enum value that is not available in the current SDK version, namespace will return CommandNamespace.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from namespaceAsString().

Returns:

The namespace of the command.

See Also:

CommandNamespace

status

public final CommandExecutionStatus status()

List all command executions for the device that have a particular status. For example, you can filter the list to display only command executions that have failed or timed out.

If the service returns an enum value that is not available in the current SDK version, status will return CommandExecutionStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

List all command executions for the device that have a particular status. For example, you can filter the list to display only command executions that have failed or timed out.

See Also:

CommandExecutionStatus

statusAsString

public final String statusAsString()

List all command executions for the device that have a particular status. For example, you can filter the list to display only command executions that have failed or timed out.

If the service returns an enum value that is not available in the current SDK version, status will return CommandExecutionStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

List all command executions for the device that have a particular status. For example, you can filter the list to display only command executions that have failed or timed out.

See Also:

CommandExecutionStatus

sortOrder

public final SortOrder sortOrder()

Specify whether to list the command executions that were created in the ascending or descending order. By default, the API returns all commands in the descending order based on the start time or completion time of the executions, that are determined by the startTimeFilter and completeTimeFilter parameters.

If the service returns an enum value that is not available in the current SDK version, sortOrder will return SortOrder.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sortOrderAsString().

Returns:

Specify whether to list the command executions that were created in the ascending or descending order. By default, the API returns all commands in the descending order based on the start time or completion time of the executions, that are determined by the startTimeFilter and completeTimeFilter parameters.

See Also:

SortOrder

sortOrderAsString

public final String sortOrderAsString()

Specify whether to list the command executions that were created in the ascending or descending order. By default, the API returns all commands in the descending order based on the start time or completion time of the executions, that are determined by the startTimeFilter and completeTimeFilter parameters.

If the service returns an enum value that is not available in the current SDK version, sortOrder will return SortOrder.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sortOrderAsString().

Returns:

Specify whether to list the command executions that were created in the ascending or descending order. By default, the API returns all commands in the descending order based on the start time or completion time of the executions, that are determined by the startTimeFilter and completeTimeFilter parameters.

See Also:

SortOrder

startedTimeFilter

public final TimeFilter startedTimeFilter()

List all command executions that started any time before or after the date and time that you specify. The date and time uses the format yyyy-MM-dd'T'HH:mm.

Returns:

List all command executions that started any time before or after the date and time that you specify. The date and time uses the format yyyy-MM-dd'T'HH:mm.

completedTimeFilter

public final TimeFilter completedTimeFilter()

List all command executions that completed any time before or after the date and time that you specify. The date and time uses the format yyyy-MM-dd'T'HH:mm.

Returns:

List all command executions that completed any time before or after the date and time that you specify. The date and time uses the format yyyy-MM-dd'T'HH:mm.

targetArn

public final String targetArn()

The Amazon Resource Number (ARN) of the target device. You can use this information to list all command executions for a particular device.

Returns:

The Amazon Resource Number (ARN) of the target device. You can use this information to list all command executions for a particular device.

commandArn

public final String commandArn()

The Amazon Resource Number (ARN) of the command. You can use this information to list all command executions for a particular command.

Returns:

The Amazon Resource Number (ARN) of the command. You can use this information to list all command executions for a particular command.

toBuilder

public ListCommandExecutionsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ListCommandExecutionsRequest.Builder,ListCommandExecutionsRequest>

Specified by:

toBuilder in class IotRequest

builder

public static ListCommandExecutionsRequest.Builder builder()

serializableBuilderClass

public static Class<? extends ListCommandExecutionsRequest.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