Package com.commercetools.api.models.project

Interface SearchIndexingConfiguration

public interface SearchIndexingConfiguration

Controls indexing of resources to be provided on high performance read-only search endpoints.

Example to create an instance using the builder pattern

     SearchIndexingConfiguration searchIndexingConfiguration = SearchIndexingConfiguration.builder()
             .build()
 

Method Summary

Modifier and Type	Method	Description
static SearchIndexingConfigurationBuilder	builder()	builder factory method for SearchIndexingConfiguration
static SearchIndexingConfigurationBuilder	builder(SearchIndexingConfiguration template)	create builder for SearchIndexingConfiguration instance
static SearchIndexingConfiguration	deepCopy(SearchIndexingConfiguration template)	factory method to create a deep copy of SearchIndexingConfiguration
@Valid SearchIndexingConfigurationValues	getCustomers()	Configuration for the Customer Search feature.
@Valid SearchIndexingConfigurationValues	getOrders()	Configuration for the Order Search feature.
@Valid SearchIndexingConfigurationValues	getProducts()	Configuration for the Product Projection Search and Product Suggestions endpoints.
@Valid SearchIndexingConfigurationValues	getProductsSearch()	Configuration for the Product Search feature.
static SearchIndexingConfiguration	of()	factory method
static SearchIndexingConfiguration	of(SearchIndexingConfiguration template)	factory method to create a shallow copy SearchIndexingConfiguration
void	setCustomers(SearchIndexingConfigurationValues customers)	Configuration for the Customer Search feature.
void	setOrders(SearchIndexingConfigurationValues orders)	Configuration for the Order Search feature.
void	setProducts(SearchIndexingConfigurationValues products)	Configuration for the Product Projection Search and Product Suggestions endpoints.
void	setProductsSearch(SearchIndexingConfigurationValues productsSearch)	Configuration for the Product Search feature.
static com.fasterxml.jackson.core.type.TypeReference<SearchIndexingConfiguration>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withSearchIndexingConfiguration(Function<SearchIndexingConfiguration,T> helper)	accessor map function

Method Details

getProducts

@Valid
@Valid SearchIndexingConfigurationValues getProducts()

Configuration for the Product Projection Search and Product Suggestions endpoints.

Returns:

products

getProductsSearch

@Valid
@Valid SearchIndexingConfigurationValues getProductsSearch()

Configuration for the Product Search feature.

Returns:

productsSearch

getOrders

@Valid
@Valid SearchIndexingConfigurationValues getOrders()

Configuration for the Order Search feature.

Returns:

orders

getCustomers

@Valid
@Valid SearchIndexingConfigurationValues getCustomers()

Configuration for the Customer Search feature.

Returns:

customers

setProducts

void setProducts(SearchIndexingConfigurationValues products)

Configuration for the Product Projection Search and Product Suggestions endpoints.

Parameters:

products - value to be set

setProductsSearch

void setProductsSearch(SearchIndexingConfigurationValues productsSearch)

Configuration for the Product Search feature.

Parameters:

productsSearch - value to be set

setOrders

void setOrders(SearchIndexingConfigurationValues orders)

Configuration for the Order Search feature.

Parameters:

orders - value to be set

setCustomers

void setCustomers(SearchIndexingConfigurationValues customers)

Configuration for the Customer Search feature.

Parameters:

customers - value to be set

of

static SearchIndexingConfiguration of()

factory method

Returns:

instance of SearchIndexingConfiguration

of

static SearchIndexingConfiguration of(SearchIndexingConfiguration template)

factory method to create a shallow copy SearchIndexingConfiguration

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static SearchIndexingConfiguration deepCopy(@Nullable
 SearchIndexingConfiguration template)

factory method to create a deep copy of SearchIndexingConfiguration

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static SearchIndexingConfigurationBuilder builder()

builder factory method for SearchIndexingConfiguration

Returns:

builder

builder

static SearchIndexingConfigurationBuilder builder(SearchIndexingConfiguration template)

create builder for SearchIndexingConfiguration instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withSearchIndexingConfiguration

default <T> T withSearchIndexingConfiguration(Function<SearchIndexingConfiguration,T> helper)

accessor map function

Type Parameters:

T - mapped type

Parameters:

helper - function to map the object

Returns:

mapped value

typeReference

static com.fasterxml.jackson.core.type.TypeReference<SearchIndexingConfiguration> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference