Package com.loop54.model.request

Class GetRecommendedEntitiesRequest

java.lang.Object

com.loop54.model.request.Request

com.loop54.model.request.GetRecommendedEntitiesRequest

public class GetRecommendedEntitiesRequest
extends Request

This class is used to perform a request to get personalized recommendations.

Field Summary

Fields

Modifier and Type	Field	Description
final EntityCollectionParameters	resultsOptions	Parameters for specifying which recommendations results to retrieve and how to format them.

Fields inherited from class com.loop54.model.request.Request

customData

Constructor Summary

Constructors

Constructor	Description
GetRecommendedEntitiesRequest()

Method Summary

Modifier and Type	Method	Description
GetRecommendedEntitiesRequest	withCustomData(String key, Object value)	Chainable variant of Request.addCustomData(String, Object).
GetRecommendedEntitiesRequest	withResults(Consumer<EntityCollectionParameters> configurator)	Configures resultsOptions, e.g.

Methods inherited from class com.loop54.model.request.Request

addCustomData

Methods inherited from class java.lang.Object

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

Field Details

resultsOptions

public final EntityCollectionParameters resultsOptions

Parameters for specifying which recommendations results to retrieve and how to format them.

Constructor Details

GetRecommendedEntitiesRequest

public GetRecommendedEntitiesRequest()

Method Details

withResults

public GetRecommendedEntitiesRequest withResults(Consumer<EntityCollectionParameters> configurator)

Configures resultsOptions, e.g. request.withResults(r -> r.page(0, 20).distinctFacet("Category")).

Parameters:

configurator - Applied to resultsOptions.

Returns:

This request, for chaining.

withCustomData

public GetRecommendedEntitiesRequest withCustomData(String key,
 Object value)

Description copied from class: Request

Chainable variant of Request.addCustomData(String, Object). Subclasses override this to return their own type.

Overrides:

withCustomData in class Request

Parameters:

key - Key to set the data on. The keys will be treated as case-sensitive.

value - Value to add to the custom data.

Returns:

This request, for chaining.