Package com.commercetools.api.client

Class ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsHead

java.lang.Object

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

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

com.commercetools.api.client.ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsHead

All Implemented Interfaces:

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

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

Checks if a ShoppingList exists for a given Query Predicate. Returns a 200 OK if any ShoppingLists match the Query Predicate; otherwise, returns a ResourceNotFound error.

   CompletableFuture<ApiHttpResponse<com.fasterxml.jackson.databind.JsonNode>> result = apiRoot
            .withProjectKey("{projectKey}")
            .asAssociate()
            .withAssociateIdValue("{associateId}")
            .inBusinessUnitKeyWithBusinessUnitKeyValue("{businessUnitKey}")
            .shoppingLists()
            .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
ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsHead(ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsHead t)
ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsHead(ApiHttpClient apiHttpClient, String projectKey, String associateId, String businessUnitKey)

Method Summary

Modifier and Type	Method	Description
<TValue> ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsHead	addWhere(Collection<TValue> where)	add additional where query parameters
ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsHead	addWhere(Function<StringBuilder,StringBuilder> op)	add additional where query parameter
ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsHead	addWhere(Supplier<String> supplier)	add additional where query parameter
<TValue> ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsHead	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	getAssociateId()
String	getBusinessUnitKey()
String	getProjectKey()
List<String>	getWhere()
int	hashCode()
int	reflectionHashCode()
com.fasterxml.jackson.core.type.TypeReference<JsonNode>	resultType()
void	setAssociateId(String associateId)
void	setBusinessUnitKey(String businessUnitKey)
void	setProjectKey(String projectKey)
String	toString()
<TValue> ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsHead	withWhere(Collection<TValue> where)	set where with the specified values
ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsHead	withWhere(Function<StringBuilder,StringBuilder> op)	set where with the specified value
ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsHead	withWhere(Supplier<String> supplier)	set where with the specified value
<TValue> ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsHead	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

ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsHead

public ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsHead(ApiHttpClient apiHttpClient,
 String projectKey,
 String associateId,
 String businessUnitKey)

ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsHead

public ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsHead(ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsHead 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<ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsHead,JsonNode>

execute

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

Specified by:

execute in interface ClientRequestCommand<JsonNode>

Specified by:

execute in class ApiMethod<ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsHead,JsonNode>

getProjectKey

public String getProjectKey()

getAssociateId

public String getAssociateId()

getBusinessUnitKey

public String getBusinessUnitKey()

getWhere

public List<String> getWhere()

setProjectKey

public void setProjectKey(String projectKey)

setAssociateId

public void setAssociateId(String associateId)

setBusinessUnitKey

public void setBusinessUnitKey(String businessUnitKey)

withWhere

public <TValue>
ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsHead withWhere(TValue where)

set where with the specified value

Type Parameters:

TValue - value type

Parameters:

where - value to be set

Returns:

ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsHead

addWhere

public <TValue>
ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsHead addWhere(TValue where)

add additional where query parameter

Type Parameters:

TValue - value type

Parameters:

where - value to be added

Returns:

ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsHead

withWhere

public ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsHead withWhere(Supplier<String> supplier)

set where with the specified value

Parameters:

supplier - supplier for the value to be set

Returns:

ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsHead

addWhere

public ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsHead addWhere(Supplier<String> supplier)

add additional where query parameter

Parameters:

supplier - supplier for the value to be added

Returns:

ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsHead

withWhere

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

set where with the specified value

Parameters:

op - builder for the value to be set

Returns:

ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsHead

addWhere

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

add additional where query parameter

Parameters:

op - builder for the value to be added

Returns:

ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsHead

withWhere

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

set where with the specified values

Type Parameters:

TValue - value type

Parameters:

where - values to be set

Returns:

ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsHead

addWhere

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

add additional where query parameters

Type Parameters:

TValue - value type

Parameters:

where - values to be added

Returns:

ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsHead

equals

public boolean equals(Object o)

hashCode

public int hashCode()

toString

public String toString()

Overrides:

toString in class Object

reflectionHashCode

public int reflectionHashCode()