Package com.commercetools.api.models.associate_role

Class AssociateRoleBuilder

java.lang.Object

com.commercetools.api.models.associate_role.AssociateRoleBuilder

All Implemented Interfaces:

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

public class AssociateRoleBuilder
extends Object
implements io.vrap.rmf.base.client.Builder<AssociateRole>

AssociateRoleBuilder Example to create an instance using the builder pattern

     AssociateRole associateRole = AssociateRole.builder()
             .id("{id}")
             .version(0.3)
             .createdAt(ZonedDateTime.parse("2022-01-01T12:00:00.301Z"))
             .lastModifiedAt(ZonedDateTime.parse("2022-01-01T12:00:00.301Z"))
             .key("{key}")
             .buyerAssignable(true)
             .plusPermissions(permissionsBuilder -> permissionsBuilder)
             .build()
 

Constructor Summary

Constructors

Constructor	Description
AssociateRoleBuilder()

Method Summary

Modifier and Type	Method	Description
AssociateRole	build()	builds AssociateRole with checking for non-null required values
AssociateRole	buildUnchecked()	builds AssociateRole without checking for non-null required values
AssociateRoleBuilder	buyerAssignable(Boolean buyerAssignable)	Whether the AssociateRole can be assigned to an Associate by a buyer.
AssociateRoleBuilder	createdAt(ZonedDateTime createdAt)	Date and time (UTC) the AssociateRole was initially created.
AssociateRoleBuilder	createdBy(CreatedBy createdBy)	Present on resources created after 1 February 2019 except for events not tracked.
AssociateRoleBuilder	createdBy(Function<CreatedByBuilder,CreatedByBuilder> builder)	Present on resources created after 1 February 2019 except for events not tracked.
AssociateRoleBuilder	custom(CustomFields custom)	Custom Fields for the AssociateRole.
AssociateRoleBuilder	custom(Function<CustomFieldsBuilder,CustomFieldsBuilder> builder)	Custom Fields for the AssociateRole.
Boolean	getBuyerAssignable()	Whether the AssociateRole can be assigned to an Associate by a buyer.
ZonedDateTime	getCreatedAt()	Date and time (UTC) the AssociateRole was initially created.
CreatedBy	getCreatedBy()	Present on resources created after 1 February 2019 except for events not tracked.
CustomFields	getCustom()	Custom Fields for the AssociateRole.
String	getId()	Unique identifier of the AssociateRole.
String	getKey()	User-defined unique identifier of the AssociateRole.
ZonedDateTime	getLastModifiedAt()	Date and time (UTC) the AssociateRole was last updated.
LastModifiedBy	getLastModifiedBy()	Present on resources updated after 1 February 2019 except for events not tracked.
String	getName()	Name of the AssociateRole.
List<Permission>	getPermissions()	List of Permissions for the AssociateRole.
Long	getVersion()	Current version of the AssociateRole.
AssociateRoleBuilder	id(String id)	Unique identifier of the AssociateRole.
AssociateRoleBuilder	key(String key)	User-defined unique identifier of the AssociateRole.
AssociateRoleBuilder	lastModifiedAt(ZonedDateTime lastModifiedAt)	Date and time (UTC) the AssociateRole was last updated.
AssociateRoleBuilder	lastModifiedBy(LastModifiedBy lastModifiedBy)	Present on resources updated after 1 February 2019 except for events not tracked.
AssociateRoleBuilder	lastModifiedBy(Function<LastModifiedByBuilder,LastModifiedByBuilder> builder)	Present on resources updated after 1 February 2019 except for events not tracked.
AssociateRoleBuilder	name(String name)	Name of the AssociateRole.
static AssociateRoleBuilder	of()	factory method for an instance of AssociateRoleBuilder
static AssociateRoleBuilder	of(AssociateRole template)	create builder for AssociateRole instance
AssociateRoleBuilder	permissions(Permission... permissions)	List of Permissions for the AssociateRole.
AssociateRoleBuilder	permissions(List<Permission> permissions)	List of Permissions for the AssociateRole.
AssociateRoleBuilder	plusPermissions(Permission... permissions)	List of Permissions for the AssociateRole.
AssociateRoleBuilder	version(Long version)	Current version of the AssociateRole.
AssociateRoleBuilder	withCreatedBy(Function<CreatedByBuilder,CreatedBy> builder)	Present on resources created after 1 February 2019 except for events not tracked.
AssociateRoleBuilder	withCustom(Function<CustomFieldsBuilder,CustomFields> builder)	Custom Fields for the AssociateRole.
AssociateRoleBuilder	withLastModifiedBy(Function<LastModifiedByBuilder,LastModifiedBy> builder)	Present on resources updated 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

