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
public class LogEventFilter extends QueryFilter
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:

  • Constructor Details

    • LogEventFilter

      public LogEventFilter()

  • Method Details

    • withCheckpoint

      public LogEventFilter withCheckpoint(String from, int take)
      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

      public LogEventFilter withTotals(boolean includeTotals)
      Description copied from class: QueryFilter
      Include the query summary
      Overrides:
      withTotals in class QueryFilter
      Parameters:
      includeTotals - whether to include or not the query summary.
      Returns:
      this filter instance

    • withQuery

      public LogEventFilter withQuery(String query)
      Description copied from class: QueryFilter
      Filter by a query
      Overrides:
      withQuery in class QueryFilter
      Parameters:
      query - the query expression to use
      Returns:
      this filter instance

    • withSort

      public LogEventFilter withSort(String sort)
      Description copied from class: QueryFilter
      Sort the query
      Overrides:
      withSort in class QueryFilter
      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

      public LogEventFilter withPage(int pageNumber, int amountPerPage)
      Description copied from class: QueryFilter
      Filter by page
      Overrides:
      withPage in class QueryFilter
      Parameters:
      pageNumber - the page number to retrieve.
      amountPerPage - the amount of items per page to retrieve.
      Returns:
      this filter instance

    • withFields

      public LogEventFilter withFields(String fields, boolean includeFields)
      Description copied from class: FieldsFilter
      Only retrieve certain fields from the item.
      Overrides:
      withFields in class QueryFilter
      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