Package com.auth0.client.mgmt.filter

Class ConnectionFilter

java.lang.Object
com.auth0.client.mgmt.filter.BaseFilter
com.auth0.client.mgmt.filter.FieldsFilter
com.auth0.client.mgmt.filter.ConnectionFilter
public class ConnectionFilter extends FieldsFilter
Class used to filter the results received when calling the Connections endpoint. Related to the ConnectionsEntity entity.

This class is not thread-safe.

See Also:

  • Constructor Details

    • ConnectionFilter

      public ConnectionFilter()

  • Method Details

    • withStrategy

      public ConnectionFilter withStrategy(String strategy)
      Filter by strategy
      Parameters:
      strategy - only retrieve items with this strategy.
      Returns:
      this filter instance

    • withName

      public ConnectionFilter withName(String name)
      Filter by name
      Parameters:
      name - only retrieve the item with this name.
      Returns:
      this filter instance

    • withPage

      public ConnectionFilter withPage(int pageNumber, int amountPerPage)
      Filter by page
      Parameters:
      pageNumber - the page number to retrieve.
      amountPerPage - the amount of items per page to retrieve.
      Returns:
      this filter instance

    • withTotals

      public ConnectionFilter withTotals(boolean includeTotals)
      Include the query summary. Warning: Can only be used with ConnectionsEntity.listAll(ConnectionFilter)
      Parameters:
      includeTotals - whether to include or not the query summary.
      Returns:
      this filter instance

    • withFields

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