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

Interface ListCommandExecutionsRequest.Builder

    • Method Detail

      • maxResults

        ListCommandExecutionsRequest.Builder maxResults​(Integer maxResults)

        The maximum number of results to return in this operation.

        Parameters:
        maxResults - The maximum number of results to return in this operation.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • nextToken

        ListCommandExecutionsRequest.Builder nextToken​(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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • status

        ListCommandExecutionsRequest.Builder status​(String 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.

        Parameters:
        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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        CommandExecutionStatus, CommandExecutionStatus

      • status

        ListCommandExecutionsRequest.Builder status​(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.

        Parameters:
        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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        CommandExecutionStatus, CommandExecutionStatus

      • sortOrder

        ListCommandExecutionsRequest.Builder sortOrder​(String 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.

        Parameters:
        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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        SortOrder, SortOrder

      • sortOrder

        ListCommandExecutionsRequest.Builder sortOrder​(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.

        Parameters:
        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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        SortOrder, SortOrder

      • startedTimeFilter

        ListCommandExecutionsRequest.Builder startedTimeFilter​(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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • completedTimeFilter

        ListCommandExecutionsRequest.Builder completedTimeFilter​(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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • targetArn

        ListCommandExecutionsRequest.Builder targetArn​(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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • commandArn

        ListCommandExecutionsRequest.Builder commandArn​(String commandArn)

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

        Parameters:
        commandArn - The Amazon Resource Number (ARN) of the command. You can use this information to list all command executions for a particular command.
        Returns:
        Returns a reference to this object so that method calls can be chained together.