com.recombee.api_client.api_requests

Class ListItems

java.lang.Object

com.recombee.api_client.api_requests.Request

com.recombee.api_client.api_requests.ListItems

public class ListItems
extends Request

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

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.Long	count The number of items to be listed.
protected java.lang.String	filter Boolean-returning [ReQL](https://docs.recombee.com/reql.html) expression, which allows you to filter items 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 items to skip (ordered by `itemId`).
protected java.lang.Boolean	returnProperties With `returnProperties=true`, property values of the listed items 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
ListItems() 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()
ListItems	setCount(long count)
ListItems	setFilter(java.lang.String filter)
ListItems	setIncludedProperties(java.lang.String[] includedProperties)
ListItems	setOffset(long offset)
ListItems	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 items to be listed. Only the items for which the expression is *true* will be returned.

count

protected java.lang.Long count

The number of items to be listed.

offset

protected java.lang.Long offset

Specifies the number of items to skip (ordered by `itemId`).

returnProperties

protected java.lang.Boolean returnProperties

With `returnProperties=true`, property values of the listed items are returned along with their IDs in a JSON dictionary. Example response: ``` [ { "itemId": "tv-178", "description": "4K TV with 3D feature", "categories": ["Electronics", "Televisions"], "price": 342, "url": "myshop.com/tv-178" }, { "itemId": "mixer-42", "description": "Stainless Steel Mixer", "categories": ["Home & Kitchen"], "price": 39, "url": "myshop.com/mixer-42" } ] ```

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=description,price`: ``` [ { "itemId": "tv-178", "description": "4K TV with 3D feature", "price": 342 }, { "itemId": "mixer-42", "description": "Stainless Steel Mixer", "price": 39 } ] ```

Constructor Detail

ListItems

public ListItems()

Construct the request

Method Detail

setFilter

public ListItems setFilter(java.lang.String filter)

Parameters:

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

setCount

public ListItems setCount(long count)

Parameters:

count - The number of items to be listed.

setOffset

public ListItems setOffset(long offset)

Parameters:

offset - Specifies the number of items to skip (ordered by `itemId`).

setReturnProperties

public ListItems setReturnProperties(boolean returnProperties)

Parameters:

returnProperties - With `returnProperties=true`, property values of the listed items are returned along with their IDs in a JSON dictionary. Example response: ``` [ { "itemId": "tv-178", "description": "4K TV with 3D feature", "categories": ["Electronics", "Televisions"], "price": 342, "url": "myshop.com/tv-178" }, { "itemId": "mixer-42", "description": "Stainless Steel Mixer", "categories": ["Home & Kitchen"], "price": 39, "url": "myshop.com/mixer-42" } ] ```

setIncludedProperties

public ListItems 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=description,price`: ``` [ { "itemId": "tv-178", "description": "4K TV with 3D feature", "price": 342 }, { "itemId": "mixer-42", "description": "Stainless Steel Mixer", "price": 39 } ] ```

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)