Package com.commercetools.api.client

Class ByProjectKeyProductProjectionsSearchPost

java.lang.Object

io.vrap.rmf.base.client.ApiMethod<T,TResult>

io.vrap.rmf.base.client.TypeApiMethod<ByProjectKeyProductProjectionsSearchPost,ProductProjectionPagedSearchResponse>

com.commercetools.api.client.ByProjectKeyProductProjectionsSearchPost

All Implemented Interfaces:

ByProjectKeyProductProjectionsSearchPostMixin, ErrorableTrait<ByProjectKeyProductProjectionsSearchPost>, ClientRequestCommand<ProductProjectionPagedSearchResponse>, CreateHttpRequestCommand, HttpRequestCommand<ProductProjectionPagedSearchResponse>, RequestCommand<ProductProjectionPagedSearchResponse>

public class ByProjectKeyProductProjectionsSearchPost
extends TypeApiMethod<ByProjectKeyProductProjectionsSearchPost,ProductProjectionPagedSearchResponse>
implements ByProjectKeyProductProjectionsSearchPostMixin, ErrorableTrait<ByProjectKeyProductProjectionsSearchPost>

For implementing funnel search on Product Listing Pages where users select multiple filters, use this POST method. To avoid URL length restrictions, this method passes the same query parameters as defined in the GET method, within the request body in URL-encoded format.

   CompletableFuture<ApiHttpResponse<com.commercetools.api.models.product.ProductProjectionPagedSearchResponse>> result = apiRoot
            .withProjectKey("{projectKey}")
            .productProjections()
            .search()
            .post(null)
            .execute()
 

Nested Class Summary

Nested classes/interfaces inherited from class io.vrap.rmf.base.client.ApiMethod

ApiMethod.ParamEntry<K,V>

Constructor Summary

Constructors

Constructor	Description
ByProjectKeyProductProjectionsSearchPost(ByProjectKeyProductProjectionsSearchPost t)
ByProjectKeyProductProjectionsSearchPost(ApiHttpClient apiHttpClient, String projectKey, List<ApiMethod.ParamEntry<String,String>> formParams)

Method Summary

Modifier and Type	Method	Description
<V> ByProjectKeyProductProjectionsSearchPost	addFormParam(String key, V value)	add an additional form parameter
ByProjectKeyProductProjectionsSearchPost	addFormParams(List<ApiMethod.ParamEntry<String,String>> formParams)	add the form parameters
boolean	equals(Object o)
CompletableFuture<ApiHttpResponse<ProductProjectionPagedSearchResponse>>	execute(ApiHttpClient client)
ApiHttpResponse<ProductProjectionPagedSearchResponse>	executeBlocking(ApiHttpClient client, Duration timeout)
String	getFirstFormParam(String key)
List<String>	getFormParam(String key)
List<ApiMethod.ParamEntry<String,String>>	getFormParams()
String	getFormParamUriString()
List<String>	getFormParamUriStrings()
String	getProjectKey()
int	hashCode()
int	reflectionHashCode()
com.fasterxml.jackson.core.type.TypeReference<ProductProjectionPagedSearchResponse>	resultType()
void	setProjectKey(String projectKey)
String	toString()
<V> ByProjectKeyProductProjectionsSearchPost	withFormParam(String key, V value)	set the form parameter with the specified value
ByProjectKeyProductProjectionsSearchPost	withFormParams(List<ApiMethod.ParamEntry<String,String>> formParams)	set the form parameters
ByProjectKeyProductProjectionsSearchPost	withoutFormParam(String key)	removes the specified form parameter

Methods inherited from class io.vrap.rmf.base.client.ApiMethod

