Package com.commercetools.api.client

Class ByProjectKeyChannelsByIDDelete

java.lang.Object

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

io.vrap.rmf.base.client.TypeApiMethod<ByProjectKeyChannelsByIDDelete,Channel>

com.commercetools.api.client.ByProjectKeyChannelsByIDDelete

All Implemented Interfaces:

ApiDeleteMethod<ByProjectKeyChannelsByIDDelete,Channel>, ConflictingTrait<ByProjectKeyChannelsByIDDelete>, Deprecatable200Trait<ByProjectKeyChannelsByIDDelete>, ErrorableTrait<ByProjectKeyChannelsByIDDelete>, ExpandableTrait<ByProjectKeyChannelsByIDDelete>, VersionedTrait<ByProjectKeyChannelsByIDDelete>, ClientRequestCommand<Channel>, CreateHttpRequestCommand, HttpRequestCommand<Channel>, RequestCommand<Channel>

public class ByProjectKeyChannelsByIDDelete
extends TypeApiMethod<ByProjectKeyChannelsByIDDelete,Channel>
implements ApiDeleteMethod<ByProjectKeyChannelsByIDDelete,Channel>, VersionedTrait<ByProjectKeyChannelsByIDDelete>, ConflictingTrait<ByProjectKeyChannelsByIDDelete>, ExpandableTrait<ByProjectKeyChannelsByIDDelete>, ErrorableTrait<ByProjectKeyChannelsByIDDelete>, Deprecatable200Trait<ByProjectKeyChannelsByIDDelete>

Returns a ReferenceExists error if other resources reference the Channel to be deleted.

   CompletableFuture<ApiHttpResponse<com.commercetools.api.models.channel.Channel>> result = apiRoot
            .withProjectKey("{projectKey}")
            .channels()
            .withId("{ID}")
            .delete()
            .withVersion(version)
            .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
ByProjectKeyChannelsByIDDelete(ByProjectKeyChannelsByIDDelete t)
ByProjectKeyChannelsByIDDelete(ApiHttpClient apiHttpClient, String projectKey, String ID)

Method Summary

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

asBaseType

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

executeBlocking

Methods inherited from interface com.commercetools.api.client.ConflictingTrait

asConflictingTrait, asConflictingTraitToBaseType

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

execute, executeBlocking, executeBlocking

Methods inherited from interface com.commercetools.api.client.VersionedTrait

asVersionedTrait, asVersionedTraitToBaseType

Constructor Details

ByProjectKeyChannelsByIDDelete

public ByProjectKeyChannelsByIDDelete(ApiHttpClient apiHttpClient,
 String projectKey,
 String ID)

ByProjectKeyChannelsByIDDelete

public ByProjectKeyChannelsByIDDelete(ByProjectKeyChannelsByIDDelete t)

Method Details

resultType

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

Specified by:

resultType in interface HttpRequestCommand<Channel>

executeBlocking

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

Specified by:

executeBlocking in interface ClientRequestCommand<Channel>

Specified by:

executeBlocking in class ApiMethod<ByProjectKeyChannelsByIDDelete,Channel>

execute

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

Specified by:

execute in interface ClientRequestCommand<Channel>

Specified by:

execute in class ApiMethod<ByProjectKeyChannelsByIDDelete,Channel>

getProjectKey

public String getProjectKey()

getID

public String getID()

getVersion

public List<String> getVersion()

Specified by:

getVersion in interface ApiDeleteMethod<ByProjectKeyChannelsByIDDelete,Channel>

Specified by:

getVersion in interface VersionedTrait<ByProjectKeyChannelsByIDDelete>

getExpand

public List<String> getExpand()

Specified by:

getExpand in interface ExpandableTrait<ByProjectKeyChannelsByIDDelete>

setProjectKey

public void setProjectKey(String projectKey)

setID

public void setID(String ID)

withVersion

public <TValue> ByProjectKeyChannelsByIDDelete withVersion(TValue version)

set version with the specified value

Specified by:

withVersion in interface ApiDeleteMethod<ByProjectKeyChannelsByIDDelete,Channel>

Specified by:

withVersion in interface VersionedTrait<ByProjectKeyChannelsByIDDelete>

