Package com.commercetools.api.models.extension

Class ExtensionBuilder

java.lang.Object

com.commercetools.api.models.extension.ExtensionBuilder

All Implemented Interfaces:

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

public class ExtensionBuilder
extends Object
implements io.vrap.rmf.base.client.Builder<Extension>

ExtensionBuilder Example to create an instance using the builder pattern

     Extension extension = Extension.builder()
             .id("{id}")
             .version(0.3)
             .createdAt(ZonedDateTime.parse("2022-01-01T12:00:00.301Z"))
             .lastModifiedAt(ZonedDateTime.parse("2022-01-01T12:00:00.301Z"))
             .destination(destinationBuilder -> destinationBuilder)
             .plusTriggers(triggersBuilder -> triggersBuilder)
             .build()
 

Constructor Summary

Constructors

Constructor	Description
ExtensionBuilder()

Method Summary

Modifier and Type	Method	Description
ExtensionBuilder	addTriggers(Function<ExtensionTriggerBuilder,ExtensionTrigger> builder)	Describes what triggers the Extension.
Extension	build()	builds Extension with checking for non-null required values
Extension	buildUnchecked()	builds Extension without checking for non-null required values
ExtensionBuilder	createdAt(ZonedDateTime createdAt)	Date and time (UTC) the Extension was initially created.
ExtensionBuilder	createdBy(CreatedBy createdBy)	Present on resources created after 1 February 2019 except for events not tracked.
ExtensionBuilder	createdBy(Function<CreatedByBuilder,CreatedByBuilder> builder)	Present on resources created after 1 February 2019 except for events not tracked.
ExtensionBuilder	destination(ExtensionDestination destination)	The configuration for the Extension, including its type, location and authentication details.
ExtensionBuilder	destination(Function<ExtensionDestinationBuilder,io.vrap.rmf.base.client.Builder<? extends ExtensionDestination>> builder)	The configuration for the Extension, including its type, location and authentication details.
ZonedDateTime	getCreatedAt()	Date and time (UTC) the Extension was initially created.
CreatedBy	getCreatedBy()	Present on resources created after 1 February 2019 except for events not tracked.
ExtensionDestination	getDestination()	The configuration for the Extension, including its type, location and authentication details.
String	getId()	Unique identifier of the Extension.
String	getKey()	User-defined unique identifier of the Extension.
ZonedDateTime	getLastModifiedAt()	Date and time (UTC) the Extension was last updated.
LastModifiedBy	getLastModifiedBy()	Present on resources created after 1 February 2019 except for events not tracked.
Integer	getTimeoutInMs()	Maximum time (in milliseconds) that the Extension can respond within.
List<ExtensionTrigger>	getTriggers()	Describes what triggers the Extension.
Long	getVersion()	Current version of the Extension.
ExtensionBuilder	id(String id)	Unique identifier of the Extension.
ExtensionBuilder	key(String key)	User-defined unique identifier of the Extension.
ExtensionBuilder	lastModifiedAt(ZonedDateTime lastModifiedAt)	Date and time (UTC) the Extension was last updated.
ExtensionBuilder	lastModifiedBy(LastModifiedBy lastModifiedBy)	Present on resources created after 1 February 2019 except for events not tracked.
ExtensionBuilder	lastModifiedBy(Function<LastModifiedByBuilder,LastModifiedByBuilder> builder)	Present on resources created after 1 February 2019 except for events not tracked.
static ExtensionBuilder	of()	factory method for an instance of ExtensionBuilder
static ExtensionBuilder	of(Extension template)	create builder for Extension instance
ExtensionBuilder	plusTriggers(ExtensionTrigger... triggers)	Describes what triggers the Extension.
ExtensionBuilder	plusTriggers(Function<ExtensionTriggerBuilder,ExtensionTriggerBuilder> builder)	Describes what triggers the Extension.
ExtensionBuilder	setTriggers(Function<ExtensionTriggerBuilder,ExtensionTrigger> builder)	Describes what triggers the Extension.
ExtensionBuilder	timeoutInMs(Integer timeoutInMs)	Maximum time (in milliseconds) that the Extension can respond within.
ExtensionBuilder	triggers(ExtensionTrigger... triggers)	Describes what triggers the Extension.
ExtensionBuilder	triggers(List<ExtensionTrigger> triggers)	Describes what triggers the Extension.
ExtensionBuilder	version(Long version)	Current version of the Extension.
ExtensionBuilder	withCreatedBy(Function<CreatedByBuilder,CreatedBy> builder)	Present on resources created after 1 February 2019 except for events not tracked.
ExtensionBuilder	withLastModifiedBy(Function<LastModifiedByBuilder,LastModifiedBy> builder)	Present on resources created after 1 February 2019 except for events not tracked.
ExtensionBuilder	withTriggers(Function<ExtensionTriggerBuilder,ExtensionTriggerBuilder> builder)	Describes what triggers the Extension.

