Package com.commercetools.api.client
Class ByProjectKeyShippingMethodsMatchingCartLocationGet
java.lang.Object
io.vrap.rmf.base.client.ApiMethod<T,TResult>
io.vrap.rmf.base.client.TypeApiMethod<ByProjectKeyShippingMethodsMatchingCartLocationGet,ShippingMethodPagedQueryResponse>
com.commercetools.api.client.ByProjectKeyShippingMethodsMatchingCartLocationGet
- All Implemented Interfaces:
Deprecatable200Trait<ByProjectKeyShippingMethodsMatchingCartLocationGet>
,ErrorableTrait<ByProjectKeyShippingMethodsMatchingCartLocationGet>
,ExpandableTrait<ByProjectKeyShippingMethodsMatchingCartLocationGet>
,ClientRequestCommand<ShippingMethodPagedQueryResponse>
,CreateHttpRequestCommand
,HttpRequestCommand<ShippingMethodPagedQueryResponse>
,RequestCommand<ShippingMethodPagedQueryResponse>
public class ByProjectKeyShippingMethodsMatchingCartLocationGet
extends TypeApiMethod<ByProjectKeyShippingMethodsMatchingCartLocationGet,ShippingMethodPagedQueryResponse>
implements ExpandableTrait<ByProjectKeyShippingMethodsMatchingCartLocationGet>, ErrorableTrait<ByProjectKeyShippingMethodsMatchingCartLocationGet>, Deprecatable200Trait<ByProjectKeyShippingMethodsMatchingCartLocationGet>
Retrieves all the active ShippingMethods that can ship to the given Location with a predicate
that matches the given Cart. Each ShippingMethod contains exactly one ShippingRate with the flag isMatching
set to true
. This ShippingRate is used when the ShippingMethod is added to the Cart.
CompletableFuture<ApiHttpResponse<com.commercetools.api.models.shipping_method.ShippingMethodPagedQueryResponse>> result = apiRoot
.withProjectKey("{projectKey}")
.shippingMethods()
.matchingCartLocation()
.get()
.withCountry(country)
.withCartId(cartId)
.execute()
-
Nested Class Summary
Nested classes/interfaces inherited from class io.vrap.rmf.base.client.ApiMethod
ApiMethod.ParamEntry<K,
V> -
Constructor Summary
ConstructorDescriptionByProjectKeyShippingMethodsMatchingCartLocationGet
(ByProjectKeyShippingMethodsMatchingCartLocationGet t) ByProjectKeyShippingMethodsMatchingCartLocationGet
(ApiHttpClient apiHttpClient, String projectKey) -
Method Summary
Modifier and TypeMethodDescriptionaddCartId
(Collection<TValue> cartId) add additional cartId query parametersadd additional cartId query parameteradd additional cartId query parameteraddCartId
(TValue cartId) add additional cartId query parameteraddCountry
(Collection<TValue> country) add additional country query parametersadd additional country query parameteraddCountry
(Supplier<String> supplier) add additional country query parameteraddCountry
(TValue country) add additional country query parameteraddExpand
(Collection<TValue> expand) add additional expand query parametersadd additional expand query parameteradd additional expand query parameteraddExpand
(TValue expand) add additional expand query parameteraddState
(Collection<TValue> state) add additional state query parametersadd additional state query parameteradd additional state query parameteraddState
(TValue state) add additional state query parameterboolean
execute
(ApiHttpClient client) executeBlocking
(ApiHttpClient client, Duration timeout) getState()
int
hashCode()
int
com.fasterxml.jackson.core.type.TypeReference<ShippingMethodPagedQueryResponse>
void
setProjectKey
(String projectKey) toString()
withCartId
(Collection<TValue> cartId) set cartId with the specified valuesset cartId with the specified valuewithCartId
(Supplier<String> supplier) set cartId with the specified valuewithCartId
(TValue cartId) set cartId with the specified valuewithCountry
(Collection<TValue> country) set country with the specified valuesset country with the specified valuewithCountry
(Supplier<String> supplier) set country with the specified valuewithCountry
(TValue country) set country with the specified valuewithExpand
(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 valuewithState
(Collection<TValue> state) set state with the specified valuesset state with the specified valueset state with the specified valuewithState
(TValue state) set state 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
-
ByProjectKeyShippingMethodsMatchingCartLocationGet
public ByProjectKeyShippingMethodsMatchingCartLocationGet(ApiHttpClient apiHttpClient, String projectKey) -
ByProjectKeyShippingMethodsMatchingCartLocationGet
public ByProjectKeyShippingMethodsMatchingCartLocationGet(ByProjectKeyShippingMethodsMatchingCartLocationGet t)
-
-
Method Details
-
resultType
- Specified by:
resultType
in interfaceHttpRequestCommand<ShippingMethodPagedQueryResponse>
-
executeBlocking
public ApiHttpResponse<ShippingMethodPagedQueryResponse> executeBlocking(ApiHttpClient client, Duration timeout) - Specified by:
executeBlocking
in interfaceClientRequestCommand<ShippingMethodPagedQueryResponse>
- Specified by:
executeBlocking
in classApiMethod<ByProjectKeyShippingMethodsMatchingCartLocationGet,
ShippingMethodPagedQueryResponse>
-
execute
public CompletableFuture<ApiHttpResponse<ShippingMethodPagedQueryResponse>> execute(ApiHttpClient client) - Specified by:
execute
in interfaceClientRequestCommand<ShippingMethodPagedQueryResponse>
- Specified by:
execute
in classApiMethod<ByProjectKeyShippingMethodsMatchingCartLocationGet,
ShippingMethodPagedQueryResponse>
-
getProjectKey
-
getCountry
-
getState
-
getCartId
-
getExpand
- Specified by:
getExpand
in interfaceExpandableTrait<ByProjectKeyShippingMethodsMatchingCartLocationGet>
-
setProjectKey
-
withCountry
set country with the specified value- Type Parameters:
TValue
- value type- Parameters:
country
- value to be set- Returns:
- ByProjectKeyShippingMethodsMatchingCartLocationGet
-
addCountry
add additional country query parameter- Type Parameters:
TValue
- value type- Parameters:
country
- value to be added- Returns:
- ByProjectKeyShippingMethodsMatchingCartLocationGet
-
withCountry
set country with the specified value- Parameters:
supplier
- supplier for the value to be set- Returns:
- ByProjectKeyShippingMethodsMatchingCartLocationGet
-
addCountry
add additional country query parameter- Parameters:
supplier
- supplier for the value to be added- Returns:
- ByProjectKeyShippingMethodsMatchingCartLocationGet
-
withCountry
public ByProjectKeyShippingMethodsMatchingCartLocationGet withCountry(Function<StringBuilder, StringBuilder> op) set country with the specified value- Parameters:
op
- builder for the value to be set- Returns:
- ByProjectKeyShippingMethodsMatchingCartLocationGet
-
addCountry
public ByProjectKeyShippingMethodsMatchingCartLocationGet addCountry(Function<StringBuilder, StringBuilder> op) add additional country query parameter- Parameters:
op
- builder for the value to be added- Returns:
- ByProjectKeyShippingMethodsMatchingCartLocationGet
-
withCountry
public <TValue> ByProjectKeyShippingMethodsMatchingCartLocationGet withCountry(Collection<TValue> country) set country with the specified values- Type Parameters:
TValue
- value type- Parameters:
country
- values to be set- Returns:
- ByProjectKeyShippingMethodsMatchingCartLocationGet
-
addCountry
public <TValue> ByProjectKeyShippingMethodsMatchingCartLocationGet addCountry(Collection<TValue> country) add additional country query parameters- Type Parameters:
TValue
- value type- Parameters:
country
- values to be added- Returns:
- ByProjectKeyShippingMethodsMatchingCartLocationGet
-
withState
set state with the specified value- Type Parameters:
TValue
- value type- Parameters:
state
- value to be set- Returns:
- ByProjectKeyShippingMethodsMatchingCartLocationGet
-
addState
add additional state query parameter- Type Parameters:
TValue
- value type- Parameters:
state
- value to be added- Returns:
- ByProjectKeyShippingMethodsMatchingCartLocationGet
-
withState
set state with the specified value- Parameters:
supplier
- supplier for the value to be set- Returns:
- ByProjectKeyShippingMethodsMatchingCartLocationGet
-
addState
add additional state query parameter- Parameters:
supplier
- supplier for the value to be added- Returns:
- ByProjectKeyShippingMethodsMatchingCartLocationGet
-
withState
public ByProjectKeyShippingMethodsMatchingCartLocationGet withState(Function<StringBuilder, StringBuilder> op) set state with the specified value- Parameters:
op
- builder for the value to be set- Returns:
- ByProjectKeyShippingMethodsMatchingCartLocationGet
-
addState
public ByProjectKeyShippingMethodsMatchingCartLocationGet addState(Function<StringBuilder, StringBuilder> op) add additional state query parameter- Parameters:
op
- builder for the value to be added- Returns:
- ByProjectKeyShippingMethodsMatchingCartLocationGet
-
withState
public <TValue> ByProjectKeyShippingMethodsMatchingCartLocationGet withState(Collection<TValue> state) set state with the specified values- Type Parameters:
TValue
- value type- Parameters:
state
- values to be set- Returns:
- ByProjectKeyShippingMethodsMatchingCartLocationGet
-
addState
public <TValue> ByProjectKeyShippingMethodsMatchingCartLocationGet addState(Collection<TValue> state) add additional state query parameters- Type Parameters:
TValue
- value type- Parameters:
state
- values to be added- Returns:
- ByProjectKeyShippingMethodsMatchingCartLocationGet
-
withCartId
set cartId with the specified value- Type Parameters:
TValue
- value type- Parameters:
cartId
- value to be set- Returns:
- ByProjectKeyShippingMethodsMatchingCartLocationGet
-
addCartId
add additional cartId query parameter- Type Parameters:
TValue
- value type- Parameters:
cartId
- value to be added- Returns:
- ByProjectKeyShippingMethodsMatchingCartLocationGet
-
withCartId
set cartId with the specified value- Parameters:
supplier
- supplier for the value to be set- Returns:
- ByProjectKeyShippingMethodsMatchingCartLocationGet
-
addCartId
add additional cartId query parameter- Parameters:
supplier
- supplier for the value to be added- Returns:
- ByProjectKeyShippingMethodsMatchingCartLocationGet
-
withCartId
public ByProjectKeyShippingMethodsMatchingCartLocationGet withCartId(Function<StringBuilder, StringBuilder> op) set cartId with the specified value- Parameters:
op
- builder for the value to be set- Returns:
- ByProjectKeyShippingMethodsMatchingCartLocationGet
-
addCartId
public ByProjectKeyShippingMethodsMatchingCartLocationGet addCartId(Function<StringBuilder, StringBuilder> op) add additional cartId query parameter- Parameters:
op
- builder for the value to be added- Returns:
- ByProjectKeyShippingMethodsMatchingCartLocationGet
-
withCartId
public <TValue> ByProjectKeyShippingMethodsMatchingCartLocationGet withCartId(Collection<TValue> cartId) set cartId with the specified values- Type Parameters:
TValue
- value type- Parameters:
cartId
- values to be set- Returns:
- ByProjectKeyShippingMethodsMatchingCartLocationGet
-
addCartId
public <TValue> ByProjectKeyShippingMethodsMatchingCartLocationGet addCartId(Collection<TValue> cartId) add additional cartId query parameters- Type Parameters:
TValue
- value type- Parameters:
cartId
- values to be added- Returns:
- ByProjectKeyShippingMethodsMatchingCartLocationGet
-
withExpand
set expand with the specified value- Specified by:
withExpand
in interfaceExpandableTrait<ByProjectKeyShippingMethodsMatchingCartLocationGet>
- Type Parameters:
TValue
- value type- Parameters:
expand
- value to be set- Returns:
- ByProjectKeyShippingMethodsMatchingCartLocationGet
-
addExpand
add additional expand query parameter- Specified by:
addExpand
in interfaceExpandableTrait<ByProjectKeyShippingMethodsMatchingCartLocationGet>
- Type Parameters:
TValue
- value type- Parameters:
expand
- value to be added- Returns:
- ByProjectKeyShippingMethodsMatchingCartLocationGet
-
withExpand
set expand with the specified value- Parameters:
supplier
- supplier for the value to be set- Returns:
- ByProjectKeyShippingMethodsMatchingCartLocationGet
-
addExpand
add additional expand query parameter- Parameters:
supplier
- supplier for the value to be added- Returns:
- ByProjectKeyShippingMethodsMatchingCartLocationGet
-
withExpand
public ByProjectKeyShippingMethodsMatchingCartLocationGet withExpand(Function<StringBuilder, StringBuilder> op) set expand with the specified value- Parameters:
op
- builder for the value to be set- Returns:
- ByProjectKeyShippingMethodsMatchingCartLocationGet
-
addExpand
public ByProjectKeyShippingMethodsMatchingCartLocationGet addExpand(Function<StringBuilder, StringBuilder> op) add additional expand query parameter- Parameters:
op
- builder for the value to be added- Returns:
- ByProjectKeyShippingMethodsMatchingCartLocationGet
-
withExpand
public <TValue> ByProjectKeyShippingMethodsMatchingCartLocationGet withExpand(Collection<TValue> expand) set expand with the specified values- Type Parameters:
TValue
- value type- Parameters:
expand
- values to be set- Returns:
- ByProjectKeyShippingMethodsMatchingCartLocationGet
-
addExpand
public <TValue> ByProjectKeyShippingMethodsMatchingCartLocationGet addExpand(Collection<TValue> expand) add additional expand query parameters- Type Parameters:
TValue
- value type- Parameters:
expand
- values to be added- Returns:
- ByProjectKeyShippingMethodsMatchingCartLocationGet
-
equals
-
hashCode
public int hashCode() -
toString
-
reflectionHashCode
public int reflectionHashCode()
-