Package com.commercetools.api.client

Class ByProjectKeyCustomObjectsPost

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<ByProjectKeyCustomObjectsPost,CustomObject,CustomObjectDraft>

com.commercetools.api.client.ByProjectKeyCustomObjectsPost

All Implemented Interfaces:

Deprecatable201Trait<ByProjectKeyCustomObjectsPost>, ErrorableTrait<ByProjectKeyCustomObjectsPost>, ExpandableTrait<ByProjectKeyCustomObjectsPost>, ClientRequestCommand<CustomObject>, CreateHttpRequestCommand, HttpRequestCommand<CustomObject>, RequestCommand<CustomObject>

public class ByProjectKeyCustomObjectsPost
extends TypeBodyApiMethod<ByProjectKeyCustomObjectsPost,CustomObject,CustomObjectDraft>
implements ExpandableTrait<ByProjectKeyCustomObjectsPost>, Deprecatable201Trait<ByProjectKeyCustomObjectsPost>, ErrorableTrait<ByProjectKeyCustomObjectsPost>

If an object with the given container/key exists, the object will be replaced with the new value and the version is incremented. If the request contains a version and an object with the given container/key, then the version must match the version of the existing object. Concurrent updates to the same Custom Object returns a ConcurrentModification error even if the version is not provided.

Fields within value that have null values are not saved.

   CompletableFuture<ApiHttpResponse<com.commercetools.api.models.custom_object.CustomObject>> result = apiRoot
            .withProjectKey("{projectKey}")
            .customObjects()
            .post(null)
            .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
ByProjectKeyCustomObjectsPost(ByProjectKeyCustomObjectsPost t)
ByProjectKeyCustomObjectsPost(ApiHttpClient apiHttpClient, String projectKey, CustomObjectDraft customObjectDraft)

Method Summary

Modifier and Type	Method	Description
<TValue> ByProjectKeyCustomObjectsPost	addExpand(Collection<TValue> expand)	add additional expand query parameters
ByProjectKeyCustomObjectsPost	addExpand(Function<StringBuilder,StringBuilder> op)	add additional expand query parameter
ByProjectKeyCustomObjectsPost	addExpand(Supplier<String> supplier)	add additional expand query parameter
<TValue> ByProjectKeyCustomObjectsPost	addExpand(TValue expand)	add additional expand query parameter
boolean	equals(Object o)
CompletableFuture<ApiHttpResponse<CustomObject>>	execute(ApiHttpClient client)
ApiHttpResponse<CustomObject>	executeBlocking(ApiHttpClient client, Duration timeout)
CustomObjectDraft	getBody()
List<String>	getExpand()
String	getProjectKey()
int	hashCode()
int	reflectionHashCode()
com.fasterxml.jackson.core.type.TypeReference<CustomObject>	resultType()
void	setProjectKey(String projectKey)
String	toString()
ByProjectKeyCustomObjectsPost	withBody(CustomObjectDraft customObjectDraft)
<TValue> ByProjectKeyCustomObjectsPost	withExpand(Collection<TValue> expand)	set expand with the specified values
ByProjectKeyCustomObjectsPost	withExpand(Function<StringBuilder,StringBuilder> op)	set expand with the specified value
ByProjectKeyCustomObjectsPost	withExpand(Supplier<String> supplier)	set expand with the specified value
<TValue> ByProjectKeyCustomObjectsPost	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.Deprecatable201Trait

asDeprecatable201Trait, asDeprecatable201TraitToBaseType

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

ByProjectKeyCustomObjectsPost

public ByProjectKeyCustomObjectsPost(ApiHttpClient apiHttpClient,
 String projectKey,
 CustomObjectDraft customObjectDraft)

ByProjectKeyCustomObjectsPost

public ByProjectKeyCustomObjectsPost(ByProjectKeyCustomObjectsPost t)

Method Details

resultType

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

Specified by:

resultType in interface HttpRequestCommand<CustomObject>

executeBlocking

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

Specified by:

executeBlocking in interface ClientRequestCommand<CustomObject>

Specified by:

executeBlocking in class ApiMethod<ByProjectKeyCustomObjectsPost,CustomObject>

execute

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

Specified by:

execute in interface ClientRequestCommand<CustomObject>

Specified by:

execute in class ApiMethod<ByProjectKeyCustomObjectsPost,CustomObject>

getProjectKey

public String getProjectKey()

getExpand

public List<String> getExpand()

Specified by:

getExpand in interface ExpandableTrait<ByProjectKeyCustomObjectsPost>

setProjectKey

public void setProjectKey(String projectKey)

withExpand

public <TValue> ByProjectKeyCustomObjectsPost withExpand(TValue expand)

set expand with the specified value

Specified by:

withExpand in interface ExpandableTrait<ByProjectKeyCustomObjectsPost>

Type Parameters:

TValue - value type

Parameters:

expand - value to be set

Returns:

ByProjectKeyCustomObjectsPost

addExpand

public <TValue> ByProjectKeyCustomObjectsPost addExpand(TValue expand)

add additional expand query parameter

Specified by:

addExpand in interface ExpandableTrait<ByProjectKeyCustomObjectsPost>

Type Parameters:

TValue - value type

Parameters:

expand - value to be added

Returns:

ByProjectKeyCustomObjectsPost

withExpand

public ByProjectKeyCustomObjectsPost withExpand(Supplier<String> supplier)

set expand with the specified value

Parameters:

supplier - supplier for the value to be set

Returns:

ByProjectKeyCustomObjectsPost

addExpand

public ByProjectKeyCustomObjectsPost addExpand(Supplier<String> supplier)

add additional expand query parameter

Parameters:

supplier - supplier for the value to be added

Returns:

ByProjectKeyCustomObjectsPost

withExpand

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

set expand with the specified value

Parameters:

op - builder for the value to be set

Returns:

ByProjectKeyCustomObjectsPost

addExpand

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

add additional expand query parameter

Parameters:

op - builder for the value to be added

Returns:

ByProjectKeyCustomObjectsPost

withExpand

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

set expand with the specified values

Type Parameters:

TValue - value type

Parameters:

expand - values to be set

Returns:

ByProjectKeyCustomObjectsPost

addExpand

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

add additional expand query parameters

Type Parameters:

TValue - value type

Parameters:

expand - values to be added

Returns:

ByProjectKeyCustomObjectsPost

getBody

public CustomObjectDraft getBody()

Overrides:

getBody in class TypeBodyApiMethod<ByProjectKeyCustomObjectsPost,CustomObject,CustomObjectDraft>

withBody

public ByProjectKeyCustomObjectsPost withBody(CustomObjectDraft customObjectDraft)

Overrides:

withBody in class TypeBodyApiMethod<ByProjectKeyCustomObjectsPost,CustomObject,CustomObjectDraft>

equals

public boolean equals(Object o)

hashCode

public int hashCode()

toString

public String toString()

Overrides:

toString in class Object

reflectionHashCode

public int reflectionHashCode()