Package com.commercetools.api.client
Class ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsKeyByKeyGet
java.lang.Object
io.vrap.rmf.base.client.ApiMethod<T,TResult>
io.vrap.rmf.base.client.TypeApiMethod<ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsKeyByKeyGet,ShoppingList>
com.commercetools.api.client.ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsKeyByKeyGet
- All Implemented Interfaces:
Deprecatable200Trait<ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsKeyByKeyGet>
,ErrorableTrait<ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsKeyByKeyGet>
,ExpandableTrait<ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsKeyByKeyGet>
,ClientRequestCommand<ShoppingList>
,CreateHttpRequestCommand
,HttpRequestCommand<ShoppingList>
,RequestCommand<ShoppingList>
public class ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsKeyByKeyGet
extends TypeApiMethod<ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsKeyByKeyGet,ShoppingList>
implements ExpandableTrait<ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsKeyByKeyGet>, ErrorableTrait<ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsKeyByKeyGet>, Deprecatable200Trait<ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsKeyByKeyGet>
Returns a ShoppingList for a given key
in a Store. Returns 200 OK
status if successful.
A ResourceNotFound error is returned in the following scenarios:
- If no ShoppingList matches the given
key
in a Store. - If a ShoppingList matches the given
key
but does not have astore
specified, or thestore
field references a different Store. - If a ShoppingList matches the given
key
in a Store but does not contain either ananonymousId
that matches the anonymous_id:{id} scope, or acustomer
withid
value that matches the customer:{id} scope.
CompletableFuture<ApiHttpResponse<com.commercetools.api.models.shopping_list.ShoppingList>> result = apiRoot
.withProjectKey("{projectKey}")
.inStoreKeyWithStoreKeyValue("{storeKey}")
.me()
.shoppingLists()
.withKey("{key}")
.get()
.execute()
-
Nested Class Summary
Nested classes/interfaces inherited from class io.vrap.rmf.base.client.ApiMethod
ApiMethod.ParamEntry<K,
V> -
Constructor Summary
ConstructorDescriptionByProjectKeyInStoreKeyByStoreKeyMeShoppingListsKeyByKeyGet
(ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsKeyByKeyGet t) ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsKeyByKeyGet
(ApiHttpClient apiHttpClient, String projectKey, String storeKey, String key) -
Method Summary
Modifier and TypeMethodDescriptionaddExpand
(Collection<TValue> expand) add additional expand query parametersadd additional expand query parameteradd additional expand query parameteraddExpand
(TValue expand) add additional expand query parameterboolean
execute
(ApiHttpClient client) executeBlocking
(ApiHttpClient client, Duration timeout) getKey()
int
hashCode()
int
com.fasterxml.jackson.core.type.TypeReference<ShoppingList>
void
void
setProjectKey
(String projectKey) void
setStoreKey
(String storeKey) toString()
withExpand
(Collection<TValue> expand) set expand with the specified valuesset expand with the specified valuewithExpand
(Supplier<String> supplier) set expand with the specified valuewithExpand
(TValue expand) set expand 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 com.commercetools.api.client.ExpandableTrait
asExpandableTrait, asExpandableTraitToBaseType
Methods inherited from interface io.vrap.rmf.base.client.RequestCommand
executeBlocking
-
Constructor Details
-
ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsKeyByKeyGet
public ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsKeyByKeyGet(ApiHttpClient apiHttpClient, String projectKey, String storeKey, String key) -
ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsKeyByKeyGet
public ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsKeyByKeyGet(ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsKeyByKeyGet t)
-
-
Method Details
-
resultType
- Specified by:
resultType
in interfaceHttpRequestCommand<ShoppingList>
-
executeBlocking
- Specified by:
executeBlocking
in interfaceClientRequestCommand<ShoppingList>
- Specified by:
executeBlocking
in classApiMethod<ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsKeyByKeyGet,
ShoppingList>
-
execute
- Specified by:
execute
in interfaceClientRequestCommand<ShoppingList>
- Specified by:
execute
in classApiMethod<ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsKeyByKeyGet,
ShoppingList>
-
getProjectKey
-
getStoreKey
-
getKey
-
getExpand
- Specified by:
getExpand
in interfaceExpandableTrait<ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsKeyByKeyGet>
-
setProjectKey
-
setStoreKey
-
setKey
-
withExpand
public <TValue> ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsKeyByKeyGet withExpand(TValue expand) set expand with the specified value- Specified by:
withExpand
in interfaceExpandableTrait<ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsKeyByKeyGet>
- Type Parameters:
TValue
- value type- Parameters:
expand
- value to be set- Returns:
- ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsKeyByKeyGet
-
addExpand
add additional expand query parameter- Specified by:
addExpand
in interfaceExpandableTrait<ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsKeyByKeyGet>
- Type Parameters:
TValue
- value type- Parameters:
expand
- value to be added- Returns:
- ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsKeyByKeyGet
-
withExpand
public ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsKeyByKeyGet withExpand(Supplier<String> supplier) set expand with the specified value- Parameters:
supplier
- supplier for the value to be set- Returns:
- ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsKeyByKeyGet
-
addExpand
public ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsKeyByKeyGet addExpand(Supplier<String> supplier) add additional expand query parameter- Parameters:
supplier
- supplier for the value to be added- Returns:
- ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsKeyByKeyGet
-
withExpand
public ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsKeyByKeyGet withExpand(Function<StringBuilder, StringBuilder> op) set expand with the specified value- Parameters:
op
- builder for the value to be set- Returns:
- ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsKeyByKeyGet
-
addExpand
public ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsKeyByKeyGet addExpand(Function<StringBuilder, StringBuilder> op) add additional expand query parameter- Parameters:
op
- builder for the value to be added- Returns:
- ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsKeyByKeyGet
-
withExpand
public <TValue> ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsKeyByKeyGet withExpand(Collection<TValue> expand) set expand with the specified values- Type Parameters:
TValue
- value type- Parameters:
expand
- values to be set- Returns:
- ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsKeyByKeyGet
-
addExpand
public <TValue> ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsKeyByKeyGet addExpand(Collection<TValue> expand) add additional expand query parameters- Type Parameters:
TValue
- value type- Parameters:
expand
- values to be added- Returns:
- ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsKeyByKeyGet
-
equals
-
hashCode
public int hashCode() -
toString
-
reflectionHashCode
public int reflectionHashCode()
-