com.recombee.api_client.api_requests

Class InsertToGroup

java.lang.Object

com.recombee.api_client.api_requests.Request

com.recombee.api_client.api_requests.InsertToGroup

public class InsertToGroup
extends Request

Inserts an existing item/group into group of given `groupId`.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.Boolean	cascadeCreate Indicates that any non-existing entity specified within the request should be created (as is corresponding PUT requests were invoked).
protected java.lang.String	groupId ID of the group to be inserted into.
protected java.lang.String	itemId ID of the item iff `itemType` is `item`.
protected java.lang.String	itemType `item` iff the regular item from the catalog is to be inserted, `group` iff group is inserted as the item.

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

timeout

Constructor Summary

Constructors

Constructor and Description
InsertToGroup(java.lang.String groupId, java.lang.String itemType, java.lang.String itemId) Construct the request

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.lang.Object>	getBodyParameters() Get body parameters
boolean	getCascadeCreate()
java.lang.String	getGroupId()
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
InsertToGroup	setCascadeCreate(boolean cascadeCreate)

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

groupId

protected java.lang.String groupId

ID of the group to be inserted into.

itemType

protected java.lang.String itemType

`item` iff the regular item from the catalog is to be inserted, `group` iff group is inserted as the item.

itemId

protected java.lang.String itemId

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

cascadeCreate

protected java.lang.Boolean cascadeCreate

Indicates that any non-existing entity specified within the request should be created (as is corresponding PUT requests were invoked). This concerns both the `groupId` and the `groupId`. If `cascadeCreate` is set true, the behavior also depends on the `itemType`. Either items or group may be created if not present in the database.

Constructor Detail

InsertToGroup

public InsertToGroup(java.lang.String groupId,
                     java.lang.String itemType,
                     java.lang.String itemId)

Construct the request

Parameters:

groupId - ID of the group to be inserted into.

itemType - `item` iff the regular item from the catalog is to be inserted, `group` iff group is inserted as the item.

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

Method Detail

setCascadeCreate

public InsertToGroup setCascadeCreate(boolean cascadeCreate)

Parameters:

cascadeCreate - Indicates that any non-existing entity specified within the request should be created (as is corresponding PUT requests were invoked). This concerns both the `groupId` and the `groupId`. If `cascadeCreate` is set true, the behavior also depends on the `itemType`. Either items or group may be created if not present in the database.

getGroupId

public java.lang.String getGroupId()

getItemType

public java.lang.String getItemType()

getItemId

public java.lang.String getItemId()

getCascadeCreate

public boolean getCascadeCreate()

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)