Package com.auth0.client.mgmt.filter

Class RulesFilter

java.lang.Object

com.auth0.client.mgmt.filter.BaseFilter

com.auth0.client.mgmt.filter.FieldsFilter

com.auth0.client.mgmt.filter.RulesFilter

public class RulesFilter
extends FieldsFilter

Class used to filter the results received when calling the Rules endpoint. Related to the RulesEntity entity.

This class is not thread-safe.

See Also:

• BaseFilter

Field Summary

Fields inherited from class com.auth0.client.mgmt.filter.BaseFilter

parameters

Constructor Summary

Constructors

Constructor	Description
RulesFilter()

Method Summary

Modifier and Type	Method	Description
RulesFilter	withEnabled(boolean enabled)	Filter by enabled value
RulesFilter	withFields(String fields, boolean includeFields)	Only retrieve certain fields from the item.
RulesFilter	withPage(int pageNumber, int amountPerPage)	Filter by page
RulesFilter	withTotals(boolean includeTotals)	Include the query summary Warning: Can only be used with RulesEntity.listAll(RulesFilter)

Methods inherited from class com.auth0.client.mgmt.filter.BaseFilter

getAsMap

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

RulesFilter

public RulesFilter()

Method Details

withEnabled

public RulesFilter withEnabled(boolean enabled)

Filter by enabled value

Parameters:

enabled - only retrieve items that are enabled or disabled.

Returns:

this filter instance.

withFields

public RulesFilter 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

withTotals

public RulesFilter withTotals(boolean includeTotals)

Include the query summary Warning: Can only be used with RulesEntity.listAll(RulesFilter)

Parameters:

includeTotals - whether to include or not the query summary.

Returns:

this filter instance

withPage

public RulesFilter 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