Package com.commercetools.api.models.inventory

Class InventoryEntryBuilder

java.lang.Object

com.commercetools.api.models.inventory.InventoryEntryBuilder

All Implemented Interfaces:

io.vrap.rmf.base.client.Builder<InventoryEntry>

public class InventoryEntryBuilder
extends Object
implements io.vrap.rmf.base.client.Builder<InventoryEntry>

InventoryEntryBuilder Example to create an instance using the builder pattern

     InventoryEntry inventoryEntry = InventoryEntry.builder()
             .id("{id}")
             .version(0.3)
             .createdAt(ZonedDateTime.parse("2022-01-01T12:00:00.301Z"))
             .lastModifiedAt(ZonedDateTime.parse("2022-01-01T12:00:00.301Z"))
             .sku("{sku}")
             .quantityOnStock(0.3)
             .availableQuantity(0.3)
             .build()
 

Constructor Summary

Constructors

Constructor	Description
InventoryEntryBuilder()

Method Summary

Modifier and Type	Method	Description
InventoryEntryBuilder	availableQuantity(Long availableQuantity)	Available amount of stock (quantityOnStock - reserved).
InventoryEntry	build()	builds InventoryEntry with checking for non-null required values
InventoryEntry	buildUnchecked()	builds InventoryEntry without checking for non-null required values
InventoryEntryBuilder	createdAt(ZonedDateTime createdAt)	Date and time (UTC) the InventoryEntry was initially created.
InventoryEntryBuilder	createdBy(CreatedBy createdBy)	Present on resources created after 1 February 2019 except for events not tracked.
InventoryEntryBuilder	createdBy(Function<CreatedByBuilder,CreatedByBuilder> builder)	Present on resources created after 1 February 2019 except for events not tracked.
InventoryEntryBuilder	custom(CustomFields custom)	Custom Fields of the InventoryEntry.
InventoryEntryBuilder	custom(Function<CustomFieldsBuilder,CustomFieldsBuilder> builder)	Custom Fields of the InventoryEntry.
InventoryEntryBuilder	expectedDelivery(ZonedDateTime expectedDelivery)	Date and time of the next restock.
Long	getAvailableQuantity()	Available amount of stock (quantityOnStock - reserved).
ZonedDateTime	getCreatedAt()	Date and time (UTC) the InventoryEntry was initially created.
CreatedBy	getCreatedBy()	Present on resources created after 1 February 2019 except for events not tracked.
CustomFields	getCustom()	Custom Fields of the InventoryEntry.
ZonedDateTime	getExpectedDelivery()	Date and time of the next restock.
String	getId()	Unique identifier of the InventoryEntry.
String	getKey()	User-defined unique identifier of the InventoryEntry.
ZonedDateTime	getLastModifiedAt()	Date and time (UTC) the InventoryEntry was last updated.
LastModifiedBy	getLastModifiedBy()	Present on resources created after 1 February 2019 except for events not tracked.
Long	getQuantityOnStock()	Overall amount of stock (availableQuantity + reserved).
Long	getRestockableInDays()	How often the InventoryEntry is restocked (in days).
String	getSku()	ProductVariant sku of the InventoryEntry.
ChannelReference	getSupplyChannel()	Channel that supplies this InventoryEntry.
Long	getVersion()	Current version of the InventoryEntry.
InventoryEntryBuilder	id(String id)	Unique identifier of the InventoryEntry.
InventoryEntryBuilder	key(String key)	User-defined unique identifier of the InventoryEntry.
InventoryEntryBuilder	lastModifiedAt(ZonedDateTime lastModifiedAt)	Date and time (UTC) the InventoryEntry was last updated.
InventoryEntryBuilder	lastModifiedBy(LastModifiedBy lastModifiedBy)	Present on resources created after 1 February 2019 except for events not tracked.
InventoryEntryBuilder	lastModifiedBy(Function<LastModifiedByBuilder,LastModifiedByBuilder> builder)	Present on resources created after 1 February 2019 except for events not tracked.
static InventoryEntryBuilder	of()	factory method for an instance of InventoryEntryBuilder
static InventoryEntryBuilder	of(InventoryEntry template)	create builder for InventoryEntry instance
InventoryEntryBuilder	quantityOnStock(Long quantityOnStock)	Overall amount of stock (availableQuantity + reserved).
InventoryEntryBuilder	restockableInDays(Long restockableInDays)	How often the InventoryEntry is restocked (in days).
InventoryEntryBuilder	sku(String sku)	ProductVariant sku of the InventoryEntry.
InventoryEntryBuilder	supplyChannel(ChannelReference supplyChannel)	Channel that supplies this InventoryEntry.
InventoryEntryBuilder	supplyChannel(Function<ChannelReferenceBuilder,ChannelReferenceBuilder> builder)	Channel that supplies this InventoryEntry.
InventoryEntryBuilder	version(Long version)	Current version of the InventoryEntry.
InventoryEntryBuilder	withCreatedBy(Function<CreatedByBuilder,CreatedBy> builder)	Present on resources created after 1 February 2019 except for events not tracked.
InventoryEntryBuilder	withCustom(Function<CustomFieldsBuilder,CustomFields> builder)	Custom Fields of the InventoryEntry.
InventoryEntryBuilder	withLastModifiedBy(Function<LastModifiedByBuilder,LastModifiedBy> builder)	Present on resources created after 1 February 2019 except for events not tracked.
InventoryEntryBuilder	withSupplyChannel(Function<ChannelReferenceBuilder,ChannelReference> builder)	Channel that supplies this InventoryEntry.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

InventoryEntryBuilder

public InventoryEntryBuilder()

Method Details

id

public InventoryEntryBuilder id(String id)

Unique identifier of the InventoryEntry.

Parameters:

id - value to be set

Returns:

Builder

version

public InventoryEntryBuilder version(Long version)

Current version of the InventoryEntry.

Parameters:

version - value to be set

Returns:

Builder

createdAt

public InventoryEntryBuilder createdAt(ZonedDateTime createdAt)

Date and time (UTC) the InventoryEntry was initially created.

Parameters:

createdAt - value to be set

Returns:

Builder

lastModifiedAt

public InventoryEntryBuilder lastModifiedAt(ZonedDateTime lastModifiedAt)

Date and time (UTC) the InventoryEntry was last updated.

Parameters:

lastModifiedAt - value to be set

Returns:

Builder

lastModifiedBy

public InventoryEntryBuilder lastModifiedBy(Function<LastModifiedByBuilder,LastModifiedByBuilder> builder)

Present on resources created after 1 February 2019 except for events not tracked.

Parameters:

builder - function to build the lastModifiedBy value

Returns:

Builder

withLastModifiedBy

public InventoryEntryBuilder withLastModifiedBy(Function<LastModifiedByBuilder,LastModifiedBy> builder)

Present on resources created after 1 February 2019 except for events not tracked.

Parameters:

builder - function to build the lastModifiedBy value

Returns:

Builder

lastModifiedBy

public InventoryEntryBuilder lastModifiedBy(@Nullable
 LastModifiedBy lastModifiedBy)

Present on resources created after 1 February 2019 except for events not tracked.

Parameters:

lastModifiedBy - value to be set

Returns:

Builder

createdBy

public InventoryEntryBuilder createdBy(Function<CreatedByBuilder,CreatedByBuilder> builder)

Present on resources created after 1 February 2019 except for events not tracked.

Parameters:

builder - function to build the createdBy value

Returns:

Builder

withCreatedBy

public InventoryEntryBuilder withCreatedBy(Function<CreatedByBuilder,CreatedBy> builder)

Present on resources created after 1 February 2019 except for events not tracked.

Parameters:

builder - function to build the createdBy value

Returns:

Builder

createdBy

public InventoryEntryBuilder createdBy(@Nullable
 CreatedBy createdBy)

Present on resources created after 1 February 2019 except for events not tracked.

Parameters:

createdBy - value to be set

Returns:

Builder

key

public InventoryEntryBuilder key(@Nullable
 String key)

User-defined unique identifier of the InventoryEntry.

Parameters:

key - value to be set

Returns:

Builder

sku

public InventoryEntryBuilder sku(String sku)

ProductVariant sku of the InventoryEntry.

Parameters:

sku - value to be set

Returns:

Builder

supplyChannel

public InventoryEntryBuilder supplyChannel(Function<ChannelReferenceBuilder,ChannelReferenceBuilder> builder)

Channel that supplies this InventoryEntry.

Parameters:

builder - function to build the supplyChannel value

Returns:

Builder

withSupplyChannel

public InventoryEntryBuilder withSupplyChannel(Function<ChannelReferenceBuilder,ChannelReference> builder)

Channel that supplies this InventoryEntry.

Parameters:

builder - function to build the supplyChannel value

Returns:

Builder

supplyChannel

public InventoryEntryBuilder supplyChannel(@Nullable
 ChannelReference supplyChannel)

Channel that supplies this InventoryEntry.

Parameters:

supplyChannel - value to be set

Returns:

Builder

quantityOnStock

public InventoryEntryBuilder quantityOnStock(Long quantityOnStock)

Overall amount of stock (availableQuantity + reserved).

Parameters:

quantityOnStock - value to be set

Returns:

Builder

availableQuantity

public InventoryEntryBuilder availableQuantity(Long availableQuantity)

Available amount of stock (quantityOnStock - reserved).

Parameters:

availableQuantity - value to be set

Returns:

Builder

restockableInDays

public InventoryEntryBuilder restockableInDays(@Nullable
 Long restockableInDays)

How often the InventoryEntry is restocked (in days).

Parameters:

restockableInDays - value to be set

Returns:

Builder

expectedDelivery

public InventoryEntryBuilder expectedDelivery(@Nullable
 ZonedDateTime expectedDelivery)

Date and time of the next restock.

Parameters:

expectedDelivery - value to be set

Returns:

Builder

custom

public InventoryEntryBuilder custom(Function<CustomFieldsBuilder,CustomFieldsBuilder> builder)

Custom Fields of the InventoryEntry.

Parameters:

builder - function to build the custom value

Returns:

Builder

withCustom

public InventoryEntryBuilder withCustom(Function<CustomFieldsBuilder,CustomFields> builder)

Custom Fields of the InventoryEntry.

Parameters:

builder - function to build the custom value

Returns:

Builder

custom

public InventoryEntryBuilder custom(@Nullable
 CustomFields custom)

Custom Fields of the InventoryEntry.

Parameters:

custom - value to be set

Returns:

Builder

getId

public String getId()

Unique identifier of the InventoryEntry.

Returns:

id

getVersion

public Long getVersion()

Current version of the InventoryEntry.

Returns:

version

getCreatedAt

public ZonedDateTime getCreatedAt()

Date and time (UTC) the InventoryEntry was initially created.

Returns:

createdAt

getLastModifiedAt

public ZonedDateTime getLastModifiedAt()

Date and time (UTC) the InventoryEntry was last updated.

Returns:

lastModifiedAt

getLastModifiedBy

@Nullable
public LastModifiedBy getLastModifiedBy()

Present on resources created after 1 February 2019 except for events not tracked.

Returns:

lastModifiedBy

getCreatedBy

@Nullable
public CreatedBy getCreatedBy()

Present on resources created after 1 February 2019 except for events not tracked.

Returns:

createdBy

getKey

@Nullable
public String getKey()

User-defined unique identifier of the InventoryEntry.

Returns:

key

getSku

public String getSku()

ProductVariant sku of the InventoryEntry.

Returns:

sku

getSupplyChannel

@Nullable
public ChannelReference getSupplyChannel()

Channel that supplies this InventoryEntry.

Returns:

supplyChannel

getQuantityOnStock

public Long getQuantityOnStock()

Overall amount of stock (availableQuantity + reserved).

Returns:

quantityOnStock

getAvailableQuantity

public Long getAvailableQuantity()

Available amount of stock (quantityOnStock - reserved).

Returns:

availableQuantity

getRestockableInDays

@Nullable
public Long getRestockableInDays()

How often the InventoryEntry is restocked (in days).

Returns:

restockableInDays

getExpectedDelivery

@Nullable
public ZonedDateTime getExpectedDelivery()

Date and time of the next restock.

Returns:

expectedDelivery

getCustom

@Nullable
public CustomFields getCustom()

Custom Fields of the InventoryEntry.

Returns:

custom

build

public InventoryEntry build()

builds InventoryEntry with checking for non-null required values

Specified by:

build in interface io.vrap.rmf.base.client.Builder<InventoryEntry>

Returns:

InventoryEntry

buildUnchecked

public InventoryEntry buildUnchecked()

builds InventoryEntry without checking for non-null required values

Returns:

InventoryEntry

of

public static InventoryEntryBuilder of()

factory method for an instance of InventoryEntryBuilder

Returns:

builder

of

public static InventoryEntryBuilder of(InventoryEntry template)

create builder for InventoryEntry instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder