Package com.commercetools.api.models.common

Interface CreatedBy

All Superinterfaces:

ClientLogging

All Known Implementing Classes:

CreatedByImpl

public interface CreatedBy
extends ClientLogging

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

Example to create an instance using the builder pattern

     CreatedBy createdBy = CreatedBy.builder()
             .build()
 

Method Summary

Modifier and Type	Method	Description
static CreatedByBuilder	builder()	builder factory method for CreatedBy
static CreatedByBuilder	builder(CreatedBy template)	create builder for CreatedBy instance
static CreatedBy	deepCopy(CreatedBy template)	factory method to create a deep copy of CreatedBy
String	getAnonymousId()	Indicates the anonymous session during which the resource was created.
String	getClientId()	id of the APIClient which created the resource.
@Valid CustomerReference	getCustomer()	Indicates the Customer who created the resource using a token from the password flow.
String	getExternalUserId()	External user ID provided by X-External-User-ID HTTP Header.
static CreatedBy	of()	factory method
static CreatedBy	of(CreatedBy template)	factory method to create a shallow copy CreatedBy
void	setAnonymousId(String anonymousId)	Indicates the anonymous session during which the resource was created.
void	setClientId(String clientId)	id of the APIClient which created the resource.
void	setCustomer(CustomerReference customer)	Indicates the Customer who created the resource using a token from the password flow.
void	setExternalUserId(String externalUserId)	External user ID provided by X-External-User-ID HTTP Header.
static com.fasterxml.jackson.core.type.TypeReference<CreatedBy>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withCreatedBy(Function<CreatedBy,T> helper)	accessor map function

Methods inherited from interface com.commercetools.api.models.common.ClientLogging

withClientLogging

Method Details

getClientId

String getClientId()

id of the APIClient which created the resource.

Specified by:

getClientId in interface ClientLogging

Returns:

clientId

getExternalUserId

String getExternalUserId()

External user ID provided by X-External-User-ID HTTP Header.

Specified by:

getExternalUserId in interface ClientLogging

Returns:

externalUserId

getCustomer

@Valid
@Valid CustomerReference getCustomer()

Indicates the Customer who created the resource using a token from the password flow.

Specified by:

getCustomer in interface ClientLogging

Returns:

customer

getAnonymousId

String getAnonymousId()

Indicates the anonymous session during which the resource was created.

Specified by:

getAnonymousId in interface ClientLogging

Returns:

anonymousId

setClientId

void setClientId(String clientId)

id of the APIClient which created the resource.

Specified by:

setClientId in interface ClientLogging

Parameters:

clientId - value to be set

setExternalUserId

void setExternalUserId(String externalUserId)

External user ID provided by X-External-User-ID HTTP Header.

Specified by:

setExternalUserId in interface ClientLogging

Parameters:

externalUserId - value to be set

setCustomer

void setCustomer(CustomerReference customer)

Indicates the Customer who created the resource using a token from the password flow.

Specified by:

setCustomer in interface ClientLogging

Parameters:

customer - value to be set

setAnonymousId

void setAnonymousId(String anonymousId)

Indicates the anonymous session during which the resource was created.

Specified by:

setAnonymousId in interface ClientLogging

Parameters:

anonymousId - value to be set

of

static CreatedBy of()

factory method

Returns:

instance of CreatedBy

of

static CreatedBy of(CreatedBy template)

factory method to create a shallow copy CreatedBy

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static CreatedBy deepCopy(@Nullable
 CreatedBy template)

factory method to create a deep copy of CreatedBy

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static CreatedByBuilder builder()

builder factory method for CreatedBy

Returns:

builder

builder

static CreatedByBuilder builder(CreatedBy template)

create builder for CreatedBy instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withCreatedBy

default <T> T withCreatedBy(Function<CreatedBy,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<CreatedBy> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference