Package com.commercetools.api.client
Class ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDVariantAttributesGet
java.lang.Object
io.vrap.rmf.base.client.ApiMethod<T,TResult>
io.vrap.rmf.base.client.TypeApiMethod<ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDVariantAttributesGet,VariantAttributes>
com.commercetools.api.client.ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDVariantAttributesGet
- All Implemented Interfaces:
Deprecatable200Trait<ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDVariantAttributesGet>,ErrorableTrait<ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDVariantAttributesGet>,LocaleprojectingTrait<ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDVariantAttributesGet>,ProjectionselectingvariantTrait<ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDVariantAttributesGet>,SupplychannelfilteringTrait<ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDVariantAttributesGet>,VariantattributefilteringTrait<ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDVariantAttributesGet>,ClientRequestCommand<VariantAttributes>,CreateHttpRequestCommand,HttpRequestCommand<VariantAttributes>,RequestCommand<VariantAttributes>
public class ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDVariantAttributesGet
extends TypeApiMethod<ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDVariantAttributesGet,VariantAttributes>
implements ProjectionselectingvariantTrait<ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDVariantAttributesGet>, LocaleprojectingTrait<ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDVariantAttributesGet>, VariantattributefilteringTrait<ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDVariantAttributesGet>, SupplychannelfilteringTrait<ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDVariantAttributesGet>, ErrorableTrait<ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDVariantAttributesGet>, Deprecatable200Trait<ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDVariantAttributesGet>
Returns a lightweight representation of all Variants for a Product, including only the requested variant-level Attributes and minimal availability data, scoped to a specific Store.
Designed for building attribute selectors on product detail pages (PDPs) with large numbers of variants. Only available for Projects with productCatalogModel set to Modular.
Product-level Attributes are omitted from the response.
Required access scopes:
- To retrieve the current representation of published Products (published data), the
view_published_products:{projectKey}andview_products:{projectKey}:{storeKey}scope is required. - To retrieve the staged representation of Products (draft data), the API Client must have the
view_products:{projectKey}andview_products:{projectKey}:{storeKey}scope.
CompletableFuture<ApiHttpResponse<com.commercetools.api.models.variant_attributes.VariantAttributes>> result = apiRoot
.withProjectKey("{projectKey}")
.inStoreKeyWithStoreKeyValue("{storeKey}")
.productProjections()
.withId("{ID}")
.variantAttributes()
.get()
.withFilterAttributes(filterAttributes)
.execute()
-
Nested Class Summary
Nested classes/interfaces inherited from class io.vrap.rmf.base.client.ApiMethod
ApiMethod.ParamEntry<K,V> -
Constructor Summary
ConstructorsConstructorDescriptionByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDVariantAttributesGet(ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDVariantAttributesGet t) ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDVariantAttributesGet(ApiHttpClient apiHttpClient, String projectKey, String storeKey, String ID) -
Method Summary
Modifier and TypeMethodDescriptionaddFilterAttributes(Collection<TValue> filterAttributes) add additional filterAttributes query parametersadd additional filterAttributes query parameteraddFilterAttributes(Supplier<String> supplier) add additional filterAttributes query parameteraddFilterAttributes(TValue filterAttributes) add additional filterAttributes query parameteraddFilterSupplyChannels(Collection<TValue> filterSupplyChannels) add additional filterSupplyChannels query parametersadd additional filterSupplyChannels query parameteraddFilterSupplyChannels(Supplier<String> supplier) add additional filterSupplyChannels query parameteraddFilterSupplyChannels(TValue filterSupplyChannels) add additional filterSupplyChannels query parameteraddLocaleProjection(Collection<TValue> localeProjection) add additional localeProjection query parametersadd additional localeProjection query parameteraddLocaleProjection(Supplier<String> supplier) add additional localeProjection query parameteraddLocaleProjection(TValue localeProjection) add additional localeProjection query parameteraddStaged(Collection<TValue> staged) add additional staged query parametersadd additional staged query parameteradd additional staged query parameteraddStaged(TValue staged) add additional staged query parameterbooleanexecute(ApiHttpClient client) executeBlocking(ApiHttpClient client, Duration timeout) getID()inthashCode()inttools.jackson.core.type.TypeReference<VariantAttributes>voidvoidsetProjectKey(String projectKey) voidsetStoreKey(String storeKey) toString()withFilterAttributes(Collection<TValue> filterAttributes) set filterAttributes with the specified valuesset filterAttributes with the specified valuewithFilterAttributes(Supplier<String> supplier) set filterAttributes with the specified valuewithFilterAttributes(TValue filterAttributes) set filterAttributes with the specified valuewithFilterSupplyChannels(Collection<TValue> filterSupplyChannels) set filterSupplyChannels with the specified valuesset filterSupplyChannels with the specified valuewithFilterSupplyChannels(Supplier<String> supplier) set filterSupplyChannels with the specified valuewithFilterSupplyChannels(TValue filterSupplyChannels) set filterSupplyChannels with the specified valuewithLocaleProjection(Collection<TValue> localeProjection) set localeProjection with the specified valuesset localeProjection with the specified valuewithLocaleProjection(Supplier<String> supplier) set localeProjection with the specified valuewithLocaleProjection(TValue localeProjection) set localeProjection with the specified valuewithStaged(Collection<TValue> staged) set staged with the specified valuesset staged with the specified valuewithStaged(Supplier<Boolean> supplier) set staged with the specified valuewithStaged(TValue staged) set staged 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, withQueryParamsMethods inherited from interface io.vrap.rmf.base.client.ClientRequestCommand
executeBlockingMethods inherited from interface io.vrap.rmf.base.client.CreateHttpRequestCommand
createHttpRequestMethods inherited from interface com.commercetools.api.client.Deprecatable200Trait
asDeprecatable200Trait, asDeprecatable200TraitToBaseTypeMethods inherited from interface com.commercetools.api.client.ErrorableTrait
asErrorableTrait, asErrorableTraitToBaseTypeMethods inherited from interface com.commercetools.api.client.LocaleprojectingTrait
asLocaleprojectingTrait, asLocaleprojectingTraitToBaseTypeMethods inherited from interface com.commercetools.api.client.ProjectionselectingvariantTrait
asProjectionselectingvariantTrait, asProjectionselectingvariantTraitToBaseTypeMethods inherited from interface io.vrap.rmf.base.client.RequestCommand
executeBlockingMethods inherited from interface com.commercetools.api.client.SupplychannelfilteringTrait
asSupplychannelfilteringTrait, asSupplychannelfilteringTraitToBaseTypeMethods inherited from interface com.commercetools.api.client.VariantattributefilteringTrait
asVariantattributefilteringTrait, asVariantattributefilteringTraitToBaseType
-
Constructor Details
-
ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDVariantAttributesGet
public ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDVariantAttributesGet(ApiHttpClient apiHttpClient, String projectKey, String storeKey, String ID) -
ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDVariantAttributesGet
public ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDVariantAttributesGet(ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDVariantAttributesGet t)
-
-
Method Details
-
resultType
- Specified by:
resultTypein interfaceHttpRequestCommand<VariantAttributes>
-
executeBlocking
- Specified by:
executeBlockingin interfaceClientRequestCommand<VariantAttributes>- Specified by:
executeBlockingin classApiMethod<ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDVariantAttributesGet,VariantAttributes>
-
execute
- Specified by:
executein interfaceClientRequestCommand<VariantAttributes>- Specified by:
executein classApiMethod<ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDVariantAttributesGet,VariantAttributes>
-
getProjectKey
-
getStoreKey
-
getID
-
getStaged
- Specified by:
getStagedin interfaceProjectionselectingvariantTrait<ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDVariantAttributesGet>
-
getLocaleProjection
- Specified by:
getLocaleProjectionin interfaceLocaleprojectingTrait<ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDVariantAttributesGet>
-
getFilterAttributes
-
getFilterSupplyChannels
-
setProjectKey
-
setStoreKey
-
setID
-
withStaged
public <TValue> ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDVariantAttributesGet withStaged(TValue staged) set staged with the specified value- Specified by:
withStagedin interfaceProjectionselectingvariantTrait<ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDVariantAttributesGet>- Type Parameters:
TValue- value type- Parameters:
staged- value to be set- Returns:
- ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDVariantAttributesGet
-
addStaged
public <TValue> ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDVariantAttributesGet addStaged(TValue staged) add additional staged query parameter- Specified by:
addStagedin interfaceProjectionselectingvariantTrait<ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDVariantAttributesGet>- Type Parameters:
TValue- value type- Parameters:
staged- value to be added- Returns:
- ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDVariantAttributesGet
-
withStaged
public ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDVariantAttributesGet withStaged(Supplier<Boolean> supplier) set staged with the specified value- Parameters:
supplier- supplier for the value to be set- Returns:
- ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDVariantAttributesGet
-
addStaged
public ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDVariantAttributesGet addStaged(Supplier<Boolean> supplier) add additional staged query parameter- Parameters:
supplier- supplier for the value to be added- Returns:
- ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDVariantAttributesGet
-
withStaged
public ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDVariantAttributesGet withStaged(Function<StringBuilder, StringBuilder> op) set staged with the specified value- Parameters:
op- builder for the value to be set- Returns:
- ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDVariantAttributesGet
-
addStaged
public ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDVariantAttributesGet addStaged(Function<StringBuilder, StringBuilder> op) add additional staged query parameter- Parameters:
op- builder for the value to be added- Returns:
- ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDVariantAttributesGet
-
withStaged
public <TValue> ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDVariantAttributesGet withStaged(Collection<TValue> staged) set staged with the specified values- Type Parameters:
TValue- value type- Parameters:
staged- values to be set- Returns:
- ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDVariantAttributesGet
-
addStaged
public <TValue> ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDVariantAttributesGet addStaged(Collection<TValue> staged) add additional staged query parameters- Type Parameters:
TValue- value type- Parameters:
staged- values to be added- Returns:
- ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDVariantAttributesGet
-
withLocaleProjection
public <TValue> ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDVariantAttributesGet withLocaleProjection(TValue localeProjection) set localeProjection with the specified value- Specified by:
withLocaleProjectionin interfaceLocaleprojectingTrait<ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDVariantAttributesGet>- Type Parameters:
TValue- value type- Parameters:
localeProjection- value to be set- Returns:
- ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDVariantAttributesGet
-
addLocaleProjection
public <TValue> ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDVariantAttributesGet addLocaleProjection(TValue localeProjection) add additional localeProjection query parameter- Specified by:
addLocaleProjectionin interfaceLocaleprojectingTrait<ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDVariantAttributesGet>- Type Parameters:
TValue- value type- Parameters:
localeProjection- value to be added- Returns:
- ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDVariantAttributesGet
-
withLocaleProjection
public ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDVariantAttributesGet withLocaleProjection(Supplier<String> supplier) set localeProjection with the specified value- Parameters:
supplier- supplier for the value to be set- Returns:
- ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDVariantAttributesGet
-
addLocaleProjection
public ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDVariantAttributesGet addLocaleProjection(Supplier<String> supplier) add additional localeProjection query parameter- Parameters:
supplier- supplier for the value to be added- Returns:
- ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDVariantAttributesGet
-
withLocaleProjection
public ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDVariantAttributesGet withLocaleProjection(Function<StringBuilder, StringBuilder> op) set localeProjection with the specified value- Parameters:
op- builder for the value to be set- Returns:
- ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDVariantAttributesGet
-
addLocaleProjection
public ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDVariantAttributesGet addLocaleProjection(Function<StringBuilder, StringBuilder> op) add additional localeProjection query parameter- Parameters:
op- builder for the value to be added- Returns:
- ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDVariantAttributesGet
-
withLocaleProjection
public <TValue> ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDVariantAttributesGet withLocaleProjection(Collection<TValue> localeProjection) set localeProjection with the specified values- Type Parameters:
TValue- value type- Parameters:
localeProjection- values to be set- Returns:
- ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDVariantAttributesGet
-
addLocaleProjection
public <TValue> ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDVariantAttributesGet addLocaleProjection(Collection<TValue> localeProjection) add additional localeProjection query parameters- Type Parameters:
TValue- value type- Parameters:
localeProjection- values to be added- Returns:
- ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDVariantAttributesGet
-
withFilterAttributes
public <TValue> ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDVariantAttributesGet withFilterAttributes(TValue filterAttributes) set filterAttributes with the specified value- Specified by:
withFilterAttributesin interfaceVariantattributefilteringTrait<ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDVariantAttributesGet>- Type Parameters:
TValue- value type- Parameters:
filterAttributes- value to be set- Returns:
- ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDVariantAttributesGet
-
addFilterAttributes
public <TValue> ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDVariantAttributesGet addFilterAttributes(TValue filterAttributes) add additional filterAttributes query parameter- Specified by:
addFilterAttributesin interfaceVariantattributefilteringTrait<ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDVariantAttributesGet>- Type Parameters:
TValue- value type- Parameters:
filterAttributes- value to be added- Returns:
- ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDVariantAttributesGet
-
withFilterAttributes
public ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDVariantAttributesGet withFilterAttributes(Supplier<String> supplier) set filterAttributes with the specified value- Parameters:
supplier- supplier for the value to be set- Returns:
- ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDVariantAttributesGet
-
addFilterAttributes
public ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDVariantAttributesGet addFilterAttributes(Supplier<String> supplier) add additional filterAttributes query parameter- Parameters:
supplier- supplier for the value to be added- Returns:
- ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDVariantAttributesGet
-
withFilterAttributes
public ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDVariantAttributesGet withFilterAttributes(Function<StringBuilder, StringBuilder> op) set filterAttributes with the specified value- Parameters:
op- builder for the value to be set- Returns:
- ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDVariantAttributesGet
-
addFilterAttributes
public ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDVariantAttributesGet addFilterAttributes(Function<StringBuilder, StringBuilder> op) add additional filterAttributes query parameter- Parameters:
op- builder for the value to be added- Returns:
- ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDVariantAttributesGet
-
withFilterAttributes
public <TValue> ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDVariantAttributesGet withFilterAttributes(Collection<TValue> filterAttributes) set filterAttributes with the specified values- Type Parameters:
TValue- value type- Parameters:
filterAttributes- values to be set- Returns:
- ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDVariantAttributesGet
-
addFilterAttributes
public <TValue> ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDVariantAttributesGet addFilterAttributes(Collection<TValue> filterAttributes) add additional filterAttributes query parameters- Type Parameters:
TValue- value type- Parameters:
filterAttributes- values to be added- Returns:
- ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDVariantAttributesGet
-
withFilterSupplyChannels
public <TValue> ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDVariantAttributesGet withFilterSupplyChannels(TValue filterSupplyChannels) set filterSupplyChannels with the specified value- Specified by:
withFilterSupplyChannelsin interfaceSupplychannelfilteringTrait<ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDVariantAttributesGet>- Type Parameters:
TValue- value type- Parameters:
filterSupplyChannels- value to be set- Returns:
- ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDVariantAttributesGet
-
addFilterSupplyChannels
public <TValue> ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDVariantAttributesGet addFilterSupplyChannels(TValue filterSupplyChannels) add additional filterSupplyChannels query parameter- Specified by:
addFilterSupplyChannelsin interfaceSupplychannelfilteringTrait<ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDVariantAttributesGet>- Type Parameters:
TValue- value type- Parameters:
filterSupplyChannels- value to be added- Returns:
- ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDVariantAttributesGet
-
withFilterSupplyChannels
public ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDVariantAttributesGet withFilterSupplyChannels(Supplier<String> supplier) set filterSupplyChannels with the specified value- Parameters:
supplier- supplier for the value to be set- Returns:
- ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDVariantAttributesGet
-
addFilterSupplyChannels
public ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDVariantAttributesGet addFilterSupplyChannels(Supplier<String> supplier) add additional filterSupplyChannels query parameter- Parameters:
supplier- supplier for the value to be added- Returns:
- ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDVariantAttributesGet
-
withFilterSupplyChannels
public ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDVariantAttributesGet withFilterSupplyChannels(Function<StringBuilder, StringBuilder> op) set filterSupplyChannels with the specified value- Parameters:
op- builder for the value to be set- Returns:
- ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDVariantAttributesGet
-
addFilterSupplyChannels
public ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDVariantAttributesGet addFilterSupplyChannels(Function<StringBuilder, StringBuilder> op) add additional filterSupplyChannels query parameter- Parameters:
op- builder for the value to be added- Returns:
- ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDVariantAttributesGet
-
withFilterSupplyChannels
public <TValue> ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDVariantAttributesGet withFilterSupplyChannels(Collection<TValue> filterSupplyChannels) set filterSupplyChannels with the specified values- Type Parameters:
TValue- value type- Parameters:
filterSupplyChannels- values to be set- Returns:
- ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDVariantAttributesGet
-
addFilterSupplyChannels
public <TValue> ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDVariantAttributesGet addFilterSupplyChannels(Collection<TValue> filterSupplyChannels) add additional filterSupplyChannels query parameters- Type Parameters:
TValue- value type- Parameters:
filterSupplyChannels- values to be added- Returns:
- ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDVariantAttributesGet
-
equals
-
hashCode
public int hashCode() -
toString
-
reflectionHashCode
public int reflectionHashCode()
-