Package com.auth0.client.mgmt.filter
Class LogEventFilter
java.lang.Object
com.auth0.client.mgmt.filter.BaseFilter
com.auth0.client.mgmt.filter.FieldsFilter
com.auth0.client.mgmt.filter.QueryFilter
com.auth0.client.mgmt.filter.LogEventFilter
Class used to filter the results received when calling the Logs endpoint. Related to the
LogEventsEntity
entity.
This class is not thread-safe.
- See Also:
BaseFilter
-
Field Summary
Fields inherited from class com.auth0.client.mgmt.filter.QueryFilter
KEY_QUERY
Fields inherited from class com.auth0.client.mgmt.filter.BaseFilter
parameters
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionwithCheckpoint(String from, int take)
Filter by checkpointwithFields(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
-
Constructor Details
-
LogEventFilter
public LogEventFilter()
-
-
Method Details
-
withCheckpoint
Filter by checkpoint- Parameters:
from
- the log event id to start retrieving logs from.take
- the limit of items to retrieve.- Returns:
- this filter instance
-
withTotals
Description copied from class:QueryFilter
Include the query summary- Overrides:
withTotals
in classQueryFilter
- Parameters:
includeTotals
- whether to include or not the query summary.- Returns:
- this filter instance
-
withQuery
Description copied from class:QueryFilter
Filter by a query- Overrides:
withQuery
in classQueryFilter
- Parameters:
query
- the query expression to use- Returns:
- this filter instance
-
withSort
Description copied from class:QueryFilter
Sort the query- Overrides:
withSort
in classQueryFilter
- 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
Description copied from class:QueryFilter
Filter by page- Overrides:
withPage
in classQueryFilter
- 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 classQueryFilter
- 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
-