io.sphere.sdk.customobjects.commands

Interface CustomObjectDeleteCommand<T>

Type Parameters:

T - type of the value of the custom object

All Superinterfaces:

Command<CustomObject<T>>, DeleteCommand<CustomObject<T>>, SphereRequest<CustomObject<T>>

public interface CustomObjectDeleteCommand<T>
extends DeleteCommand<CustomObject<T>>

Deletes a custom object in Composable Commerce.

final String key = randomKey();
final Foo foo = new Foo("bar", 7L);
final CustomObject<Foo> customObject = client().executeBlocking(CustomObjectUpsertCommand
        .of(CustomObjectDraft.ofUnversionedUpsert(CONTAINER, key, foo, Foo.class)));

final CustomObject<Foo> deletedObject = client().executeBlocking(CustomObjectDeleteCommand.of(CONTAINER, key, Foo.class));

assertThat(deletedObject.getValue()).isEqualTo(foo);
assertThat(client().executeBlocking(CustomObjectByKeyGet.of(CONTAINER, key, Foo.class)))
        .as("get request")
        .isNull();
See the test code.

See Also:

CustomObject

Method Summary

Modifier and Type	Method and Description
static <T> DeleteCommand<CustomObject<T>>	of(CustomObject<T> customObject, Class<T> valueClass) Deletes a custom object without optimistic concurrency control and uses the delete endpoint via container and key and returns the old custom object with the in valueTypeReferencespecified value type.
static <T> DeleteCommand<CustomObject<T>>	of(CustomObject<T> customObject, Class<T> valueClass, boolean eraseData) Deletes a custom object without optimistic concurrency control and uses the delete endpoint via container and key and returns the old custom object with the in valueTypeReferencespecified value type.
static <T> DeleteCommand<CustomObject<T>>	of(CustomObject<T> customObject, com.fasterxml.jackson.core.type.TypeReference<T> valueTypeReference) Deletes a custom object without optimistic concurrency control and uses the delete endpoint via container and key and returns the old custom object with the in valueTypeReferencespecified value type.
static <T> DeleteCommand<CustomObject<T>>	of(CustomObject<T> customObject, com.fasterxml.jackson.core.type.TypeReference<T> valueTypeReference, boolean eraseData) Deletes a custom object without optimistic concurrency control and uses the delete endpoint via container and key and returns the old custom object with the in valueTypeReferencespecified value type.
static <T> DeleteCommand<CustomObject<T>>	of(String id, Long version, Class<T> valueClass) Deletes a custom object by id with optimistic concurrency control and returns the old custom object with the in valueClass specified value type.
static <T> DeleteCommand<CustomObject<T>>	of(String id, Long version, Class<T> valueClass, boolean eraseData) Deletes a custom object by id with optimistic concurrency control and returns the old custom object with the in valueClass specified value type.
static <T> DeleteCommand<CustomObject<T>>	of(String id, Long version, com.fasterxml.jackson.core.type.TypeReference<T> valueTypeReference) Deletes a custom object by id with optimistic concurrency control and returns the old custom object with the in valueTypeReference specified value type.
static <T> DeleteCommand<CustomObject<T>>	of(String id, Long version, com.fasterxml.jackson.core.type.TypeReference<T> valueTypeReference, boolean eraseData) Deletes a custom object by id with optimistic concurrency control and returns the old custom object with the in valueTypeReference specified value type.
static <T> DeleteCommand<CustomObject<T>>	of(String container, String key, Class<T> valueClass) Deletes a custom object without optimistic concurrency control and uses the delete endpoint via container and key and returns the old custom object with the in valueTypeReferencespecified value type.
static <T> DeleteCommand<CustomObject<T>>	of(String container, String key, Class<T> valueClass, boolean eraseData) Deletes a custom object without optimistic concurrency control and uses the delete endpoint via container and key and returns the old custom object with the in valueTypeReferencespecified value type.
static <T> DeleteCommand<CustomObject<T>>	of(String container, String key, com.fasterxml.jackson.core.type.TypeReference<T> valueTypeReference) Deletes a custom object without optimistic concurrency control and uses the delete endpoint via container and key and returns the old custom object with the in valueTypeReferencespecified value type.
static <T> DeleteCommand<CustomObject<T>>	of(String container, String key, com.fasterxml.jackson.core.type.TypeReference<T> valueTypeReference, boolean eraseData) Deletes a custom object without optimistic concurrency control and uses the delete endpoint via container and key and returns the old custom object with the in valueTypeReferencespecified value type.
static DeleteCommand<CustomObject<com.fasterxml.jackson.databind.JsonNode>>	ofJsonNode(CustomObject<?> customObject) Deletes a custom object without optimistic concurrency control and uses the delete endpoint via container and key and returns the old custom object with a JsonNode value type.
static DeleteCommand<CustomObject<com.fasterxml.jackson.databind.JsonNode>>	ofJsonNode(CustomObject<?> customObject, boolean eraseData) Deletes a custom object without optimistic concurrency control and uses the delete endpoint via container and key and returns the old custom object with a JsonNode value type.
static DeleteCommand<CustomObject<com.fasterxml.jackson.databind.JsonNode>>	ofJsonNode(String id, Long version) Deletes a custom object by id with optimistic concurrency control and returns the old custom object with a JsonNode value type.
static DeleteCommand<CustomObject<com.fasterxml.jackson.databind.JsonNode>>	ofJsonNode(String id, Long version, boolean eraseData) Deletes a custom object by id with optimistic concurrency control and returns the old custom object with a JsonNode value type.
static DeleteCommand<CustomObject<com.fasterxml.jackson.databind.JsonNode>>	ofJsonNode(String container, String key) Deletes a custom object without optimistic concurrency control and returns the old custom object with a JsonNode value type.
static DeleteCommand<CustomObject<com.fasterxml.jackson.databind.JsonNode>>	ofJsonNode(String container, String key, boolean eraseData) Deletes a custom object without optimistic concurrency control and returns the old custom object with a JsonNode value type.

