Package com.loop54.model.request

Class GetEntitiesRequest

java.lang.Object

com.loop54.model.request.Request

com.loop54.model.request.GetEntitiesRequest

public class GetEntitiesRequest
extends Request

This class is used to configure a GetEntities request to the Loop54 e-commerce search engine.

Field Summary

Fields

Modifier and Type	Field	Description
final EntityCollectionParameters	resultsOptions	Parameters for specifying which entities to retrieve.

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

customData

Constructor Summary

Constructors

Constructor	Description
GetEntitiesRequest()

Method Summary

Modifier and Type	Method	Description
GetEntitiesRequest	withCustomData(String key, Object value)	Chainable variant of Request.addCustomData(String, Object).
GetEntitiesRequest	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 entities to retrieve. Such as filtering, faceting, sorting and paging. Note that filtering is advised when doing this request.

Constructor Details

GetEntitiesRequest

public GetEntitiesRequest()

Method Details

withResults

public GetEntitiesRequest 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 GetEntitiesRequest 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.