Package com.commercetools.api.client

Class ByProjectKeyInStoreKeyByStoreKeyCategoriesKeyByKeyGet

java.lang.Object

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

io.vrap.rmf.base.client.TypeApiMethod<ByProjectKeyInStoreKeyByStoreKeyCategoriesKeyByKeyGet,Category>

com.commercetools.api.client.ByProjectKeyInStoreKeyByStoreKeyCategoriesKeyByKeyGet

All Implemented Interfaces:

Deprecatable200Trait<ByProjectKeyInStoreKeyByStoreKeyCategoriesKeyByKeyGet>, ErrorableTrait<ByProjectKeyInStoreKeyByStoreKeyCategoriesKeyByKeyGet>, ExpandableTrait<ByProjectKeyInStoreKeyByStoreKeyCategoriesKeyByKeyGet>, ClientRequestCommand<Category>, CreateHttpRequestCommand, HttpRequestCommand<Category>, RequestCommand<Category>

public class ByProjectKeyInStoreKeyByStoreKeyCategoriesKeyByKeyGet
extends TypeApiMethod<ByProjectKeyInStoreKeyByStoreKeyCategoriesKeyByKeyGet,Category>
implements ExpandableTrait<ByProjectKeyInStoreKeyByStoreKeyCategoriesKeyByKeyGet>, ErrorableTrait<ByProjectKeyInStoreKeyByStoreKeyCategoriesKeyByKeyGet>, Deprecatable200Trait<ByProjectKeyInStoreKeyByStoreKeyCategoriesKeyByKeyGet>

Retrieves a Category by its key in the specified Store.

For global Categories, use the Get Category by Key endpoint.

If the Category does not exist in the Store, a ResourceNotFound error is returned.

   CompletableFuture<ApiHttpResponse<com.commercetools.api.models.category.Category>> result = apiRoot
            .withProjectKey("{projectKey}")
            .inStoreKeyWithStoreKeyValue("{storeKey}")
            .categories()
            .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

Constructors

Constructor	Description
ByProjectKeyInStoreKeyByStoreKeyCategoriesKeyByKeyGet(ByProjectKeyInStoreKeyByStoreKeyCategoriesKeyByKeyGet t)
ByProjectKeyInStoreKeyByStoreKeyCategoriesKeyByKeyGet(ApiHttpClient apiHttpClient, String projectKey, String storeKey, String key)

Method Summary

Modifier and Type	Method	Description
<TValue> ByProjectKeyInStoreKeyByStoreKeyCategoriesKeyByKeyGet	addExpand(Collection<TValue> expand)	add additional expand query parameters
ByProjectKeyInStoreKeyByStoreKeyCategoriesKeyByKeyGet	addExpand(Function<StringBuilder,StringBuilder> op)	add additional expand query parameter
ByProjectKeyInStoreKeyByStoreKeyCategoriesKeyByKeyGet	addExpand(Supplier<String> supplier)	add additional expand query parameter
<TValue> ByProjectKeyInStoreKeyByStoreKeyCategoriesKeyByKeyGet	addExpand(TValue expand)	add additional expand query parameter
boolean	equals(Object o)
CompletableFuture<ApiHttpResponse<Category>>	execute(ApiHttpClient client)
ApiHttpResponse<Category>	executeBlocking(ApiHttpClient client, Duration timeout)
List<String>	getExpand()
String	getKey()
String	getProjectKey()
String	getStoreKey()
int	hashCode()
int	reflectionHashCode()
tools.jackson.core.type.TypeReference<Category>	resultType()
void	setKey(String key)
void	setProjectKey(String projectKey)
void	setStoreKey(String storeKey)
String	toString()
<TValue> ByProjectKeyInStoreKeyByStoreKeyCategoriesKeyByKeyGet	withExpand(Collection<TValue> expand)	set expand with the specified values
ByProjectKeyInStoreKeyByStoreKeyCategoriesKeyByKeyGet	withExpand(Function<StringBuilder,StringBuilder> op)	set expand with the specified value
ByProjectKeyInStoreKeyByStoreKeyCategoriesKeyByKeyGet	withExpand(Supplier<String> supplier)	set expand with the specified value
<TValue> ByProjectKeyInStoreKeyByStoreKeyCategoriesKeyByKeyGet	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

ByProjectKeyInStoreKeyByStoreKeyCategoriesKeyByKeyGet

public ByProjectKeyInStoreKeyByStoreKeyCategoriesKeyByKeyGet(ApiHttpClient apiHttpClient,
 String projectKey,
 String storeKey,
 String key)

ByProjectKeyInStoreKeyByStoreKeyCategoriesKeyByKeyGet

public ByProjectKeyInStoreKeyByStoreKeyCategoriesKeyByKeyGet(ByProjectKeyInStoreKeyByStoreKeyCategoriesKeyByKeyGet t)

Method Details

resultType

public tools.jackson.core.type.TypeReference<Category> resultType()

Specified by:

resultType in interface HttpRequestCommand<Category>

executeBlocking

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

Specified by:

executeBlocking in interface ClientRequestCommand<Category>

Specified by:

executeBlocking in class ApiMethod<ByProjectKeyInStoreKeyByStoreKeyCategoriesKeyByKeyGet,Category>

execute

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

Specified by:

execute in interface ClientRequestCommand<Category>

Specified by:

execute in class ApiMethod<ByProjectKeyInStoreKeyByStoreKeyCategoriesKeyByKeyGet,Category>

getProjectKey

public String getProjectKey()

getStoreKey

public String getStoreKey()

getKey

public String getKey()

getExpand

public List<String> getExpand()

Specified by:

getExpand in interface ExpandableTrait<ByProjectKeyInStoreKeyByStoreKeyCategoriesKeyByKeyGet>

setProjectKey

public void setProjectKey(String projectKey)

setStoreKey

public void setStoreKey(String storeKey)

setKey

public void setKey(String key)

withExpand

public <TValue>
ByProjectKeyInStoreKeyByStoreKeyCategoriesKeyByKeyGet withExpand(TValue expand)

set expand with the specified value

Specified by:

withExpand in interface ExpandableTrait<ByProjectKeyInStoreKeyByStoreKeyCategoriesKeyByKeyGet>

Type Parameters:

TValue - value type

Parameters:

expand - value to be set

Returns:

ByProjectKeyInStoreKeyByStoreKeyCategoriesKeyByKeyGet

addExpand

public <TValue>
ByProjectKeyInStoreKeyByStoreKeyCategoriesKeyByKeyGet addExpand(TValue expand)

add additional expand query parameter

Specified by:

addExpand in interface ExpandableTrait<ByProjectKeyInStoreKeyByStoreKeyCategoriesKeyByKeyGet>

Type Parameters:

TValue - value type

Parameters:

expand - value to be added

Returns:

ByProjectKeyInStoreKeyByStoreKeyCategoriesKeyByKeyGet

withExpand

public ByProjectKeyInStoreKeyByStoreKeyCategoriesKeyByKeyGet withExpand(Supplier<String> supplier)

set expand with the specified value

Parameters:

supplier - supplier for the value to be set

Returns:

ByProjectKeyInStoreKeyByStoreKeyCategoriesKeyByKeyGet

addExpand

public ByProjectKeyInStoreKeyByStoreKeyCategoriesKeyByKeyGet addExpand(Supplier<String> supplier)

add additional expand query parameter

Parameters:

supplier - supplier for the value to be added

Returns:

ByProjectKeyInStoreKeyByStoreKeyCategoriesKeyByKeyGet

withExpand

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

set expand with the specified value

Parameters:

op - builder for the value to be set

Returns:

ByProjectKeyInStoreKeyByStoreKeyCategoriesKeyByKeyGet

addExpand

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

add additional expand query parameter

Parameters:

op - builder for the value to be added

Returns:

ByProjectKeyInStoreKeyByStoreKeyCategoriesKeyByKeyGet

withExpand

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

set expand with the specified values

Type Parameters:

TValue - value type

Parameters:

expand - values to be set

Returns:

ByProjectKeyInStoreKeyByStoreKeyCategoriesKeyByKeyGet

addExpand

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

add additional expand query parameters

Type Parameters:

TValue - value type

Parameters:

expand - values to be added

Returns:

ByProjectKeyInStoreKeyByStoreKeyCategoriesKeyByKeyGet

equals

public boolean equals(Object o)

hashCode

public int hashCode()

toString

public String toString()

Overrides:

toString in class Object

reflectionHashCode

public int reflectionHashCode()