Methods inherited from interface io.sphere.sdk.client.SphereRequest

canDeserialize, deserialize, httpRequestIntent

Method Detail

of

static <T> DeleteCommand<CustomObject<T>> of(CustomObject<T> customObject,
                                             com.fasterxml.jackson.core.type.TypeReference<T> valueTypeReference)

Deletes a custom object without optimistic concurrency control and uses the delete endpoint via container and key and returns the old custom object with the in valueTypeReferencespecified value type.

Type Parameters:

T - type of the value of the custom object

Parameters:

customObject - the custom object to delete

valueTypeReference - the type reference to deserialize the updated custom object from the API response

Returns:

custom object

of

static <T> DeleteCommand<CustomObject<T>> of(CustomObject<T> customObject,
                                             Class<T> valueClass)

Deletes a custom object without optimistic concurrency control and uses the delete endpoint via container and key and returns the old custom object with the in valueTypeReferencespecified value type.

Type Parameters:

T - type of the value of the custom object

Parameters:

customObject - the custom object to delete

valueClass - the class of the value, if it not uses generics like lists, typically for POJOs

Returns:

custom object

of

static <T> DeleteCommand<CustomObject<T>> of(String container,
                                             String key,
                                             com.fasterxml.jackson.core.type.TypeReference<T> valueTypeReference)

Deletes a custom object without optimistic concurrency control and uses the delete endpoint via container and key and returns the old custom object with the in valueTypeReferencespecified value type.

Type Parameters:

T - type of the value of the custom object

Parameters:

container - the container name of the custom object to delete

key - the key name of the custom object to delete

valueTypeReference - the type reference to deserialize the updated custom object from the API response

Returns:

custom object with a JsonNode value

of

static <T> DeleteCommand<CustomObject<T>> of(String container,
                                             String key,
                                             Class<T> valueClass)

Deletes a custom object without optimistic concurrency control and uses the delete endpoint via container and key and returns the old custom object with the in valueTypeReferencespecified value type.

Type Parameters:

T - type of the value of the custom object

Parameters:

container - the container name of the custom object to delete

key - the key name of the custom object to delete

valueClass - the class of the value, if it not uses generics like lists, typically for POJOs

Returns:

custom object with a JsonNode value

ofJsonNode

static DeleteCommand<CustomObject<com.fasterxml.jackson.databind.JsonNode>> ofJsonNode(CustomObject<?> customObject)

Deletes a custom object without optimistic concurrency control and uses the delete endpoint via container and key and returns the old custom object with a JsonNode value type. Convenience method to not specify the TypeReference but lacking the accessible value in the result.

Parameters:

customObject - the custom object to delete

Returns:

custom object with a JsonNode value

ofJsonNode

static DeleteCommand<CustomObject<com.fasterxml.jackson.databind.JsonNode>> ofJsonNode(String container,
                                                                                       String key)

Deletes a custom object without optimistic concurrency control and returns the old custom object with a JsonNode value type. Convenience method to not specify the TypeReference but lacking the accessible value in the result.

Parameters:

container - the container name of the custom object to delete

key - the key name of the custom object to delete

