Package com.auth0.client.mgmt.filter

Class GrantsFilter

java.lang.Object

com.auth0.client.mgmt.filter.BaseFilter

com.auth0.client.mgmt.filter.GrantsFilter

public class GrantsFilter
extends BaseFilter

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

Method Summary

Modifier and Type	Method	Description
GrantsFilter	withAudience(String audience)	Filter by audience
GrantsFilter	withClientId(String clientId)	Filter by client id
GrantsFilter	withPage(int pageNumber, int amountPerPage)	Filter by page
GrantsFilter	withTotals(boolean includeTotals)	Include the query summary

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

GrantsFilter

public GrantsFilter()

Method Details

withClientId

public GrantsFilter withClientId(String clientId)

Filter by client id

Parameters:

clientId - only retrieve items with this client id.

Returns:

this filter instance

withAudience

public GrantsFilter withAudience(String audience)

Filter by audience

Parameters:

audience - only retrieve the item with this audience.

Returns:

this filter instance

withPage

public GrantsFilter 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 GrantsFilter withTotals(boolean includeTotals)

Include the query summary

Parameters:

includeTotals - whether to include or not the query summary.

Returns:

this filter instance