addHeader, addQueryParam, addQueryParams, contentType, createHttpRequest, execute, execute, execute, execute, execute, execute, execute, executeBlocking, executeBlocking, executeBlocking, executeBlocking, executeBlocking, executeBlocking, executeBlocking, executeBlocking, executeBlocking, executeBlocking, executeBlocking, executeBlocking, executeBlocking, getFirstQueryParam, getHeaders, getQueryParam, getQueryParams, getQueryParamUriString, getQueryParamUriStrings, send, sendBlocking, sendBlocking, with, with, withHeader, withHeaders, withHttpRequest, withoutHeader, withoutQueryParam, withQueryParam, withQueryParams

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.commercetools.api.client.ByProjectKeyProductProjectionsSearchPostMixin

addExpand, addExpand, addExpand, addExpand, addFacet, addFacet, addFacet, addFacet, addFilter, addFilter, addFilter, addFilter, addFilterFacets, addFilterFacets, addFilterFacets, addFilterFacets, addFilterQuery, addFilterQuery, addFilterQuery, addFilterQuery, addFuzzy, addFuzzy, addFuzzy, addFuzzy, addFuzzyLevel, addFuzzyLevel, addFuzzyLevel, addFuzzyLevel, addLimit, addLimit, addLimit, addLimit, addLocaleProjection, addLocaleProjection, addLocaleProjection, addLocaleProjection, addMarkMatchingVariants, addMarkMatchingVariants, addMarkMatchingVariants, addMarkMatchingVariants, addOffset, addOffset, addOffset, addOffset, addPriceChannel, addPriceChannel, addPriceChannel, addPriceChannel, addPriceCountry, addPriceCountry, addPriceCountry, addPriceCountry, addPriceCurrency, addPriceCurrency, addPriceCurrency, addPriceCurrency, addPriceCustomerGroup, addPriceCustomerGroup, addPriceCustomerGroup, addPriceCustomerGroup, addSort, addSort, addSort, addSort, addStaged, addStaged, addStaged, addStaged, addStoreProjection, addStoreProjection, addStoreProjection, addStoreProjection, addText, addText, addWithTotal, addWithTotal, addWithTotal, addWithTotal, facet, facetDsl, filter, filterDsl, filterFacets, filterQuery, withExpand, withExpand, withExpand, withExpand, withFacet, withFacet, withFacet, withFacet, withFilter, withFilter, withFilter, withFilter, withFilterFacets, withFilterFacets, withFilterFacets, withFilterFacets, withFilterQuery, withFilterQuery, withFilterQuery, withFilterQuery, withFuzzy, withFuzzy, withFuzzy, withFuzzy, withFuzzyLevel, withFuzzyLevel, withFuzzyLevel, withFuzzyLevel, withLimit, withLimit, withLimit, withLimit, withLocaleProjection, withLocaleProjection, withLocaleProjection, withLocaleProjection, withMarkMatchingVariants, withMarkMatchingVariants, withMarkMatchingVariants, withMarkMatchingVariants, withOffset, withOffset, withOffset, withOffset, withPriceChannel, withPriceChannel, withPriceChannel, withPriceChannel, withPriceCountry, withPriceCountry, withPriceCountry, withPriceCountry, withPriceCurrency, withPriceCurrency, withPriceCurrency, withPriceCurrency, withPriceCustomerGroup, withPriceCustomerGroup, withPriceCustomerGroup, withPriceCustomerGroup, withSort, withSort, withSort, withSort, withStaged, withStaged, withStaged, withStaged, withStoreProjection, withStoreProjection, withStoreProjection, withStoreProjection, withText, withText, withWithTotal, withWithTotal, withWithTotal, withWithTotal

Methods inherited from interface io.vrap.rmf.base.client.ClientRequestCommand

executeBlocking

Methods inherited from interface io.vrap.rmf.base.client.CreateHttpRequestCommand

createHttpRequest

Methods inherited from interface com.commercetools.api.client.ErrorableTrait

asErrorableTrait, asErrorableTraitToBaseType

Methods inherited from interface io.vrap.rmf.base.client.RequestCommand

executeBlocking

Constructor Details

