Package com.commercetools.api.client
Class ByProjectKeyProductsByIDImagesPostString
java.lang.Object
io.vrap.rmf.base.client.ApiMethod<T,TResult>
io.vrap.rmf.base.client.BodyApiMethod<T,TResult,TBody>
io.vrap.rmf.base.client.TypeBodyApiMethod<T,TResult,String>
io.vrap.rmf.base.client.StringBodyApiMethod<ByProjectKeyProductsByIDImagesPostString,Product>
com.commercetools.api.client.ByProjectKeyProductsByIDImagesPostString
- All Implemented Interfaces:
ClientRequestCommand<Product>
,CreateHttpRequestCommand
,HttpRequestCommand<Product>
,RequestCommand<Product>
public class ByProjectKeyProductsByIDImagesPostString
extends StringBodyApiMethod<ByProjectKeyProductsByIDImagesPostString,Product>
Uploads a JPEG, PNG, or a GIF image file to a ProductVariant. The maximum file size of the image is 10MB. Either variant
or sku
is required to update a specific ProductVariant. If neither is provided, the image is uploaded to the Master Variant of the Product.
The response status code depends on the size of the original image. If the image is small, the API responds with 200 OK
, and if the image is larger, it responds with 202 Accepted
. The Product returned with a 202 Accepted
status code contains a warnings
field with an ImageProcessingOngoing Warning.
Produces the ProductImageAdded Message.
CompletableFuture<ApiHttpResponse<com.commercetools.api.models.product.Product>> result = apiRoot
.withProjectKey("{projectKey}")
.products()
.withId("{ID}")
.images()
.post("")
.execute()
-
Nested Class Summary
Nested classes/interfaces inherited from class io.vrap.rmf.base.client.ApiMethod
ApiMethod.ParamEntry<K,
V> -
Constructor Summary
ConstructorDescriptionByProjectKeyProductsByIDImagesPostString
(ApiHttpClient apiHttpClient, String projectKey, String ID, String file) -
Method Summary
Modifier and TypeMethodDescriptionaddFilename
(Collection<TValue> filename) add additional filename query parametersadd additional filename query parameteraddFilename
(Supplier<String> supplier) add additional filename query parameteraddFilename
(TValue filename) add additional filename query parameteraddSku
(Collection<TValue> sku) add additional sku query parametersadd additional sku query parameteradd additional sku query parameteraddSku
(TValue sku) add additional sku query parameteraddStaged
(Collection<TValue> staged) add additional staged query parametersadd additional staged query parameteradd additional staged query parameteraddStaged
(TValue staged) add additional staged query parameteraddVariant
(Collection<TValue> variant) add additional variant query parametersadd additional variant query parameteraddVariant
(Supplier<Long> supplier) add additional variant query parameteraddVariant
(TValue variant) add additional variant query parameterboolean
execute
(ApiHttpClient client) executeBlocking
(ApiHttpClient client, Duration timeout) getBody()
getID()
getSku()
int
hashCode()
int
com.fasterxml.jackson.core.type.TypeReference<Product>
void
void
setProjectKey
(String projectKey) toString()
withFilename
(Collection<TValue> filename) set filename with the specified valuesset filename with the specified valuewithFilename
(Supplier<String> supplier) set filename with the specified valuewithFilename
(TValue filename) set filename with the specified valuewithSku
(Collection<TValue> sku) set sku with the specified valuesset sku with the specified valueset sku with the specified valuewithSku
(TValue sku) set sku 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 valuewithVariant
(Collection<TValue> variant) set variant with the specified valuesset variant with the specified valuewithVariant
(Supplier<Long> supplier) set variant with the specified valuewithVariant
(TValue variant) set variant 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 io.vrap.rmf.base.client.RequestCommand
executeBlocking
-
Constructor Details
-
ByProjectKeyProductsByIDImagesPostString
public ByProjectKeyProductsByIDImagesPostString(ApiHttpClient apiHttpClient, String projectKey, String ID, String file) -
ByProjectKeyProductsByIDImagesPostString
-
-
Method Details
-
resultType
-
executeBlocking
- Specified by:
executeBlocking
in interfaceClientRequestCommand<Product>
- Specified by:
executeBlocking
in classApiMethod<ByProjectKeyProductsByIDImagesPostString,
Product>
-
execute
- Specified by:
execute
in interfaceClientRequestCommand<Product>
- Specified by:
execute
in classApiMethod<ByProjectKeyProductsByIDImagesPostString,
Product>
-
getProjectKey
-
getID
-
getFilename
-
getVariant
-
getSku
-
getStaged
-
setProjectKey
-
setID
-
withFilename
set filename with the specified value- Type Parameters:
TValue
- value type- Parameters:
filename
- value to be set- Returns:
- ByProjectKeyProductsByIDImagesPostString
-
addFilename
add additional filename query parameter- Type Parameters:
TValue
- value type- Parameters:
filename
- value to be added- Returns:
- ByProjectKeyProductsByIDImagesPostString
-
withFilename
set filename with the specified value- Parameters:
supplier
- supplier for the value to be set- Returns:
- ByProjectKeyProductsByIDImagesPostString
-
addFilename
add additional filename query parameter- Parameters:
supplier
- supplier for the value to be added- Returns:
- ByProjectKeyProductsByIDImagesPostString
-
withFilename
public ByProjectKeyProductsByIDImagesPostString withFilename(Function<StringBuilder, StringBuilder> op) set filename with the specified value- Parameters:
op
- builder for the value to be set- Returns:
- ByProjectKeyProductsByIDImagesPostString
-
addFilename
public ByProjectKeyProductsByIDImagesPostString addFilename(Function<StringBuilder, StringBuilder> op) add additional filename query parameter- Parameters:
op
- builder for the value to be added- Returns:
- ByProjectKeyProductsByIDImagesPostString
-
withFilename
set filename with the specified values- Type Parameters:
TValue
- value type- Parameters:
filename
- values to be set- Returns:
- ByProjectKeyProductsByIDImagesPostString
-
addFilename
add additional filename query parameters- Type Parameters:
TValue
- value type- Parameters:
filename
- values to be added- Returns:
- ByProjectKeyProductsByIDImagesPostString
-
withVariant
set variant with the specified value- Type Parameters:
TValue
- value type- Parameters:
variant
- value to be set- Returns:
- ByProjectKeyProductsByIDImagesPostString
-
addVariant
add additional variant query parameter- Type Parameters:
TValue
- value type- Parameters:
variant
- value to be added- Returns:
- ByProjectKeyProductsByIDImagesPostString
-
withVariant
set variant with the specified value- Parameters:
supplier
- supplier for the value to be set- Returns:
- ByProjectKeyProductsByIDImagesPostString
-
addVariant
add additional variant query parameter- Parameters:
supplier
- supplier for the value to be added- Returns:
- ByProjectKeyProductsByIDImagesPostString
-
withVariant
public ByProjectKeyProductsByIDImagesPostString withVariant(Function<StringBuilder, StringBuilder> op) set variant with the specified value- Parameters:
op
- builder for the value to be set- Returns:
- ByProjectKeyProductsByIDImagesPostString
-
addVariant
public ByProjectKeyProductsByIDImagesPostString addVariant(Function<StringBuilder, StringBuilder> op) add additional variant query parameter- Parameters:
op
- builder for the value to be added- Returns:
- ByProjectKeyProductsByIDImagesPostString
-
withVariant
set variant with the specified values- Type Parameters:
TValue
- value type- Parameters:
variant
- values to be set- Returns:
- ByProjectKeyProductsByIDImagesPostString
-
addVariant
add additional variant query parameters- Type Parameters:
TValue
- value type- Parameters:
variant
- values to be added- Returns:
- ByProjectKeyProductsByIDImagesPostString
-
withSku
set sku with the specified value- Type Parameters:
TValue
- value type- Parameters:
sku
- value to be set- Returns:
- ByProjectKeyProductsByIDImagesPostString
-
addSku
add additional sku query parameter- Type Parameters:
TValue
- value type- Parameters:
sku
- value to be added- Returns:
- ByProjectKeyProductsByIDImagesPostString
-
withSku
set sku with the specified value- Parameters:
supplier
- supplier for the value to be set- Returns:
- ByProjectKeyProductsByIDImagesPostString
-
addSku
add additional sku query parameter- Parameters:
supplier
- supplier for the value to be added- Returns:
- ByProjectKeyProductsByIDImagesPostString
-
withSku
set sku with the specified value- Parameters:
op
- builder for the value to be set- Returns:
- ByProjectKeyProductsByIDImagesPostString
-
addSku
add additional sku query parameter- Parameters:
op
- builder for the value to be added- Returns:
- ByProjectKeyProductsByIDImagesPostString
-
withSku
set sku with the specified values- Type Parameters:
TValue
- value type- Parameters:
sku
- values to be set- Returns:
- ByProjectKeyProductsByIDImagesPostString
-
addSku
add additional sku query parameters- Type Parameters:
TValue
- value type- Parameters:
sku
- values to be added- Returns:
- ByProjectKeyProductsByIDImagesPostString
-
withStaged
set staged with the specified value- Type Parameters:
TValue
- value type- Parameters:
staged
- value to be set- Returns:
- ByProjectKeyProductsByIDImagesPostString
-
addStaged
add additional staged query parameter- Type Parameters:
TValue
- value type- Parameters:
staged
- value to be added- Returns:
- ByProjectKeyProductsByIDImagesPostString
-
withStaged
set staged with the specified value- Parameters:
supplier
- supplier for the value to be set- Returns:
- ByProjectKeyProductsByIDImagesPostString
-
addStaged
add additional staged query parameter- Parameters:
supplier
- supplier for the value to be added- Returns:
- ByProjectKeyProductsByIDImagesPostString
-
withStaged
public ByProjectKeyProductsByIDImagesPostString withStaged(Function<StringBuilder, StringBuilder> op) set staged with the specified value- Parameters:
op
- builder for the value to be set- Returns:
- ByProjectKeyProductsByIDImagesPostString
-
addStaged
add additional staged query parameter- Parameters:
op
- builder for the value to be added- Returns:
- ByProjectKeyProductsByIDImagesPostString
-
withStaged
set staged with the specified values- Type Parameters:
TValue
- value type- Parameters:
staged
- values to be set- Returns:
- ByProjectKeyProductsByIDImagesPostString
-
addStaged
add additional staged query parameters- Type Parameters:
TValue
- value type- Parameters:
staged
- values to be added- Returns:
- ByProjectKeyProductsByIDImagesPostString
-
getBody
- Overrides:
getBody
in classStringBodyApiMethod<ByProjectKeyProductsByIDImagesPostString,
Product>
-
withBody
- Overrides:
withBody
in classStringBodyApiMethod<ByProjectKeyProductsByIDImagesPostString,
Product>
-
equals
-
hashCode
public int hashCode() -
toString
-
reflectionHashCode
public int reflectionHashCode()
-