Type Parameters:

TValue - value type

Parameters:

version - value to be set

Returns:

ByProjectKeyChannelsByIDDelete

addVersion

public <TValue> ByProjectKeyChannelsByIDDelete addVersion(TValue version)

add additional version query parameter

Specified by:

addVersion in interface ApiDeleteMethod<ByProjectKeyChannelsByIDDelete,Channel>

Specified by:

addVersion in interface VersionedTrait<ByProjectKeyChannelsByIDDelete>

Type Parameters:

TValue - value type

Parameters:

version - value to be added

Returns:

ByProjectKeyChannelsByIDDelete

withVersion

public ByProjectKeyChannelsByIDDelete withVersion(Supplier<Long> supplier)

set version with the specified value

Parameters:

supplier - supplier for the value to be set

Returns:

ByProjectKeyChannelsByIDDelete

addVersion

public ByProjectKeyChannelsByIDDelete addVersion(Supplier<Long> supplier)

add additional version query parameter

Parameters:

supplier - supplier for the value to be added

Returns:

ByProjectKeyChannelsByIDDelete

withVersion

public ByProjectKeyChannelsByIDDelete withVersion(Function<StringBuilder,StringBuilder> op)

set version with the specified value

Parameters:

op - builder for the value to be set

Returns:

ByProjectKeyChannelsByIDDelete

addVersion

public ByProjectKeyChannelsByIDDelete addVersion(Function<StringBuilder,StringBuilder> op)

add additional version query parameter

Parameters:

op - builder for the value to be added

Returns:

ByProjectKeyChannelsByIDDelete

withVersion

public <TValue> ByProjectKeyChannelsByIDDelete withVersion(Collection<TValue> version)

set version with the specified values

Type Parameters:

TValue - value type

Parameters:

version - values to be set

Returns:

ByProjectKeyChannelsByIDDelete

addVersion

public <TValue> ByProjectKeyChannelsByIDDelete addVersion(Collection<TValue> version)

add additional version query parameters

Type Parameters:

TValue - value type

Parameters:

version - values to be added

Returns:

ByProjectKeyChannelsByIDDelete

withExpand

public <TValue> ByProjectKeyChannelsByIDDelete withExpand(TValue expand)

set expand with the specified value

Specified by:

withExpand in interface ExpandableTrait<ByProjectKeyChannelsByIDDelete>

Type Parameters:

TValue - value type

Parameters:

expand - value to be set

Returns:

ByProjectKeyChannelsByIDDelete

addExpand

public <TValue> ByProjectKeyChannelsByIDDelete addExpand(TValue expand)

add additional expand query parameter

Specified by:

addExpand in interface ExpandableTrait<ByProjectKeyChannelsByIDDelete>

Type Parameters:

TValue - value type

Parameters:

expand - value to be added

Returns:

ByProjectKeyChannelsByIDDelete

withExpand

public ByProjectKeyChannelsByIDDelete withExpand(Supplier<String> supplier)

set expand with the specified value

Parameters:

supplier - supplier for the value to be set

Returns:

ByProjectKeyChannelsByIDDelete

addExpand

public ByProjectKeyChannelsByIDDelete addExpand(Supplier<String> supplier)

add additional expand query parameter

Parameters:

supplier - supplier for the value to be added

Returns:

ByProjectKeyChannelsByIDDelete

withExpand

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

set expand with the specified value

Parameters:

op - builder for the value to be set

Returns:

ByProjectKeyChannelsByIDDelete

addExpand

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

add additional expand query parameter

Parameters:

op - builder for the value to be added

Returns:

ByProjectKeyChannelsByIDDelete

withExpand

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

set expand with the specified values

Type Parameters:

TValue - value type

Parameters:

expand - values to be set

Returns:

ByProjectKeyChannelsByIDDelete

addExpand

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

add additional expand query parameters

Type Parameters:

TValue - value type

Parameters:

expand - values to be added

Returns:

ByProjectKeyChannelsByIDDelete

equals

public boolean equals(Object o)

hashCode

public int hashCode()

toString

public String toString()

Overrides:

toString in class Object

reflectionHashCode

public int reflectionHashCode()