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

Class ListCommandsRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListCommandsRequest.Builder,ListCommandsRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ListCommandsRequest.Builder

Method Summary

Modifier and Type	Method	Description
static ListCommandsRequest.Builder	builder()
String	commandParameterName()	A filter that can be used to display the list of commands that have a specific command parameter name.
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 ListCommandsRequest.Builder>	serializableBuilderClass()
SortOrder	sortOrder()	Specify whether to list the commands that you have created in the ascending or descending order.
String	sortOrderAsString()	Specify whether to list the commands that you have created in the ascending or descending order.
ListCommandsRequest.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. By default, the API returns up to a maximum of 25 results. You can override this default value to return up to a maximum of 100 results for this operation.

Returns:

The maximum number of results to return in this operation. By default, the API returns up to a maximum of 25 results. You can override this default value to return up to a maximum of 100 results for 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. By default, the API returns all commands that have been created for both AWS-IoT and AWS-IoT-FleetWise namespaces. You can override this default value if you want to return all commands that have been created only for a specific namespace.

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. By default, the API returns all commands that have been created for both AWS-IoT and AWS-IoT-FleetWise namespaces. You can override this default value if you want to return all commands that have been created only for a specific namespace.

See Also:

CommandNamespace

namespaceAsString

public final String namespaceAsString()

The namespace of the command. By default, the API returns all commands that have been created for both AWS-IoT and AWS-IoT-FleetWise namespaces. You can override this default value if you want to return all commands that have been created only for a specific namespace.

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. By default, the API returns all commands that have been created for both AWS-IoT and AWS-IoT-FleetWise namespaces. You can override this default value if you want to return all commands that have been created only for a specific namespace.

See Also:

CommandNamespace

commandParameterName

public final String commandParameterName()

A filter that can be used to display the list of commands that have a specific command parameter name.

Returns:

A filter that can be used to display the list of commands that have a specific command parameter name.

sortOrder

public final SortOrder sortOrder()

Specify whether to list the commands that you have created in the ascending or descending order. By default, the API returns all commands in the descending order based on the time that they were created.

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 commands that you have created in the ascending or descending order. By default, the API returns all commands in the descending order based on the time that they were created.

See Also:

SortOrder

sortOrderAsString

public final String sortOrderAsString()

Specify whether to list the commands that you have created in the ascending or descending order. By default, the API returns all commands in the descending order based on the time that they were created.

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 commands that you have created in the ascending or descending order. By default, the API returns all commands in the descending order based on the time that they were created.

See Also:

SortOrder

toBuilder

public ListCommandsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ListCommandsRequest.Builder,ListCommandsRequest>

Specified by:

toBuilder in class IotRequest

builder

public static ListCommandsRequest.Builder builder()

serializableBuilderClass

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