Package com.commercetools.api.models.subscription

Interface ResourceCreatedDeliveryPayload

All Superinterfaces:

DeliveryPayload, SubscriptionNotification

All Known Subinterfaces:

ResourceCreatedDelivery

public interface ResourceCreatedDeliveryPayload
extends DeliveryPayload

This payload is sent for a ChangeSubscription when a resource is created.

Example to create an instance using the builder pattern

     ResourceCreatedDeliveryPayload resourceCreatedDeliveryPayload = ResourceCreatedDeliveryPayload.builder()
             .projectKey("{projectKey}")
             .resource(resourceBuilder -> resourceBuilder)
             .version(0.3)
             .modifiedAt(ZonedDateTime.parse("2022-01-01T12:00:00.301Z"))
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	RESOURCE_CREATED	discriminator value for ResourceCreatedDeliveryPayload

Method Summary

Modifier and Type	Method	Description
static ResourceCreatedDeliveryPayloadBuilder	builder()	builder factory method for ResourceCreatedDeliveryPayload
static ResourceCreatedDeliveryPayloadBuilder	builder(ResourceCreatedDeliveryPayload template)	create builder for ResourceCreatedDeliveryPayload instance
ResourceCreatedDeliveryPayload	copyDeep()
static ResourceCreatedDeliveryPayload	deepCopy(ResourceCreatedDeliveryPayload template)	factory method to create a deep copy of ResourceCreatedDeliveryPayload
@NotNull ZonedDateTime	getModifiedAt()	Date and time (UTC) the resource was last modified.
@NotNull Long	getVersion()	Last seen version of the resource.
static ResourceCreatedDeliveryPayload	of()	factory method
static ResourceCreatedDeliveryPayload	of(ResourceCreatedDeliveryPayload template)	factory method to create a shallow copy ResourceCreatedDeliveryPayload
void	setModifiedAt(ZonedDateTime modifiedAt)	Date and time (UTC) the resource was last modified.
void	setVersion(Long version)	Last seen version of the resource.
static com.fasterxml.jackson.core.type.TypeReference<ResourceCreatedDeliveryPayload>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withResourceCreatedDeliveryPayload(Function<ResourceCreatedDeliveryPayload,T> helper)	accessor map function

Methods inherited from interface com.commercetools.api.models.subscription.DeliveryPayload

getProjectKey, getResource, getResourceUserProvidedIdentifiers, setProjectKey, setResource, setResourceUserProvidedIdentifiers, withDeliveryPayload

Methods inherited from interface com.commercetools.api.models.subscription.SubscriptionNotification

getNotificationType, withSubscriptionNotification

Field Details

RESOURCE_CREATED

static final String RESOURCE_CREATED

discriminator value for ResourceCreatedDeliveryPayload

See Also:

• Constant Field Values

Method Details

getVersion

@NotNull
@NotNull Long getVersion()

Last seen version of the resource.

Returns:

version

getModifiedAt

@NotNull
@NotNull ZonedDateTime getModifiedAt()

Date and time (UTC) the resource was last modified.

Returns:

modifiedAt

setVersion

void setVersion(Long version)

Last seen version of the resource.

Parameters:

version - value to be set

setModifiedAt

void setModifiedAt(ZonedDateTime modifiedAt)

Date and time (UTC) the resource was last modified.

Parameters:

modifiedAt - value to be set

of

static ResourceCreatedDeliveryPayload of()

factory method

Returns:

instance of ResourceCreatedDeliveryPayload

of

static ResourceCreatedDeliveryPayload of(ResourceCreatedDeliveryPayload template)

factory method to create a shallow copy ResourceCreatedDeliveryPayload

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

ResourceCreatedDeliveryPayload copyDeep()

Specified by:

copyDeep in interface DeliveryPayload

Specified by:

copyDeep in interface SubscriptionNotification

deepCopy

@Nullable
static ResourceCreatedDeliveryPayload deepCopy(@Nullable
 ResourceCreatedDeliveryPayload template)

factory method to create a deep copy of ResourceCreatedDeliveryPayload

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static ResourceCreatedDeliveryPayloadBuilder builder()

builder factory method for ResourceCreatedDeliveryPayload

Returns:

builder

builder

static ResourceCreatedDeliveryPayloadBuilder builder(ResourceCreatedDeliveryPayload template)

create builder for ResourceCreatedDeliveryPayload instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withResourceCreatedDeliveryPayload

default <T> T withResourceCreatedDeliveryPayload(Function<ResourceCreatedDeliveryPayload,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<ResourceCreatedDeliveryPayload> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference