Package com.commercetools.ml.client

Class ByProjectKeyImageSearchPost

java.lang.Object

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

io.vrap.rmf.base.client.BodyApiMethod<T,TResult,TBody>

io.vrap.rmf.base.client.TypeBodyApiMethod<ByProjectKeyImageSearchPost,ImageSearchResponse,File>

com.commercetools.ml.client.ByProjectKeyImageSearchPost

All Implemented Interfaces:

ClientRequestCommand<ImageSearchResponse>, CreateHttpRequestCommand, HttpRequestCommand<ImageSearchResponse>, RequestCommand<ImageSearchResponse>

public class ByProjectKeyImageSearchPost
extends TypeBodyApiMethod<ByProjectKeyImageSearchPost,ImageSearchResponse,File>

Accepts an image file and returns similar products from product catalogue.

   CompletableFuture<ApiHttpResponse<com.commercetools.ml.models.image_search.ImageSearchResponse>> result = apiRoot
            .withProjectKey("{projectKey}")
            .imageSearch()
            .post(file)
            .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
ByProjectKeyImageSearchPost(ByProjectKeyImageSearchPost t)
ByProjectKeyImageSearchPost(ApiHttpClient apiHttpClient, String projectKey, File file)

Method Summary

Modifier and Type	Method	Description
<TValue> ByProjectKeyImageSearchPost	addLimit(Collection<TValue> limit)	add additional limit query parameters
ByProjectKeyImageSearchPost	addLimit(Function<StringBuilder,StringBuilder> op)	add additional limit query parameter
ByProjectKeyImageSearchPost	addLimit(Supplier<Integer> supplier)	add additional limit query parameter
<TValue> ByProjectKeyImageSearchPost	addLimit(TValue limit)	add additional limit query parameter
<TValue> ByProjectKeyImageSearchPost	addOffset(Collection<TValue> offset)	add additional offset query parameters
ByProjectKeyImageSearchPost	addOffset(Function<StringBuilder,StringBuilder> op)	add additional offset query parameter
ByProjectKeyImageSearchPost	addOffset(Supplier<Integer> supplier)	add additional offset query parameter
<TValue> ByProjectKeyImageSearchPost	addOffset(TValue offset)	add additional offset query parameter
boolean	equals(Object o)
CompletableFuture<ApiHttpResponse<ImageSearchResponse>>	execute(ApiHttpClient client)
ApiHttpResponse<ImageSearchResponse>	executeBlocking(ApiHttpClient client, Duration timeout)
File	getBody()
List<String>	getLimit()
List<String>	getOffset()
String	getProjectKey()
int	hashCode()
int	reflectionHashCode()
com.fasterxml.jackson.core.type.TypeReference<ImageSearchResponse>	resultType()
void	setProjectKey(String projectKey)
String	toString()
ByProjectKeyImageSearchPost	withBody(File file)
<TValue> ByProjectKeyImageSearchPost	withLimit(Collection<TValue> limit)	set limit with the specified values
ByProjectKeyImageSearchPost	withLimit(Function<StringBuilder,StringBuilder> op)	set limit with the specified value
ByProjectKeyImageSearchPost	withLimit(Supplier<Integer> supplier)	set limit with the specified value
<TValue> ByProjectKeyImageSearchPost	withLimit(TValue limit)	set limit with the specified value
<TValue> ByProjectKeyImageSearchPost	withOffset(Collection<TValue> offset)	set offset with the specified values
ByProjectKeyImageSearchPost	withOffset(Function<StringBuilder,StringBuilder> op)	set offset with the specified value
ByProjectKeyImageSearchPost	withOffset(Supplier<Integer> supplier)	set offset with the specified value
<TValue> ByProjectKeyImageSearchPost	withOffset(TValue offset)	set offset with the specified value

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 io.vrap.rmf.base.client.ClientRequestCommand

executeBlocking

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

createHttpRequest

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

executeBlocking

Constructor Details

ByProjectKeyImageSearchPost

public ByProjectKeyImageSearchPost(ApiHttpClient apiHttpClient,
 String projectKey,
 File file)

ByProjectKeyImageSearchPost

public ByProjectKeyImageSearchPost(ByProjectKeyImageSearchPost t)

Method Details

resultType

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

executeBlocking

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

Specified by:

executeBlocking in interface ClientRequestCommand<ImageSearchResponse>

Specified by:

executeBlocking in class ApiMethod<ByProjectKeyImageSearchPost,ImageSearchResponse>

execute

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

Specified by:

execute in interface ClientRequestCommand<ImageSearchResponse>

Specified by:

execute in class ApiMethod<ByProjectKeyImageSearchPost,ImageSearchResponse>

