Package com.auth0.client.mgmt.filter

Class RolesFilter

java.lang.Object

com.auth0.client.mgmt.filter.BaseFilter

com.auth0.client.mgmt.filter.PageFilter

com.auth0.client.mgmt.filter.RolesFilter

public class RolesFilter
extends PageFilter

Class used to filter the results received when calling the Grants endpoint. Related to the RolesEntity 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
RolesFilter()

Method Summary

Modifier and Type	Method	Description
RolesFilter	withName(String name)	Filter by name
RolesFilter	withPage(int pageNumber, int amountPerPage)	Filter by page
RolesFilter	withTotals(boolean includeTotals)	Include the query summary

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

withFrom, withTake

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

RolesFilter

public RolesFilter()

Method Details

withName

public RolesFilter withName(String name)

Filter by name

Parameters:

name - only retrieve items with this name.

Returns:

this filter instance

withPage

public RolesFilter withPage(int pageNumber,
 int amountPerPage)

Filter by page

Overrides:

withPage in class PageFilter

Parameters:

pageNumber - the page number to retrieve.

amountPerPage - the amount of items per page to retrieve.

Returns:

this filter instance

withTotals

public RolesFilter withTotals(boolean includeTotals)

Include the query summary

Overrides:

withTotals in class PageFilter

Parameters:

includeTotals - whether to include or not the query summary.

Returns:

this filter instance