Returns:

custom object with a JsonNode value

ofJsonNode

static DeleteCommand<CustomObject<com.fasterxml.jackson.databind.JsonNode>> ofJsonNode(String id,
                                                                                       Long version)

Deletes a custom object by id with optimistic concurrency control and returns the old custom object with a JsonNode value type. Convenience method to not specify the TypeReference but lacking the accessible value in the result.

Parameters:

id - the id of the custom object to delete

version - the version of the custom object to delete

Returns:

custom object with a JsonNode value

of

static <T> DeleteCommand<CustomObject<T>> of(String id,
                                             Long version,
                                             com.fasterxml.jackson.core.type.TypeReference<T> valueTypeReference)

Deletes a custom object by id with optimistic concurrency control and returns the old custom object with the in valueTypeReference specified value type. Convenience method to not specify the TypeReference but lacking the accessible value in the result.

Type Parameters:

T - type of the value of the custom object

Parameters:

id - the id of the custom object to delete

version - the version of the custom object to delete

valueTypeReference - the type reference to deserialize the updated custom object from the API response

Returns:

custom object with a JsonNode value

of

static <T> DeleteCommand<CustomObject<T>> of(String id,
                                             Long version,
                                             Class<T> valueClass)

Deletes a custom object by id with optimistic concurrency control and returns the old custom object with the in valueClass specified value type.

final String key = randomKey();
final Foo foo = new Foo("bar", 7L);
final CustomObject<Foo> customObject = client().executeBlocking(CustomObjectUpsertCommand
        .of(CustomObjectDraft.ofUnversionedUpsert(CONTAINER, key, foo, Foo.class)));
final String id = customObject.getId();
final Long version = customObject.getVersion();

final CustomObject<Foo> deletedObject = client().executeBlocking(CustomObjectDeleteCommand.of(id, version, Foo.class));

assertThat(deletedObject.getValue()).isEqualTo(foo);
assertThat(client().executeBlocking(CustomObjectByKeyGet.of(CONTAINER, key, Foo.class)))
        .as("get request")
        .isNull();
See the test code.

Type Parameters:

T - type of the value of the custom object

Parameters:

id - the id of the custom object to delete

version - the version of the custom object to delete

valueClass - the class of the value, if it not uses generics like lists, typically for POJOs

Returns:

custom object with a JsonNode value

of

static <T> DeleteCommand<CustomObject<T>> of(CustomObject<T> customObject,
                                             com.fasterxml.jackson.core.type.TypeReference<T> valueTypeReference,
                                             boolean eraseData)

Deletes a custom object without optimistic concurrency control and uses the delete endpoint via container and key and returns the old custom object with the in valueTypeReferencespecified value type.

Type Parameters:

T - type of the value of the custom object

Parameters:

customObject - the custom object to delete

valueTypeReference - the type reference to deserialize the updated custom object from the API response

eraseData - If set to true, Composable Commerce guarantees that all personal data related to the particular object, including invisible data, is erased, in compliance with the GDPR.

Returns:

custom object

of

static <T> DeleteCommand<CustomObject<T>> of(CustomObject<T> customObject,
                                             Class<T> valueClass,
                                             boolean eraseData)

Deletes a custom object without optimistic concurrency control and uses the delete endpoint via container and key and returns the old custom object with the in valueTypeReferencespecified value type.

Type Parameters:

T - type of the value of the custom object

Parameters:

customObject - the custom object to delete

valueClass - the class of the value, if it not uses generics like lists, typically for POJOs

eraseData - If set to true, Composable Commerce guarantees that all personal data related to the particular object, including invisible data, is erased, in compliance with the GDPR.

Returns:

custom object

of

static <T> DeleteCommand<CustomObject<T>> of(String container,
                                             String key,
                                             com.fasterxml.jackson.core.type.TypeReference<T> valueTypeReference,
                                             boolean eraseData)

Deletes a custom object without optimistic concurrency control and uses the delete endpoint via container and key and returns the old custom object with the in valueTypeReferencespecified value type.

Type Parameters:

T - type of the value of the custom object

Parameters:

container - the container name of the custom object to delete

key - the key name of the custom object to delete

valueTypeReference - the type reference to deserialize the updated custom object from the API response

eraseData - If set to true, Composable Commerce guarantees that all personal data related to the particular object, including invisible data, is erased, in compliance with the GDPR.

Returns:

custom object with a JsonNode value

of

static <T> DeleteCommand<CustomObject<T>> of(String container,
                                             String key,
                                             Class<T> valueClass,
                                             boolean eraseData)

Deletes a custom object without optimistic concurrency control and uses the delete endpoint via container and key and returns the old custom object with the in valueTypeReferencespecified value type.

Type Parameters:

T - type of the value of the custom object

Parameters:

container - the container name of the custom object to delete

key - the key name of the custom object to delete

valueClass - the class of the value, if it not uses generics like lists, typically for POJOs

eraseData - If set to true, Composable Commerce guarantees that all personal data related to the particular object, including invisible data, is erased, in compliance with the GDPR.

Returns:

custom object with a JsonNode value

ofJsonNode

static DeleteCommand<CustomObject<com.fasterxml.jackson.databind.JsonNode>> ofJsonNode(CustomObject<?> customObject,
                                                                                       boolean eraseData)

Deletes a custom object without optimistic concurrency control and uses the delete endpoint via container and key and returns the old custom object with a JsonNode value type. Convenience method to not specify the TypeReference but lacking the accessible value in the result.

Parameters:

customObject - the custom object to delete

eraseData - If set to true, Composable Commerce guarantees that all personal data related to the particular object, including invisible data, is erased, in compliance with the GDPR.

Returns:

custom object with a JsonNode value

ofJsonNode

static DeleteCommand<CustomObject<com.fasterxml.jackson.databind.JsonNode>> ofJsonNode(String container,
                                                                                       String key,
                                                                                       boolean eraseData)

Deletes a custom object without optimistic concurrency control and returns the old custom object with a JsonNode value type. Convenience method to not specify the TypeReference but lacking the accessible value in the result.

Parameters:

container - the container name of the custom object to delete

key - the key name of the custom object to delete

eraseData - If set to true, Composable Commerce guarantees that all personal data related to the particular object, including invisible data, is erased, in compliance with the GDPR.

Returns:

custom object with a JsonNode value

ofJsonNode

static DeleteCommand<CustomObject<com.fasterxml.jackson.databind.JsonNode>> ofJsonNode(String id,
                                                                                       Long version,
                                                                                       boolean eraseData)

Deletes a custom object by id with optimistic concurrency control and returns the old custom object with a JsonNode value type. Convenience method to not specify the TypeReference but lacking the accessible value in the result.

Parameters:

id - the id of the custom object to delete

version - the version of the custom object to delete

eraseData - If set to true, Composable Commerce guarantees that all personal data related to the particular object, including invisible data, is erased, in compliance with the GDPR.

Returns:

custom object with a JsonNode value

of

static <T> DeleteCommand<CustomObject<T>> of(String id,
                                             Long version,
                                             com.fasterxml.jackson.core.type.TypeReference<T> valueTypeReference,
                                             boolean eraseData)

Deletes a custom object by id with optimistic concurrency control and returns the old custom object with the in valueTypeReference specified value type. Convenience method to not specify the TypeReference but lacking the accessible value in the result.

Type Parameters:

T - type of the value of the custom object

Parameters:

id - the id of the custom object to delete

version - the version of the custom object to delete

valueTypeReference - the type reference to deserialize the updated custom object from the API response

eraseData - If set to true, Composable Commerce guarantees that all personal data related to the particular object, including invisible data, is erased, in compliance with the GDPR.

Returns:

custom object with a JsonNode value

of

static <T> DeleteCommand<CustomObject<T>> of(String id,
                                             Long version,
                                             Class<T> valueClass,
                                             boolean eraseData)

Deletes a custom object by id with optimistic concurrency control and returns the old custom object with the in valueClass specified value type.

final String key = randomKey();
final Foo foo = new Foo("bar", 7L);
final CustomObject<Foo> customObject = client().executeBlocking(CustomObjectUpsertCommand
        .of(CustomObjectDraft.ofUnversionedUpsert(CONTAINER, key, foo, Foo.class)));
final String id = customObject.getId();
final Long version = customObject.getVersion();

final CustomObject<Foo> deletedObject = client().executeBlocking(CustomObjectDeleteCommand.of(id, version, Foo.class));

assertThat(deletedObject.getValue()).isEqualTo(foo);
assertThat(client().executeBlocking(CustomObjectByKeyGet.of(CONTAINER, key, Foo.class)))
        .as("get request")
        .isNull();
See the test code.

Type Parameters:

T - type of the value of the custom object

Parameters:

id - the id of the custom object to delete

version - the version of the custom object to delete

valueClass - the class of the value, if it not uses generics like lists, typically for POJOs

eraseData - If set to true, Composable Commerce guarantees that all personal data related to the particular object, including invisible data, is erased, in compliance with the GDPR.

Returns:

custom object with a JsonNode value