com.recombee.api_client.api_requests

Class AddItemProperty

java.lang.Object

com.recombee.api_client.api_requests.Request

com.recombee.api_client.api_requests.AddItemProperty

public class AddItemProperty
extends Request

Adding an item property is somehow equivalent to adding a column to the table of items. The items may be characterized by various properties of different types.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	propertyName Name of the item property to be created.
protected java.lang.String	type Value type of the item property to be created.

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

timeout

Constructor Summary

Constructors

Constructor and Description
AddItemProperty(java.lang.String propertyName, java.lang.String type) Construct the request

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.lang.Object>	getBodyParameters() Get body parameters
HTTPMethod	getHTTPMethod()
java.lang.String	getPath()
java.lang.String	getPropertyName()
java.util.Map<java.lang.String,java.lang.Object>	getQueryParameters() Get query parameters
java.lang.String	getType()

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

propertyName

protected java.lang.String propertyName

Name of the item property to be created. Currently, the following names are reserved:`id`, `itemid`, case insensitively. Also, the length of the property name must not exceed 63 characters.

type

protected java.lang.String type

Value type of the item property to be created. One of: `int`, `double`, `string`, `boolean`, `timestamp`, `set`, `image` or `imageList`. * `int`- Signed integer number. * `double` - Floating point number. It uses 64-bit base-2 format (IEEE 754 standard). * `string` - UTF-8 string. * `boolean` - *true* / *false* * `timestamp` - Value representing date and time. * `set` - Set of strings. * `image` - URL of an image (`jpeg`, `png` or `gif`). * `imageList` - List of URLs that refer to images.

Constructor Detail

AddItemProperty

public AddItemProperty(java.lang.String propertyName,
                       java.lang.String type)

Construct the request

Parameters:

propertyName - Name of the item property to be created. Currently, the following names are reserved:`id`, `itemid`, case insensitively. Also, the length of the property name must not exceed 63 characters.

type - Value type of the item property to be created. One of: `int`, `double`, `string`, `boolean`, `timestamp`, `set`, `image` or `imageList`. * `int`- Signed integer number. * `double` - Floating point number. It uses 64-bit base-2 format (IEEE 754 standard). * `string` - UTF-8 string. * `boolean` - *true* / *false* * `timestamp` - Value representing date and time. * `set` - Set of strings. * `image` - URL of an image (`jpeg`, `png` or `gif`). * `imageList` - List of URLs that refer to images.

Method Detail

getPropertyName

public java.lang.String getPropertyName()

getType

public java.lang.String getType()

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)