com.licensespring.management.dto.request

Class SearchDevicesRequest.SearchDevicesRequestBuilder

java.lang.Object

com.licensespring.management.dto.request.SearchDevicesRequest.SearchDevicesRequestBuilder

Enclosing class:

SearchDevicesRequest

public static class SearchDevicesRequest.SearchDevicesRequestBuilder
extends Object

The SearchDevicesRequest builder.

Method Summary

Modifier and Type	Method and Description
SearchDevicesRequest.SearchDevicesRequestBuilder	blacklisted(Boolean blacklisted) If set to true, the resulting set will contain only blacklisted devices, otherwise, the resulting set will contain devices that are not blacklisted.
SearchDevicesRequest	build()
SearchDevicesRequest.SearchDevicesRequestBuilder	hardwareId(String hardwareId) The resulting set can be filtered by the hardware id;
SearchDevicesRequest.SearchDevicesRequestBuilder	hostname(String hostname) The resulting set can be filtered by the hostname detected by the SDK.
SearchDevicesRequest.SearchDevicesRequestBuilder	license(Long license) The resulting set can be filtered by the license the device belongs to.
SearchDevicesRequest.SearchDevicesRequestBuilder	limit(Integer limit) Number of results you want to be shown.
SearchDevicesRequest.SearchDevicesRequestBuilder	offset(Integer offset) The initial index from which to return the results.
SearchDevicesRequest.SearchDevicesRequestBuilder	orderBy(String orderBy) The result of the queries is a list that can than be ordered in ascending order by some attribute.
SearchDevicesRequest.SearchDevicesRequestBuilder	sortDescending(boolean sortDescending) Indicates if the results of the queries should be ordered in descending order.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

limit

public SearchDevicesRequest.SearchDevicesRequestBuilder limit(Integer limit)

Number of results you want to be shown. Server sends paginated response that's why limit can be set. Default is 20.

Returns:

this.

offset

public SearchDevicesRequest.SearchDevicesRequestBuilder offset(Integer offset)

The initial index from which to return the results. Server sends paginated response that's why offset can be set.

Returns:

this.

orderBy

public SearchDevicesRequest.SearchDevicesRequestBuilder orderBy(String orderBy)

The result of the queries is a list that can than be ordered in ascending order by some attribute. This is where that attribute needs to be set. Supported fields are: blacklisted, license, hostname and hardware_id.

Returns:

this.

license

public SearchDevicesRequest.SearchDevicesRequestBuilder license(Long license)

The resulting set can be filtered by the license the device belongs to. This field is the id of that license, which shouldn't be confused with identity (username or key). This is a 16 digit field.

Returns:

this.

blacklisted

public SearchDevicesRequest.SearchDevicesRequestBuilder blacklisted(Boolean blacklisted)

If set to true, the resulting set will contain only blacklisted devices, otherwise, the resulting set will contain devices that are not blacklisted.

Returns:

this.

hostname

public SearchDevicesRequest.SearchDevicesRequestBuilder hostname(String hostname)

The resulting set can be filtered by the hostname detected by the SDK.

Returns:

this.

hardwareId

public SearchDevicesRequest.SearchDevicesRequestBuilder hardwareId(String hardwareId)

The resulting set can be filtered by the hardware id;

Returns:

this.

sortDescending

public SearchDevicesRequest.SearchDevicesRequestBuilder sortDescending(boolean sortDescending)

Indicates if the results of the queries should be ordered in descending order. Default order is ascending, and default value of this field is therefore false.

Returns:

this.

build

public SearchDevicesRequest build()

toString

public String toString()

Overrides:

toString in class Object