Methods inherited from class java.lang.Object

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

Constructor Details

ExtensionBuilder

public ExtensionBuilder()

Method Details

id

public ExtensionBuilder id(String id)

Unique identifier of the Extension.

Parameters:

id - value to be set

Returns:

Builder

version

public ExtensionBuilder version(Long version)

Current version of the Extension.

Parameters:

version - value to be set

Returns:

Builder

createdAt

public ExtensionBuilder createdAt(ZonedDateTime createdAt)

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

Parameters:

createdAt - value to be set

Returns:

Builder

lastModifiedAt

public ExtensionBuilder lastModifiedAt(ZonedDateTime lastModifiedAt)

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

Parameters:

lastModifiedAt - value to be set

Returns:

Builder

lastModifiedBy

public ExtensionBuilder 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 ExtensionBuilder 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 ExtensionBuilder 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 ExtensionBuilder 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 ExtensionBuilder 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 ExtensionBuilder 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 ExtensionBuilder key(@Nullable
 String key)

User-defined unique identifier of the Extension.

Parameters:

key - value to be set

Returns:

Builder

destination

public ExtensionBuilder destination(ExtensionDestination destination)

The configuration for the Extension, including its type, location and authentication details.

Parameters:

destination - value to be set

Returns:

Builder

destination

public ExtensionBuilder destination(Function<ExtensionDestinationBuilder,io.vrap.rmf.base.client.Builder<? extends ExtensionDestination>> builder)

The configuration for the Extension, including its type, location and authentication details.

Parameters:

builder - function to build the destination value

Returns:

Builder

triggers

public ExtensionBuilder triggers(ExtensionTrigger... triggers)

Describes what triggers the Extension.

Parameters:

triggers - value to be set

Returns:

Builder

triggers

public ExtensionBuilder triggers(List<ExtensionTrigger> triggers)

Describes what triggers the Extension.

Parameters:

triggers - value to be set

Returns:

Builder

plusTriggers

public ExtensionBuilder plusTriggers(ExtensionTrigger... triggers)

Describes what triggers the Extension.

Parameters:

triggers - value to be set

Returns:

Builder

plusTriggers

public ExtensionBuilder plusTriggers(Function<ExtensionTriggerBuilder,ExtensionTriggerBuilder> builder)

Describes what triggers the Extension.

Parameters:

builder - function to build the triggers value

Returns:

Builder

withTriggers

public ExtensionBuilder withTriggers(Function<ExtensionTriggerBuilder,ExtensionTriggerBuilder> builder)

Describes what triggers the Extension.

Parameters:

builder - function to build the triggers value

Returns:

Builder

addTriggers

public ExtensionBuilder addTriggers(Function<ExtensionTriggerBuilder,ExtensionTrigger> builder)

Describes what triggers the Extension.

Parameters:

builder - function to build the triggers value

Returns:

Builder

setTriggers

public ExtensionBuilder setTriggers(Function<ExtensionTriggerBuilder,ExtensionTrigger> builder)

Describes what triggers the Extension.

Parameters:

builder - function to build the triggers value

Returns:

Builder

timeoutInMs

public ExtensionBuilder timeoutInMs(@Nullable
 Integer timeoutInMs)

Maximum time (in milliseconds) that the Extension can respond within. If no timeout is provided, the default value is used for all types of Extensions. The maximum value is 10000 ms (10 seconds) for payment Extensions and 2000 ms (2 seconds) for all other Extensions.

Parameters:

timeoutInMs - value to be set

Returns:

Builder

getId

public String getId()

Unique identifier of the Extension.

Returns:

id

getVersion

public Long getVersion()

Current version of the Extension.

Returns:

version

getCreatedAt

public ZonedDateTime getCreatedAt()

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

Returns:

createdAt

getLastModifiedAt

public ZonedDateTime getLastModifiedAt()

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

Returns:

key

getDestination

public ExtensionDestination getDestination()

The configuration for the Extension, including its type, location and authentication details.

Returns:

destination

getTriggers

public List<ExtensionTrigger> getTriggers()

Describes what triggers the Extension.

Returns:

triggers

getTimeoutInMs

@Nullable
public Integer getTimeoutInMs()

Maximum time (in milliseconds) that the Extension can respond within. If no timeout is provided, the default value is used for all types of Extensions. The maximum value is 10000 ms (10 seconds) for payment Extensions and 2000 ms (2 seconds) for all other Extensions.

Returns:

timeoutInMs

build

public Extension build()

builds Extension with checking for non-null required values

Specified by:

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

Returns:

Extension

buildUnchecked

public Extension buildUnchecked()

builds Extension without checking for non-null required values

Returns:

Extension

of

public static ExtensionBuilder of()

factory method for an instance of ExtensionBuilder

Returns:

builder

of

public static ExtensionBuilder of(Extension template)

create builder for Extension instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder