Package software.amazon.awssdk.services.alexaforbusiness.model

Interface SearchDevicesRequest.Builder

    • Method Detail

      • nextToken

        SearchDevicesRequest.Builder nextToken​(String nextToken)

        An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.

        Parameters:
        nextToken - An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • maxResults

        SearchDevicesRequest.Builder maxResults​(Integer maxResults)

        The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

        Parameters:
        maxResults - The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • filters

        SearchDevicesRequest.Builder filters​(Collection<Filter> filters)

        The filters to use to list a specified set of devices. Supported filter keys are DeviceName, DeviceStatus, DeviceStatusDetailCode, RoomName, DeviceType, DeviceSerialNumber, UnassociatedOnly, ConnectionStatus (ONLINE and OFFLINE), NetworkProfileName, NetworkProfileArn, Feature, and FailureCode.

        Parameters:
        filters - The filters to use to list a specified set of devices. Supported filter keys are DeviceName, DeviceStatus, DeviceStatusDetailCode, RoomName, DeviceType, DeviceSerialNumber, UnassociatedOnly, ConnectionStatus (ONLINE and OFFLINE), NetworkProfileName, NetworkProfileArn, Feature, and FailureCode.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • filters

        SearchDevicesRequest.Builder filters​(Filter... filters)

        The filters to use to list a specified set of devices. Supported filter keys are DeviceName, DeviceStatus, DeviceStatusDetailCode, RoomName, DeviceType, DeviceSerialNumber, UnassociatedOnly, ConnectionStatus (ONLINE and OFFLINE), NetworkProfileName, NetworkProfileArn, Feature, and FailureCode.

        Parameters:
        filters - The filters to use to list a specified set of devices. Supported filter keys are DeviceName, DeviceStatus, DeviceStatusDetailCode, RoomName, DeviceType, DeviceSerialNumber, UnassociatedOnly, ConnectionStatus (ONLINE and OFFLINE), NetworkProfileName, NetworkProfileArn, Feature, and FailureCode.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • filters

        SearchDevicesRequest.Builder filters​(Consumer<Filter.Builder>... filters)

        The filters to use to list a specified set of devices. Supported filter keys are DeviceName, DeviceStatus, DeviceStatusDetailCode, RoomName, DeviceType, DeviceSerialNumber, UnassociatedOnly, ConnectionStatus (ONLINE and OFFLINE), NetworkProfileName, NetworkProfileArn, Feature, and FailureCode.

        This is a convenience method that creates an instance of the Filter.Builder avoiding the need to create one manually via Filter.builder().

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #filters(List).

        Parameters:
        filters - a consumer that will call methods on Filter.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #filters(java.util.Collection)

      • sortCriteria

        SearchDevicesRequest.Builder sortCriteria​(Collection<Sort> sortCriteria)

        The sort order to use in listing the specified set of devices. Supported sort keys are DeviceName, DeviceStatus, RoomName, DeviceType, DeviceSerialNumber, ConnectionStatus, NetworkProfileName, NetworkProfileArn, Feature, and FailureCode.

        Parameters:
        sortCriteria - The sort order to use in listing the specified set of devices. Supported sort keys are DeviceName, DeviceStatus, RoomName, DeviceType, DeviceSerialNumber, ConnectionStatus, NetworkProfileName, NetworkProfileArn, Feature, and FailureCode.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • sortCriteria

        SearchDevicesRequest.Builder sortCriteria​(Sort... sortCriteria)

        The sort order to use in listing the specified set of devices. Supported sort keys are DeviceName, DeviceStatus, RoomName, DeviceType, DeviceSerialNumber, ConnectionStatus, NetworkProfileName, NetworkProfileArn, Feature, and FailureCode.

        Parameters:
        sortCriteria - The sort order to use in listing the specified set of devices. Supported sort keys are DeviceName, DeviceStatus, RoomName, DeviceType, DeviceSerialNumber, ConnectionStatus, NetworkProfileName, NetworkProfileArn, Feature, and FailureCode.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • sortCriteria

        SearchDevicesRequest.Builder sortCriteria​(Consumer<Sort.Builder>... sortCriteria)

        The sort order to use in listing the specified set of devices. Supported sort keys are DeviceName, DeviceStatus, RoomName, DeviceType, DeviceSerialNumber, ConnectionStatus, NetworkProfileName, NetworkProfileArn, Feature, and FailureCode.

        This is a convenience method that creates an instance of the Sort.Builder avoiding the need to create one manually via Sort.builder().

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #sortCriteria(List).

        Parameters:
        sortCriteria - a consumer that will call methods on Sort.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #sortCriteria(java.util.Collection)