com.licensespring.management.dto.request

Class SearchDevicesRequest

java.lang.Object

com.licensespring.management.dto.request.SearchDevicesRequest

public final class SearchDevicesRequest
extends Object

Data transfer object that is used for searching through all devices. All fields represent a query that can be used to filter through devices. Use the builder to populate the request.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SearchDevicesRequest.SearchDevicesRequestBuilder The SearchDevicesRequest builder.

Method Summary

Modifier and Type	Method and Description
static SearchDevicesRequest.SearchDevicesRequestBuilder	builder() Use this builder to construct the search request.
boolean	equals(Object o)
Boolean	getBlacklisted() If set to true, the resulting set will contain only blacklisted devices, otherwise, the resulting set will contain devices that are not blacklisted.
String	getHardwareId() The resulting set can be filtered by the hardware id;
String	getHostname() The resulting set can be filtered by the hostname detected by the SDK.
Long	getLicense() The resulting set can be filtered by the license the device belongs to.
Integer	getLimit() Number of results you want to be shown.
Integer	getOffset() The initial index from which to return the results.
String	getOrderBy() The result of the queries is a list that can than be ordered in ascending order by some attribute.
int	hashCode()
boolean	isSortDescending() Indicates if the results of the queries should be ordered in descending order.
SearchDevicesRequest.SearchDevicesRequestBuilder	toBuilder()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

builder

public static SearchDevicesRequest.SearchDevicesRequestBuilder builder()

Use this builder to construct the search request.

Returns:

the builder for the SearchDevicesRequest

toBuilder

public SearchDevicesRequest.SearchDevicesRequestBuilder toBuilder()

getLimit

public Integer getLimit()

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

getOffset

public Integer getOffset()

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

getOrderBy

public String getOrderBy()

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.

getLicense

public Long getLicense()

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.

getBlacklisted

public Boolean getBlacklisted()

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

getHostname

public String getHostname()

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

getHardwareId

public String getHardwareId()

The resulting set can be filtered by the hardware id;

isSortDescending

public boolean isSortDescending()

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.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object