Package com.auth0.client.mgmt.filter
Class QueryFilter
java.lang.Object
com.auth0.client.mgmt.filter.BaseFilter
com.auth0.client.mgmt.filter.FieldsFilter
com.auth0.client.mgmt.filter.QueryFilter
- Direct Known Subclasses:
LogEventFilter
,UserFilter
Class used to filter the results received when calling endpoints that accept a Query.
This class is not thread-safe.
- See Also:
-
Field Summary
FieldsFields inherited from class com.auth0.client.mgmt.filter.BaseFilter
parameters
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionwithFields
(String fields, boolean includeFields) Only retrieve certain fields from the item.withPage
(int pageNumber, int amountPerPage) Filter by pageFilter by a querySort the querywithTotals
(boolean includeTotals) Include the query summaryMethods inherited from class com.auth0.client.mgmt.filter.BaseFilter
getAsMap
-
Field Details
-
KEY_QUERY
- See Also:
-
-
Constructor Details
-
QueryFilter
public QueryFilter()
-
-
Method Details
-
withQuery
Filter by a query- Parameters:
query
- the query expression to use- Returns:
- this filter instance
-
withTotals
Include the query summary- Parameters:
includeTotals
- whether to include or not the query summary.- Returns:
- this filter instance
-
withSort
Sort the query- Parameters:
sort
- the field to use for sorting. Use 'field:order' where order is 1 for ascending and -1 for descending.- Returns:
- this filter instance
-
withPage
Filter by page- Parameters:
pageNumber
- the page number to retrieve.amountPerPage
- the amount of items per page to retrieve.- Returns:
- this filter instance
-
withFields
Description copied from class:FieldsFilter
Only retrieve certain fields from the item.- Overrides:
withFields
in classFieldsFilter
- Parameters:
fields
- a list of comma separated fields to retrieve.includeFields
- whether to include or exclude in the response the fields that were given.- Returns:
- this filter instance
-