Package com.commercetools.api.client

Class ByProjectKeyApiClientsHead

java.lang.Object

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

io.vrap.rmf.base.client.TypeApiMethod<ByProjectKeyApiClientsHead,JsonNode>

com.commercetools.api.client.ByProjectKeyApiClientsHead

All Implemented Interfaces:

Deprecatable200Trait<ByProjectKeyApiClientsHead>, ErrorableTrait<ByProjectKeyApiClientsHead>, ClientRequestCommand<JsonNode>, CreateHttpRequestCommand, HttpRequestCommand<JsonNode>, RequestCommand<JsonNode>

public class ByProjectKeyApiClientsHead
extends TypeApiMethod<ByProjectKeyApiClientsHead,JsonNode>
implements ErrorableTrait<ByProjectKeyApiClientsHead>, Deprecatable200Trait<ByProjectKeyApiClientsHead>

Checks if an API Client exists for a given Query Predicate. Returns a 200 OK status if any API Clients match the Query Predicate or a 404 Not Found otherwise.

   CompletableFuture<ApiHttpResponse<com.fasterxml.jackson.databind.JsonNode>> result = apiRoot
            .withProjectKey("{projectKey}")
            .apiClients()
            .head()
            .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
ByProjectKeyApiClientsHead(ByProjectKeyApiClientsHead t)
ByProjectKeyApiClientsHead(ApiHttpClient apiHttpClient, String projectKey)

Method Summary

Modifier and Type	Method	Description
<TValue> ByProjectKeyApiClientsHead	addWhere(Collection<TValue> where)	add additional where query parameters
ByProjectKeyApiClientsHead	addWhere(Function<StringBuilder,StringBuilder> op)	add additional where query parameter
ByProjectKeyApiClientsHead	addWhere(Supplier<String> supplier)	add additional where query parameter
<TValue> ByProjectKeyApiClientsHead	addWhere(TValue where)	add additional where query parameter
boolean	equals(Object o)
CompletableFuture<ApiHttpResponse<JsonNode>>	execute(ApiHttpClient client)
ApiHttpResponse<JsonNode>	executeBlocking(ApiHttpClient client, Duration timeout)
String	getProjectKey()
List<String>	getWhere()
int	hashCode()
int	reflectionHashCode()
com.fasterxml.jackson.core.type.TypeReference<JsonNode>	resultType()
void	setProjectKey(String projectKey)
String	toString()
<TValue> ByProjectKeyApiClientsHead	withWhere(Collection<TValue> where)	set where with the specified values
ByProjectKeyApiClientsHead	withWhere(Function<StringBuilder,StringBuilder> op)	set where with the specified value
ByProjectKeyApiClientsHead	withWhere(Supplier<String> supplier)	set where with the specified value
<TValue> ByProjectKeyApiClientsHead	withWhere(TValue where)	set where 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 com.commercetools.api.client.Deprecatable200Trait

asDeprecatable200Trait, asDeprecatable200TraitToBaseType

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

asErrorableTrait, asErrorableTraitToBaseType

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

executeBlocking

Constructor Details

ByProjectKeyApiClientsHead

public ByProjectKeyApiClientsHead(ApiHttpClient apiHttpClient,
 String projectKey)

ByProjectKeyApiClientsHead

public ByProjectKeyApiClientsHead(ByProjectKeyApiClientsHead t)

Method Details

resultType

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

Specified by:

resultType in interface HttpRequestCommand<JsonNode>

executeBlocking

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

Specified by:

executeBlocking in interface ClientRequestCommand<JsonNode>

Specified by:

executeBlocking in class ApiMethod<ByProjectKeyApiClientsHead,JsonNode>

execute

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

Specified by:

execute in interface ClientRequestCommand<JsonNode>

Specified by:

execute in class ApiMethod<ByProjectKeyApiClientsHead,JsonNode>

getProjectKey

public String getProjectKey()

getWhere

public List<String> getWhere()

setProjectKey

public void setProjectKey(String projectKey)

withWhere

public <TValue> ByProjectKeyApiClientsHead withWhere(TValue where)

set where with the specified value

Type Parameters:

TValue - value type

Parameters:

where - value to be set

Returns:

ByProjectKeyApiClientsHead

addWhere

public <TValue> ByProjectKeyApiClientsHead addWhere(TValue where)

add additional where query parameter

Type Parameters:

TValue - value type

Parameters:

where - value to be added

Returns:

ByProjectKeyApiClientsHead

withWhere

public ByProjectKeyApiClientsHead withWhere(Supplier<String> supplier)

set where with the specified value

Parameters:

supplier - supplier for the value to be set

Returns:

ByProjectKeyApiClientsHead

addWhere

public ByProjectKeyApiClientsHead addWhere(Supplier<String> supplier)

add additional where query parameter

Parameters:

supplier - supplier for the value to be added

Returns:

ByProjectKeyApiClientsHead

withWhere

public ByProjectKeyApiClientsHead withWhere(Function<StringBuilder,StringBuilder> op)

set where with the specified value

Parameters:

op - builder for the value to be set

Returns:

ByProjectKeyApiClientsHead

addWhere

public ByProjectKeyApiClientsHead addWhere(Function<StringBuilder,StringBuilder> op)

add additional where query parameter

Parameters:

op - builder for the value to be added

Returns:

ByProjectKeyApiClientsHead

withWhere

public <TValue> ByProjectKeyApiClientsHead withWhere(Collection<TValue> where)

set where with the specified values

Type Parameters:

TValue - value type

Parameters:

where - values to be set

Returns:

ByProjectKeyApiClientsHead

addWhere

public <TValue> ByProjectKeyApiClientsHead addWhere(Collection<TValue> where)

add additional where query parameters

Type Parameters:

TValue - value type

Parameters:

where - values to be added

Returns:

ByProjectKeyApiClientsHead

equals

public boolean equals(Object o)

hashCode

public int hashCode()

toString

public String toString()

Overrides:

toString in class Object

reflectionHashCode

public int reflectionHashCode()