AssociateRoleBuilder

public AssociateRoleBuilder()

Method Details

id

public AssociateRoleBuilder id(String id)

Unique identifier of the AssociateRole.

Parameters:

id - value to be set

Returns:

Builder

version

public AssociateRoleBuilder version(Long version)

Current version of the AssociateRole.

Parameters:

version - value to be set

Returns:

Builder

createdAt

public AssociateRoleBuilder createdAt(ZonedDateTime createdAt)

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

Parameters:

createdAt - value to be set

Returns:

Builder

lastModifiedAt

public AssociateRoleBuilder lastModifiedAt(ZonedDateTime lastModifiedAt)

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

Parameters:

lastModifiedAt - value to be set

Returns:

Builder

lastModifiedBy

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

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

Parameters:

builder - function to build the lastModifiedBy value

Returns:

Builder

withLastModifiedBy

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

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

Parameters:

builder - function to build the lastModifiedBy value

Returns:

Builder

lastModifiedBy

public AssociateRoleBuilder lastModifiedBy(@Nullable
 LastModifiedBy lastModifiedBy)

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

Parameters:

lastModifiedBy - value to be set

Returns:

Builder

createdBy

public AssociateRoleBuilder 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 AssociateRoleBuilder 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 AssociateRoleBuilder 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 AssociateRoleBuilder key(String key)

User-defined unique identifier of the AssociateRole.

Parameters:

key - value to be set

Returns:

Builder

buyerAssignable

public AssociateRoleBuilder buyerAssignable(Boolean buyerAssignable)

Whether the AssociateRole can be assigned to an Associate by a buyer. If false, the AssociateRole can only be assigned using the general endpoint.

Parameters:

buyerAssignable - value to be set

Returns:

Builder

name

public AssociateRoleBuilder name(@Nullable
 String name)

Name of the AssociateRole.

Parameters:

name - value to be set

Returns:

Builder

permissions

public AssociateRoleBuilder permissions(Permission... permissions)

List of Permissions for the AssociateRole.

Parameters:

permissions - value to be set

Returns:

Builder

permissions

public AssociateRoleBuilder permissions(List<Permission> permissions)

List of Permissions for the AssociateRole.

Parameters:

permissions - value to be set

Returns:

Builder

plusPermissions

public AssociateRoleBuilder plusPermissions(Permission... permissions)

List of Permissions for the AssociateRole.

Parameters:

permissions - value to be set

Returns:

Builder

custom

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

Custom Fields for the AssociateRole.

Parameters:

builder - function to build the custom value

Returns:

Builder

withCustom

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

Custom Fields for the AssociateRole.

Parameters:

builder - function to build the custom value

Returns:

Builder

custom

public AssociateRoleBuilder custom(@Nullable
 CustomFields custom)

Custom Fields for the AssociateRole.

Parameters:

custom - value to be set

Returns:

Builder

getId

public String getId()

Unique identifier of the AssociateRole.

Returns:

id

getVersion

public Long getVersion()

Current version of the AssociateRole.

Returns:

version

getCreatedAt

public ZonedDateTime getCreatedAt()

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

Returns:

createdAt

getLastModifiedAt

public ZonedDateTime getLastModifiedAt()

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

Returns:

lastModifiedAt

getLastModifiedBy

@Nullable
public LastModifiedBy getLastModifiedBy()

Present on resources updated 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

public String getKey()

User-defined unique identifier of the AssociateRole.

Returns:

key

getBuyerAssignable

public Boolean getBuyerAssignable()

Whether the AssociateRole can be assigned to an Associate by a buyer. If false, the AssociateRole can only be assigned using the general endpoint.

Returns:

buyerAssignable

getName

@Nullable
public String getName()

Name of the AssociateRole.

Returns:

name

getPermissions

public List<Permission> getPermissions()

List of Permissions for the AssociateRole.

Returns:

permissions

getCustom

@Nullable
public CustomFields getCustom()

Custom Fields for the AssociateRole.

Returns:

custom

build

public AssociateRole build()

builds AssociateRole with checking for non-null required values

Specified by:

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

Returns:

AssociateRole

buildUnchecked

public AssociateRole buildUnchecked()

builds AssociateRole without checking for non-null required values

Returns:

AssociateRole

of

public static AssociateRoleBuilder of()

factory method for an instance of AssociateRoleBuilder

Returns:

builder

of

public static AssociateRoleBuilder of(AssociateRole template)

create builder for AssociateRole instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder