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>

  • Method Details

    • 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:

    • 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:

    • 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:

    • 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:

    • 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:

    • 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:

    • 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()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<ListCommandExecutionsRequest.Builder,ListCommandExecutionsRequest>
      Specified by:
      toBuilder in class IotRequest
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.