Package com.commercetools.api.models.message

Interface InventoryEntryOutOfStockMessagePayload

All Superinterfaces:

MessagePayload, MessagePayloadMixin

public interface InventoryEntryOutOfStockMessagePayload
extends MessagePayload

Generated after InventoryEntry quantityOnStock goes to 0.

Example to create an instance using the builder pattern

     InventoryEntryOutOfStockMessagePayload inventoryEntryOutOfStockMessagePayload = InventoryEntryOutOfStockMessagePayload.builder()
             .sku("{sku}")
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	INVENTORY_ENTRY_OUT_OF_STOCK	discriminator value for InventoryEntryOutOfStockMessagePayload

Method Summary

Modifier and Type	Method	Description
static InventoryEntryOutOfStockMessagePayloadBuilder	builder()	builder factory method for InventoryEntryOutOfStockMessagePayload
static InventoryEntryOutOfStockMessagePayloadBuilder	builder(InventoryEntryOutOfStockMessagePayload template)	create builder for InventoryEntryOutOfStockMessagePayload instance
InventoryEntryOutOfStockMessagePayload	copyDeep()
static InventoryEntryOutOfStockMessagePayload	deepCopy(InventoryEntryOutOfStockMessagePayload template)	factory method to create a deep copy of InventoryEntryOutOfStockMessagePayload
@NotNull String	getSku()	The sku of the InventoryEntry whose quantityOnStock went to 0.
@Valid ChannelReference	getSupplyChannel()	Reference to the Channel where the InventoryEntry quantity on stock went to 0.
static InventoryEntryOutOfStockMessagePayload	of()	factory method
static InventoryEntryOutOfStockMessagePayload	of(InventoryEntryOutOfStockMessagePayload template)	factory method to create a shallow copy InventoryEntryOutOfStockMessagePayload
void	setSku(String sku)	The sku of the InventoryEntry whose quantityOnStock went to 0.
void	setSupplyChannel(ChannelReference supplyChannel)	Reference to the Channel where the InventoryEntry quantity on stock went to 0.
static com.fasterxml.jackson.core.type.TypeReference<InventoryEntryOutOfStockMessagePayload>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withInventoryEntryOutOfStockMessagePayload(Function<InventoryEntryOutOfStockMessagePayload,T> helper)	accessor map function

Methods inherited from interface com.commercetools.api.models.message.MessagePayload

getType, withMessagePayload

Methods inherited from interface com.commercetools.api.models.message.MessagePayloadMixin

as

Field Details

INVENTORY_ENTRY_OUT_OF_STOCK

static final String INVENTORY_ENTRY_OUT_OF_STOCK

discriminator value for InventoryEntryOutOfStockMessagePayload

See Also:

• Constant Field Values

Method Details

getSku

@NotNull
@NotNull String getSku()

The sku of the InventoryEntry whose quantityOnStock went to 0.

Returns:

sku

getSupplyChannel

@Valid
@Valid ChannelReference getSupplyChannel()

Reference to the Channel where the InventoryEntry quantity on stock went to 0.

Returns:

supplyChannel

setSku

void setSku(String sku)

The sku of the InventoryEntry whose quantityOnStock went to 0.

Parameters:

sku - value to be set

setSupplyChannel

void setSupplyChannel(ChannelReference supplyChannel)

Reference to the Channel where the InventoryEntry quantity on stock went to 0.

Parameters:

supplyChannel - value to be set

of

static InventoryEntryOutOfStockMessagePayload of()

factory method

Returns:

instance of InventoryEntryOutOfStockMessagePayload

of

static InventoryEntryOutOfStockMessagePayload of(InventoryEntryOutOfStockMessagePayload template)

factory method to create a shallow copy InventoryEntryOutOfStockMessagePayload

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

InventoryEntryOutOfStockMessagePayload copyDeep()

Specified by:

copyDeep in interface MessagePayload

deepCopy

@Nullable
static InventoryEntryOutOfStockMessagePayload deepCopy(@Nullable
 InventoryEntryOutOfStockMessagePayload template)

factory method to create a deep copy of InventoryEntryOutOfStockMessagePayload

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static InventoryEntryOutOfStockMessagePayloadBuilder builder()

builder factory method for InventoryEntryOutOfStockMessagePayload

Returns:

builder

builder

static InventoryEntryOutOfStockMessagePayloadBuilder builder(InventoryEntryOutOfStockMessagePayload template)

create builder for InventoryEntryOutOfStockMessagePayload instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withInventoryEntryOutOfStockMessagePayload

default <T> T withInventoryEntryOutOfStockMessagePayload(Function<InventoryEntryOutOfStockMessagePayload,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<InventoryEntryOutOfStockMessagePayload> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference