Package com.commercetools.api.models.custom_object

Class CustomObjectBuilder

java.lang.Object

com.commercetools.api.models.custom_object.CustomObjectBuilder

All Implemented Interfaces:

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

public class CustomObjectBuilder
extends Object
implements io.vrap.rmf.base.client.Builder<CustomObject>

CustomObjectBuilder Example to create an instance using the builder pattern

     CustomObject customObject = CustomObject.builder()
             .id("{id}")
             .version(0.3)
             .createdAt(ZonedDateTime.parse("2022-01-01T12:00:00.301Z"))
             .lastModifiedAt(ZonedDateTime.parse("2022-01-01T12:00:00.301Z"))
             .container("{container}")
             .key("{key}")
             .build()
 

Constructor Summary

Constructors

Constructor	Description
CustomObjectBuilder()

Method Summary

Modifier and Type	Method	Description
CustomObject	build()	builds CustomObject with checking for non-null required values
CustomObject	buildUnchecked()	builds CustomObject without checking for non-null required values
CustomObjectBuilder	container(String container)	Namespace to group CustomObjects.
CustomObjectBuilder	createdAt(ZonedDateTime createdAt)	Date and time (UTC) the CustomObject was initially created.
CustomObjectBuilder	createdBy(CreatedBy createdBy)	Present on resources created after 1 February 2019 except for events not tracked.
CustomObjectBuilder	createdBy(Function<CreatedByBuilder,CreatedByBuilder> builder)	Present on resources created after 1 February 2019 except for events not tracked.
String	getContainer()	Namespace to group CustomObjects.
ZonedDateTime	getCreatedAt()	Date and time (UTC) the CustomObject was initially created.
CreatedBy	getCreatedBy()	Present on resources created after 1 February 2019 except for events not tracked.
String	getId()	Unique identifier of the CustomObject.
String	getKey()	User-defined unique identifier of the CustomObject within the defined container.
ZonedDateTime	getLastModifiedAt()	Date and time (UTC) the CustomObject was last updated.
LastModifiedBy	getLastModifiedBy()	Present on resources created after 1 February 2019 except for events not tracked.
Object	getValue()	JSON standard types Number, String, Boolean, Array, Object, and common API data types.
Long	getVersion()	Current version of the CustomObject.
CustomObjectBuilder	id(String id)	Unique identifier of the CustomObject.
CustomObjectBuilder	key(String key)	User-defined unique identifier of the CustomObject within the defined container.
CustomObjectBuilder	lastModifiedAt(ZonedDateTime lastModifiedAt)	Date and time (UTC) the CustomObject was last updated.
CustomObjectBuilder	lastModifiedBy(LastModifiedBy lastModifiedBy)	Present on resources created after 1 February 2019 except for events not tracked.
CustomObjectBuilder	lastModifiedBy(Function<LastModifiedByBuilder,LastModifiedByBuilder> builder)	Present on resources created after 1 February 2019 except for events not tracked.
static CustomObjectBuilder	of()	factory method for an instance of CustomObjectBuilder
static CustomObjectBuilder	of(CustomObject template)	create builder for CustomObject instance
CustomObjectBuilder	value(Object value)	JSON standard types Number, String, Boolean, Array, Object, and common API data types.
CustomObjectBuilder	version(Long version)	Current version of the CustomObject.
CustomObjectBuilder	withCreatedBy(Function<CreatedByBuilder,CreatedBy> builder)	Present on resources created after 1 February 2019 except for events not tracked.
CustomObjectBuilder	withLastModifiedBy(Function<LastModifiedByBuilder,LastModifiedBy> builder)	Present on resources created after 1 February 2019 except for events not tracked.

Methods inherited from class java.lang.Object

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

Constructor Details

CustomObjectBuilder

public CustomObjectBuilder()

Method Details

id

public CustomObjectBuilder id(String id)

Unique identifier of the CustomObject.

Parameters:

id - value to be set

Returns:

Builder

version

public CustomObjectBuilder version(Long version)

Current version of the CustomObject.

Parameters:

version - value to be set

Returns:

Builder

createdAt

public CustomObjectBuilder createdAt(ZonedDateTime createdAt)

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

Parameters:

createdAt - value to be set

Returns:

Builder

lastModifiedAt

public CustomObjectBuilder lastModifiedAt(ZonedDateTime lastModifiedAt)

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

Parameters:

lastModifiedAt - value to be set

Returns:

Builder

lastModifiedBy

public CustomObjectBuilder 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 CustomObjectBuilder 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 CustomObjectBuilder 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 CustomObjectBuilder 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 CustomObjectBuilder 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 CustomObjectBuilder 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

container

public CustomObjectBuilder container(String container)

Namespace to group CustomObjects.

Parameters:

container - value to be set

Returns:

Builder

key

public CustomObjectBuilder key(String key)

User-defined unique identifier of the CustomObject within the defined container.

Parameters:

key - value to be set

Returns:

Builder

value

public CustomObjectBuilder value(Object value)

JSON standard types Number, String, Boolean, Array, Object, and common API data types. For values of type Reference the integrity of the data is not guaranteed. If the referenced object is deleted, the API does not delete the corresponding reference to it and the value points to a non-existing object in such case.

Parameters:

value - value to be set

Returns:

Builder

getId

public String getId()

Unique identifier of the CustomObject.

Returns:

id

getVersion

public Long getVersion()

Current version of the CustomObject.

Returns:

version

getCreatedAt

public ZonedDateTime getCreatedAt()

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

Returns:

createdAt

getLastModifiedAt

public ZonedDateTime getLastModifiedAt()

Date and time (UTC) the CustomObject 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

getContainer

public String getContainer()

Namespace to group CustomObjects.

Returns:

container

getKey

public String getKey()

User-defined unique identifier of the CustomObject within the defined container.

Returns:

key

getValue

public Object getValue()

JSON standard types Number, String, Boolean, Array, Object, and common API data types. For values of type Reference the integrity of the data is not guaranteed. If the referenced object is deleted, the API does not delete the corresponding reference to it and the value points to a non-existing object in such case.

Returns:

value

build

public CustomObject build()

builds CustomObject with checking for non-null required values

Specified by:

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

Returns:

CustomObject

buildUnchecked

public CustomObject buildUnchecked()

builds CustomObject without checking for non-null required values

Returns:

CustomObject

of

public static CustomObjectBuilder of()

factory method for an instance of CustomObjectBuilder

Returns:

builder

of

public static CustomObjectBuilder of(CustomObject template)

create builder for CustomObject instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder