Package com.auth0.client.mgmt.filter

Class UsersExportFilter

java.lang.Object

com.auth0.client.mgmt.filter.BaseFilter

com.auth0.client.mgmt.filter.UsersExportFilter

public class UsersExportFilter
extends BaseFilter

Class used to filter the results received when a Users Exports Job is completed. Related to the JobsEntity 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
UsersExportFilter()

Method Summary

Modifier and Type	Method	Description
UsersExportFilter	withFields(List<UsersExportField> fields)	Selects the fields to include in each user export
UsersExportFilter	withFormat(String format)	Changes the output format of the exports file
UsersExportFilter	withLimit(int limit)	Limits the amount of results

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

UsersExportFilter

public UsersExportFilter()

Method Details

withFormat

public UsersExportFilter withFormat(String format)

Changes the output format of the exports file

Parameters:

format - the format of the exports file. Typically 'csv' or 'json'.

Returns:

this filter instance

withLimit

public UsersExportFilter withLimit(int limit)

Limits the amount of results

Parameters:

limit - the amount of results to include

Returns:

this filter instance

withFields

public UsersExportFilter withFields(List<UsersExportField> fields)

Selects the fields to include in each user export

Parameters:

fields - the list of fields to include in each user export

Returns:

this filter instance