ByProjectKeyProductProjectionsSearchPost

public ByProjectKeyProductProjectionsSearchPost(ApiHttpClient apiHttpClient,
 String projectKey,
 List<ApiMethod.ParamEntry<String,String>> formParams)

ByProjectKeyProductProjectionsSearchPost

public ByProjectKeyProductProjectionsSearchPost(ByProjectKeyProductProjectionsSearchPost t)

Method Details

resultType

public com.fasterxml.jackson.core.type.TypeReference<ProductProjectionPagedSearchResponse> resultType()

Specified by:

resultType in interface HttpRequestCommand<ProductProjectionPagedSearchResponse>

executeBlocking

public ApiHttpResponse<ProductProjectionPagedSearchResponse> executeBlocking(ApiHttpClient client,
 Duration timeout)

Specified by:

executeBlocking in interface ClientRequestCommand<ProductProjectionPagedSearchResponse>

Specified by:

executeBlocking in class ApiMethod<ByProjectKeyProductProjectionsSearchPost,ProductProjectionPagedSearchResponse>

execute

public CompletableFuture<ApiHttpResponse<ProductProjectionPagedSearchResponse>> execute(ApiHttpClient client)

Specified by:

execute in interface ClientRequestCommand<ProductProjectionPagedSearchResponse>

Specified by:

execute in class ApiMethod<ByProjectKeyProductProjectionsSearchPost,ProductProjectionPagedSearchResponse>

getProjectKey

public String getProjectKey()

setProjectKey

public void setProjectKey(String projectKey)

addFormParam

public <V> ByProjectKeyProductProjectionsSearchPost addFormParam(String key,
 V value)

add an additional form parameter

Specified by:

addFormParam in interface ByProjectKeyProductProjectionsSearchPostMixin

Type Parameters:

V - value type

Parameters:

key - form parameter name

value - form parameter value

Returns:

ByProjectKeyProductProjectionsSearchPost

withFormParam

public <V> ByProjectKeyProductProjectionsSearchPost withFormParam(String key,
 V value)

set the form parameter with the specified value

Specified by:

withFormParam in interface ByProjectKeyProductProjectionsSearchPostMixin

Type Parameters:

V - value type

Parameters:

key - form parameter name

value - form parameter value

Returns:

ByProjectKeyProductProjectionsSearchPost

withoutFormParam

public ByProjectKeyProductProjectionsSearchPost withoutFormParam(String key)

removes the specified form parameter

Specified by:

withoutFormParam in interface ByProjectKeyProductProjectionsSearchPostMixin

Parameters:

key - form parameter name

Returns:

ByProjectKeyProductProjectionsSearchPost

withFormParams

public ByProjectKeyProductProjectionsSearchPost withFormParams(List<ApiMethod.ParamEntry<String,String>> formParams)

set the form parameters

Specified by:

withFormParams in interface ByProjectKeyProductProjectionsSearchPostMixin

Parameters:

formParams - list of form parameters

Returns:

ByProjectKeyProductProjectionsSearchPost

addFormParams

public ByProjectKeyProductProjectionsSearchPost addFormParams(List<ApiMethod.ParamEntry<String,String>> formParams)

add the form parameters

Specified by:

addFormParams in interface ByProjectKeyProductProjectionsSearchPostMixin

Parameters:

formParams - list of form parameters

Returns:

ByProjectKeyProductProjectionsSearchPost

getFormParams

public List<ApiMethod.ParamEntry<String,String>> getFormParams()

getFormParam

public List<String> getFormParam(String key)

getFormParamUriStrings

public List<String> getFormParamUriStrings()

getFormParamUriString

public String getFormParamUriString()

getFirstFormParam

@Nullable
public String getFirstFormParam(String key)

equals

public boolean equals(Object o)

hashCode

public int hashCode()

toString

public String toString()

Overrides:

toString in class Object

reflectionHashCode

public int reflectionHashCode()