Package com.commercetools.api.client
Class ByProjectKeyMeShoppingListsHead
java.lang.Object
io.vrap.rmf.base.client.ApiMethod<T,TResult>
io.vrap.rmf.base.client.TypeApiMethod<ByProjectKeyMeShoppingListsHead,JsonNode>
com.commercetools.api.client.ByProjectKeyMeShoppingListsHead
- All Implemented Interfaces:
Deprecatable200Trait<ByProjectKeyMeShoppingListsHead>
,ErrorableTrait<ByProjectKeyMeShoppingListsHead>
,ClientRequestCommand<JsonNode>
,CreateHttpRequestCommand
,HttpRequestCommand<JsonNode>
,RequestCommand<JsonNode>
public class ByProjectKeyMeShoppingListsHead
extends TypeApiMethod<ByProjectKeyMeShoppingListsHead,JsonNode>
implements ErrorableTrait<ByProjectKeyMeShoppingListsHead>, Deprecatable200Trait<ByProjectKeyMeShoppingListsHead>
Checks if a ShoppingList matches the given Query Predicate. Returns a 200 OK
status if successful.
A ResourceNotFound error is returned in the following scenarios:
- If no ShoppingList exists for the given Query Predicate.
- If a ShoppingList exists but does not contain either an
anonymousId
that matches the anonymous_id:{id} scope, or acustomer
withid
value that matches the customer:{id} scope.
CompletableFuture<ApiHttpResponse<com.fasterxml.jackson.databind.JsonNode>> result = apiRoot
.withProjectKey("{projectKey}")
.me()
.shoppingLists()
.head()
.execute()
-
Nested Class Summary
Nested classes/interfaces inherited from class io.vrap.rmf.base.client.ApiMethod
ApiMethod.ParamEntry<K,
V> -
Constructor Summary
ConstructorDescriptionByProjectKeyMeShoppingListsHead
(ApiHttpClient apiHttpClient, String projectKey) -
Method Summary
Modifier and TypeMethodDescription<TValue> ByProjectKeyMeShoppingListsHead
addWhere
(Collection<TValue> where) add additional where query parametersadd additional where query parameteradd additional where query parameter<TValue> ByProjectKeyMeShoppingListsHead
addWhere
(TValue where) add additional where query parameterboolean
execute
(ApiHttpClient client) executeBlocking
(ApiHttpClient client, Duration timeout) getWhere()
int
hashCode()
int
com.fasterxml.jackson.core.type.TypeReference<JsonNode>
void
setProjectKey
(String projectKey) toString()
<TValue> ByProjectKeyMeShoppingListsHead
withWhere
(Collection<TValue> where) set where with the specified valuesset where with the specified valueset where with the specified value<TValue> ByProjectKeyMeShoppingListsHead
withWhere
(TValue where) set where with the specified valueMethods 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 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
-
ByProjectKeyMeShoppingListsHead
-
ByProjectKeyMeShoppingListsHead
-
-
Method Details
-
resultType
- Specified by:
resultType
in interfaceHttpRequestCommand<JsonNode>
-
executeBlocking
- Specified by:
executeBlocking
in interfaceClientRequestCommand<JsonNode>
- Specified by:
executeBlocking
in classApiMethod<ByProjectKeyMeShoppingListsHead,
JsonNode>
-
execute
- Specified by:
execute
in interfaceClientRequestCommand<JsonNode>
- Specified by:
execute
in classApiMethod<ByProjectKeyMeShoppingListsHead,
JsonNode>
-
getProjectKey
-
getWhere
-
setProjectKey
-
withWhere
set where with the specified value- Type Parameters:
TValue
- value type- Parameters:
where
- value to be set- Returns:
- ByProjectKeyMeShoppingListsHead
-
addWhere
add additional where query parameter- Type Parameters:
TValue
- value type- Parameters:
where
- value to be added- Returns:
- ByProjectKeyMeShoppingListsHead
-
withWhere
set where with the specified value- Parameters:
supplier
- supplier for the value to be set- Returns:
- ByProjectKeyMeShoppingListsHead
-
addWhere
add additional where query parameter- Parameters:
supplier
- supplier for the value to be added- Returns:
- ByProjectKeyMeShoppingListsHead
-
withWhere
set where with the specified value- Parameters:
op
- builder for the value to be set- Returns:
- ByProjectKeyMeShoppingListsHead
-
addWhere
add additional where query parameter- Parameters:
op
- builder for the value to be added- Returns:
- ByProjectKeyMeShoppingListsHead
-
withWhere
set where with the specified values- Type Parameters:
TValue
- value type- Parameters:
where
- values to be set- Returns:
- ByProjectKeyMeShoppingListsHead
-
addWhere
add additional where query parameters- Type Parameters:
TValue
- value type- Parameters:
where
- values to be added- Returns:
- ByProjectKeyMeShoppingListsHead
-
equals
-
hashCode
public int hashCode() -
toString
-
reflectionHashCode
public int reflectionHashCode()
-