getProjectKey

public String getProjectKey()

getLimit

public List<String> getLimit()

getOffset

public List<String> getOffset()

setProjectKey

public void setProjectKey(String projectKey)

withLimit

public <TValue> ByProjectKeyImageSearchPost withLimit(TValue limit)

set limit with the specified value

Type Parameters:

TValue - value type

Parameters:

limit - value to be set

Returns:

ByProjectKeyImageSearchPost

addLimit

public <TValue> ByProjectKeyImageSearchPost addLimit(TValue limit)

add additional limit query parameter

Type Parameters:

TValue - value type

Parameters:

limit - value to be added

Returns:

ByProjectKeyImageSearchPost

withLimit

public ByProjectKeyImageSearchPost withLimit(Supplier<Integer> supplier)

set limit with the specified value

Parameters:

supplier - supplier for the value to be set

Returns:

ByProjectKeyImageSearchPost

addLimit

public ByProjectKeyImageSearchPost addLimit(Supplier<Integer> supplier)

add additional limit query parameter

Parameters:

supplier - supplier for the value to be added

Returns:

ByProjectKeyImageSearchPost

withLimit

public ByProjectKeyImageSearchPost withLimit(Function<StringBuilder,StringBuilder> op)

set limit with the specified value

Parameters:

op - builder for the value to be set

Returns:

ByProjectKeyImageSearchPost

addLimit

public ByProjectKeyImageSearchPost addLimit(Function<StringBuilder,StringBuilder> op)

add additional limit query parameter

Parameters:

op - builder for the value to be added

Returns:

ByProjectKeyImageSearchPost

withLimit

public <TValue> ByProjectKeyImageSearchPost withLimit(Collection<TValue> limit)

set limit with the specified values

Type Parameters:

TValue - value type

Parameters:

limit - values to be set

Returns:

ByProjectKeyImageSearchPost

addLimit

public <TValue> ByProjectKeyImageSearchPost addLimit(Collection<TValue> limit)

add additional limit query parameters

Type Parameters:

TValue - value type

Parameters:

limit - values to be added

Returns:

ByProjectKeyImageSearchPost

withOffset

public <TValue> ByProjectKeyImageSearchPost withOffset(TValue offset)

set offset with the specified value

Type Parameters:

TValue - value type

Parameters:

offset - value to be set

Returns:

ByProjectKeyImageSearchPost

addOffset

public <TValue> ByProjectKeyImageSearchPost addOffset(TValue offset)

add additional offset query parameter

Type Parameters:

TValue - value type

Parameters:

offset - value to be added

Returns:

ByProjectKeyImageSearchPost

withOffset

public ByProjectKeyImageSearchPost withOffset(Supplier<Integer> supplier)

set offset with the specified value

Parameters:

supplier - supplier for the value to be set

Returns:

ByProjectKeyImageSearchPost

addOffset

public ByProjectKeyImageSearchPost addOffset(Supplier<Integer> supplier)

add additional offset query parameter

Parameters:

supplier - supplier for the value to be added

Returns:

ByProjectKeyImageSearchPost

withOffset

public ByProjectKeyImageSearchPost withOffset(Function<StringBuilder,StringBuilder> op)

set offset with the specified value

Parameters:

op - builder for the value to be set

Returns:

ByProjectKeyImageSearchPost

addOffset

public ByProjectKeyImageSearchPost addOffset(Function<StringBuilder,StringBuilder> op)

add additional offset query parameter

Parameters:

op - builder for the value to be added

Returns:

ByProjectKeyImageSearchPost

withOffset

public <TValue> ByProjectKeyImageSearchPost withOffset(Collection<TValue> offset)

set offset with the specified values

Type Parameters:

TValue - value type

Parameters:

offset - values to be set

Returns:

ByProjectKeyImageSearchPost

addOffset

public <TValue> ByProjectKeyImageSearchPost addOffset(Collection<TValue> offset)

add additional offset query parameters

Type Parameters:

TValue - value type

Parameters:

offset - values to be added

Returns:

ByProjectKeyImageSearchPost

getBody

public File getBody()

Overrides:

getBody in class TypeBodyApiMethod<ByProjectKeyImageSearchPost,ImageSearchResponse,File>

withBody

public ByProjectKeyImageSearchPost withBody(File file)

Overrides:

withBody in class TypeBodyApiMethod<ByProjectKeyImageSearchPost,ImageSearchResponse,File>

equals

public boolean equals(Object o)

hashCode

public int hashCode()

toString

public String toString()

Overrides:

toString in class Object

reflectionHashCode

public int reflectionHashCode()