Package com.commercetools.api.models.subscription

Interface ChangeSubscription

All Known Implementing Classes:

ChangeSubscriptionImpl

public interface ChangeSubscription

Notification about changes to a resource. The payload format differs for resource creation, update, and deletion.

Example to create an instance using the builder pattern

     ChangeSubscription changeSubscription = ChangeSubscription.builder()
             .resourceTypeId(ChangeSubscriptionResourceTypeId.BUSINESS_UNIT)
             .build()
 

Method Summary

Modifier and Type	Method	Description
static ChangeSubscriptionBuilder	builder()	builder factory method for ChangeSubscription
static ChangeSubscriptionBuilder	builder(ChangeSubscription template)	create builder for ChangeSubscription instance
static ChangeSubscription	deepCopy(ChangeSubscription template)	factory method to create a deep copy of ChangeSubscription
@NotNull ChangeSubscriptionResourceTypeId	getResourceTypeId()	Unique identifier for the type of resource, for example, cart.
static ChangeSubscription	of()	factory method
static ChangeSubscription	of(ChangeSubscription template)	factory method to create a shallow copy ChangeSubscription
void	setResourceTypeId(ChangeSubscriptionResourceTypeId resourceTypeId)	Unique identifier for the type of resource, for example, cart.
static com.fasterxml.jackson.core.type.TypeReference<ChangeSubscription>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withChangeSubscription(Function<ChangeSubscription,T> helper)	accessor map function

Method Details

getResourceTypeId

@NotNull
@NotNull ChangeSubscriptionResourceTypeId getResourceTypeId()

Unique identifier for the type of resource, for example, cart.

Returns:

resourceTypeId

setResourceTypeId

void setResourceTypeId(ChangeSubscriptionResourceTypeId resourceTypeId)

Unique identifier for the type of resource, for example, cart.

Parameters:

resourceTypeId - value to be set

of

static ChangeSubscription of()

factory method

Returns:

instance of ChangeSubscription

of

static ChangeSubscription of(ChangeSubscription template)

factory method to create a shallow copy ChangeSubscription

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static ChangeSubscription deepCopy(@Nullable
 ChangeSubscription template)

factory method to create a deep copy of ChangeSubscription

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static ChangeSubscriptionBuilder builder()

builder factory method for ChangeSubscription

Returns:

builder

builder

static ChangeSubscriptionBuilder builder(ChangeSubscription template)

create builder for ChangeSubscription instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withChangeSubscription

default <T> T withChangeSubscription(Function<ChangeSubscription,T> helper)

accessor map function

Type Parameters:

T - mapped type

Parameters:

helper - function to map the object

Returns:

mapped value

typeReference

static com.fasterxml.jackson.core.type.TypeReference<ChangeSubscription> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference