com.recombee.api_client.api_requests

Class RemoveFromSeries

java.lang.Object

com.recombee.api_client.api_requests.Request

com.recombee.api_client.api_requests.RemoveFromSeries

public class RemoveFromSeries
extends Request

Removes an existing series item from the series.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	itemId ID of the item iff `itemType` is `item`.
protected java.lang.String	itemType Type of the item to be removed.
protected java.lang.String	seriesId ID of the series from which a series item is to be removed.
protected java.lang.Double	time Time index of the item to be removed.

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

timeout

Constructor Summary

Constructors

Constructor and Description
RemoveFromSeries(java.lang.String seriesId, java.lang.String itemType, java.lang.String itemId, double time) 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	getItemId()
java.lang.String	getItemType()
java.lang.String	getPath()
java.util.Map<java.lang.String,java.lang.Object>	getQueryParameters() Get query parameters
java.lang.String	getSeriesId()
double	getTime()

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

seriesId

protected java.lang.String seriesId

ID of the series from which a series item is to be removed.

itemType

protected java.lang.String itemType

Type of the item to be removed.

itemId

protected java.lang.String itemId

ID of the item iff `itemType` is `item`. ID of the series iff `itemType` is `series`.

time

protected java.lang.Double time

Time index of the item to be removed.

Constructor Detail

RemoveFromSeries

public RemoveFromSeries(java.lang.String seriesId,
                        java.lang.String itemType,
                        java.lang.String itemId,
                        double time)

Construct the request

Parameters:

seriesId - ID of the series from which a series item is to be removed.

itemType - Type of the item to be removed.

itemId - ID of the item iff `itemType` is `item`. ID of the series iff `itemType` is `series`.

time - Time index of the item to be removed.

Method Detail

getSeriesId

public java.lang.String getSeriesId()

getItemType

public java.lang.String getItemType()

getItemId

public java.lang.String getItemId()

getTime

public double getTime()

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)