Package com.commercetools.api.client

Class ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsByIDGet

java.lang.Object

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

io.vrap.rmf.base.client.TypeApiMethod<ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsByIDGet,ShoppingList>

com.commercetools.api.client.ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsByIDGet

All Implemented Interfaces:

Deprecatable200Trait<ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsByIDGet>, ErrorableTrait<ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsByIDGet>, ExpandableTrait<ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsByIDGet>, ClientRequestCommand<ShoppingList>, CreateHttpRequestCommand, HttpRequestCommand<ShoppingList>, RequestCommand<ShoppingList>

public class ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsByIDGet
extends TypeApiMethod<ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsByIDGet,ShoppingList>
implements ExpandableTrait<ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsByIDGet>, ErrorableTrait<ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsByIDGet>, Deprecatable200Trait<ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsByIDGet>

If the ShoppingList exists in the Project but does not reference the requested BusinessUnit, this method returns an InvalidOperation error.

   CompletableFuture<ApiHttpResponse<com.commercetools.api.models.shopping_list.ShoppingList>> result = apiRoot
            .withProjectKey("{projectKey}")
            .asAssociate()
            .withAssociateIdValue("{associateId}")
            .inBusinessUnitKeyWithBusinessUnitKeyValue("{businessUnitKey}")
            .shoppingLists()
            .withId("{ID}")
            .get()
            .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
ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsByIDGet(ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsByIDGet t)
ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsByIDGet(ApiHttpClient apiHttpClient, String projectKey, String associateId, String businessUnitKey, String ID)

Method Summary

Modifier and Type	Method	Description
<TValue> ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsByIDGet	addExpand(Collection<TValue> expand)	add additional expand query parameters
ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsByIDGet	addExpand(Function<StringBuilder,StringBuilder> op)	add additional expand query parameter
ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsByIDGet	addExpand(Supplier<String> supplier)	add additional expand query parameter
<TValue> ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsByIDGet	addExpand(TValue expand)	add additional expand query parameter
boolean	equals(Object o)
CompletableFuture<ApiHttpResponse<ShoppingList>>	execute(ApiHttpClient client)
ApiHttpResponse<ShoppingList>	executeBlocking(ApiHttpClient client, Duration timeout)
String	getAssociateId()
String	getBusinessUnitKey()
List<String>	getExpand()
String	getID()
String	getProjectKey()
int	hashCode()
int	reflectionHashCode()
com.fasterxml.jackson.core.type.TypeReference<ShoppingList>	resultType()
void	setAssociateId(String associateId)
void	setBusinessUnitKey(String businessUnitKey)
void	setID(String ID)
void	setProjectKey(String projectKey)
String	toString()
<TValue> ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsByIDGet	withExpand(Collection<TValue> expand)	set expand with the specified values
ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsByIDGet	withExpand(Function<StringBuilder,StringBuilder> op)	set expand with the specified value
ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsByIDGet	withExpand(Supplier<String> supplier)	set expand with the specified value
<TValue> ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsByIDGet	withExpand(TValue expand)	set expand 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 com.commercetools.api.client.ExpandableTrait

asExpandableTrait, asExpandableTraitToBaseType

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

executeBlocking

Constructor Details

ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsByIDGet

public ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsByIDGet(ApiHttpClient apiHttpClient,
 String projectKey,
 String associateId,
 String businessUnitKey,
 String ID)

ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsByIDGet

public ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsByIDGet(ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsByIDGet t)

Method Details

resultType

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

Specified by:

resultType in interface HttpRequestCommand<ShoppingList>

executeBlocking

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

Specified by:

executeBlocking in interface ClientRequestCommand<ShoppingList>

Specified by:

executeBlocking in class ApiMethod<ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsByIDGet,ShoppingList>

execute

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

Specified by:

execute in interface ClientRequestCommand<ShoppingList>

Specified by:

execute in class ApiMethod<ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsByIDGet,ShoppingList>

getProjectKey

public String getProjectKey()

getAssociateId

public String getAssociateId()

getBusinessUnitKey

public String getBusinessUnitKey()

getID

public String getID()

getExpand

public List<String> getExpand()

Specified by:

getExpand in interface ExpandableTrait<ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsByIDGet>

setProjectKey

public void setProjectKey(String projectKey)

setAssociateId

public void setAssociateId(String associateId)

setBusinessUnitKey

public void setBusinessUnitKey(String businessUnitKey)

setID

public void setID(String ID)

withExpand

public <TValue>
ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsByIDGet withExpand(TValue expand)

set expand with the specified value

Specified by:

withExpand in interface ExpandableTrait<ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsByIDGet>

Type Parameters:

TValue - value type

Parameters:

expand - value to be set

Returns:

ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsByIDGet

addExpand

public <TValue>
ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsByIDGet addExpand(TValue expand)

add additional expand query parameter

Specified by:

addExpand in interface ExpandableTrait<ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsByIDGet>

Type Parameters:

TValue - value type

Parameters:

expand - value to be added

Returns:

ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsByIDGet

withExpand

public ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsByIDGet withExpand(Supplier<String> supplier)

set expand with the specified value

Parameters:

supplier - supplier for the value to be set

Returns:

ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsByIDGet

addExpand

public ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsByIDGet addExpand(Supplier<String> supplier)

add additional expand query parameter

Parameters:

supplier - supplier for the value to be added

Returns:

ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsByIDGet

withExpand

public ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsByIDGet withExpand(Function<StringBuilder,StringBuilder> op)

set expand with the specified value

Parameters:

op - builder for the value to be set

Returns:

ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsByIDGet

addExpand

public ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsByIDGet addExpand(Function<StringBuilder,StringBuilder> op)

add additional expand query parameter

Parameters:

op - builder for the value to be added

Returns:

ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsByIDGet

withExpand

public <TValue>
ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsByIDGet withExpand(Collection<TValue> expand)

set expand with the specified values

Type Parameters:

TValue - value type

Parameters:

expand - values to be set

Returns:

ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsByIDGet

addExpand

public <TValue>
ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsByIDGet addExpand(Collection<TValue> expand)

add additional expand query parameters

Type Parameters:

TValue - value type

Parameters:

expand - values to be added

Returns:

ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsByIDGet

equals

public boolean equals(Object o)

hashCode

public int hashCode()

toString

public String toString()

Overrides:

toString in class Object

reflectionHashCode

public int reflectionHashCode()