com.recombee.api_client.api_requests

Class ListUsers

java.lang.Object

com.recombee.api_client.api_requests.Request

com.recombee.api_client.api_requests.ListUsers

public class ListUsers
extends Request

Gets a list of IDs of users currently present in the catalog.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.Long	count The number of users to be listed.
protected java.lang.String	filter Boolean-returning [ReQL](https://docs.recombee.com/reql.html) expression, which allows you to filter users to be listed.
protected java.lang.String[]	includedProperties Allows to specify, which properties should be returned when `returnProperties=true` is set.
protected java.lang.Long	offset Specifies the number of users to skip (ordered by `userId`).
protected java.lang.Boolean	returnProperties With `returnProperties=true`, property values of the listed users are returned along with their IDs in a JSON dictionary.

Fields inherited from class com.recombee.api_client.api_requests.Request

timeout

Constructor Summary

Constructors

Constructor and Description
ListUsers() Construct the request

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.lang.Object>	getBodyParameters() Get body parameters
long	getCount()
java.lang.String	getFilter()
HTTPMethod	getHTTPMethod()
java.lang.String[]	getIncludedProperties()
long	getOffset()
java.lang.String	getPath()
java.util.Map<java.lang.String,java.lang.Object>	getQueryParameters() Get query parameters
boolean	getReturnProperties()
ListUsers	setCount(long count)
ListUsers	setFilter(java.lang.String filter)
ListUsers	setIncludedProperties(java.lang.String[] includedProperties)
ListUsers	setOffset(long offset)
ListUsers	setReturnProperties(boolean returnProperties)

Methods inherited from class com.recombee.api_client.api_requests.Request

getEnsureHttps, getTimeout, setTimeout

Methods inherited from class java.lang.Object

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

Field Detail

filter

protected java.lang.String filter

Boolean-returning [ReQL](https://docs.recombee.com/reql.html) expression, which allows you to filter users to be listed. Only the users for which the expression is *true* will be returned.

count

protected java.lang.Long count

The number of users to be listed.

offset

protected java.lang.Long offset

Specifies the number of users to skip (ordered by `userId`).

returnProperties

protected java.lang.Boolean returnProperties

With `returnProperties=true`, property values of the listed users are returned along with their IDs in a JSON dictionary. Example response: ``` [ { "userId": "user-81", "country": "US", "sex": "M" }, { "userId": "user-314", "country": "CAN", "sex": "F" } ] ```

includedProperties

protected java.lang.String[] includedProperties

Allows to specify, which properties should be returned when `returnProperties=true` is set. The properties are given as a comma-separated list. Example response for `includedProperties=country`: ``` [ { "userId": "user-81", "country": "US" }, { "userId": "user-314", "country": "CAN" } ] ```

Constructor Detail

ListUsers

public ListUsers()

Construct the request

Method Detail

setFilter

public ListUsers setFilter(java.lang.String filter)

Parameters:

filter - Boolean-returning [ReQL](https://docs.recombee.com/reql.html) expression, which allows you to filter users to be listed. Only the users for which the expression is *true* will be returned.

setCount

public ListUsers setCount(long count)

Parameters:

count - The number of users to be listed.

setOffset

public ListUsers setOffset(long offset)

Parameters:

offset - Specifies the number of users to skip (ordered by `userId`).

setReturnProperties

public ListUsers setReturnProperties(boolean returnProperties)

Parameters:

returnProperties - With `returnProperties=true`, property values of the listed users are returned along with their IDs in a JSON dictionary. Example response: ``` [ { "userId": "user-81", "country": "US", "sex": "M" }, { "userId": "user-314", "country": "CAN", "sex": "F" } ] ```

setIncludedProperties

public ListUsers setIncludedProperties(java.lang.String[] includedProperties)

Parameters:

includedProperties - Allows to specify, which properties should be returned when `returnProperties=true` is set. The properties are given as a comma-separated list. Example response for `includedProperties=country`: ``` [ { "userId": "user-81", "country": "US" }, { "userId": "user-314", "country": "CAN" } ] ```

getFilter

public java.lang.String getFilter()

getCount

public long getCount()

getOffset

public long getOffset()

getReturnProperties

public boolean getReturnProperties()

getIncludedProperties

public java.lang.String[] getIncludedProperties()

getHTTPMethod

public HTTPMethod getHTTPMethod()

Specified by:

getHTTPMethod in class Request

Returns:

Used HTTP method

getPath

public java.lang.String getPath()

Specified by:

getPath in class Request

Returns:

URI to the endpoint including path parameters

getQueryParameters

public java.util.Map<java.lang.String,java.lang.Object> getQueryParameters()

Get query parameters

Specified by:

getQueryParameters in class Request

Returns:

Values of query parameters (name of parameter: value of the parameter)

getBodyParameters

public java.util.Map<java.lang.String,java.lang.Object> getBodyParameters()

Get body parameters

Specified by:

getBodyParameters in class Request

Returns:

Values of body parameters (name of parameter: value of the parameter)