Package com.commercetools.api.models.message

Class MessageImpl

java.lang.Object

com.commercetools.api.models.message.MessageImpl

All Implemented Interfaces:

BaseResource, DomainResource<Message>, Identifiable<Message>, Message, Versioned<Message>, io.vrap.rmf.base.client.ModelBase

public class MessageImpl
extends Object
implements Message, io.vrap.rmf.base.client.ModelBase

Base representation of a Message containing common fields to all Message Types.

Nested Class Summary

Nested classes/interfaces inherited from interface io.vrap.rmf.base.client.ModelBase

io.vrap.rmf.base.client.ModelBase.FilteredRecursiveToStringStyle

Constructor Summary

Constructors

Constructor	Description
MessageImpl()	create empty instance

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
ZonedDateTime	getCreatedAt()	Date and time (UTC) the Message was generated.
CreatedBy	getCreatedBy()	Present on resources created after 1 February 2019 except for events not tracked.
String	getId()	Unique identifier of the Message.
ZonedDateTime	getLastModifiedAt()	Value of createdAt.
LastModifiedBy	getLastModifiedBy()	Value of createdBy.
Reference	getResource()	Reference to the resource on which the change or action was performed.
UserProvidedIdentifiers	getResourceUserProvidedIdentifiers()	User-provided identifiers of the resource, such as key or externalId.
Long	getResourceVersion()	Version of the resource on which the change or action was performed.
Long	getSequenceNumber()	Message number in relation to other Messages for a given resource.
String	getType()	Message Type of the Message.
Long	getVersion()	Version of a resource.
int	hashCode()
void	setCreatedAt(ZonedDateTime createdAt)	Date and time (UTC) the Message was generated.
void	setCreatedBy(CreatedBy createdBy)	Present on resources created after 1 February 2019 except for events not tracked.
void	setId(String id)	Unique identifier of the Message.
void	setLastModifiedAt(ZonedDateTime lastModifiedAt)	Value of createdAt.
void	setLastModifiedBy(LastModifiedBy lastModifiedBy)	Value of createdBy.
void	setResource(Reference resource)	Reference to the resource on which the change or action was performed.
void	setResourceUserProvidedIdentifiers(UserProvidedIdentifiers resourceUserProvidedIdentifiers)	User-provided identifiers of the resource, such as key or externalId.
void	setResourceVersion(Long resourceVersion)	Version of the resource on which the change or action was performed.
void	setSequenceNumber(Long sequenceNumber)	Message number in relation to other Messages for a given resource.
void	setVersion(Long version)	Version of a resource.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

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

withBaseResource

Methods inherited from interface com.commercetools.api.models.DomainResource

get

Methods inherited from interface com.commercetools.api.models.message.Message

withMessage

Methods inherited from interface io.vrap.rmf.base.client.ModelBase

reflectionString, reflectionString

Constructor Details

MessageImpl

public MessageImpl()

create empty instance

Method Details

getId

public String getId()

Unique identifier of the Message. Can be used to track which Messages have been processed.

Specified by:

getId in interface BaseResource

Specified by:

getId in interface DomainResource<Message>

Specified by:

getId in interface Identifiable<Message>

Specified by:

getId in interface Message

Specified by:

getId in interface Versioned<Message>

Returns:

id

getVersion

public Long getVersion()

Version of a resource. In case of Messages, this is always 1.

Specified by:

getVersion in interface BaseResource

Specified by:

getVersion in interface DomainResource<Message>

Specified by:

getVersion in interface Message

Specified by:

getVersion in interface Versioned<Message>

Returns:

version

getCreatedAt

public ZonedDateTime getCreatedAt()

Date and time (UTC) the Message was generated.

Specified by:

getCreatedAt in interface BaseResource

Specified by:

getCreatedAt in interface Message

Returns:

createdAt

getLastModifiedAt

public ZonedDateTime getLastModifiedAt()

Value of createdAt.

Specified by:

getLastModifiedAt in interface BaseResource

Specified by:

getLastModifiedAt in interface Message

Returns:

lastModifiedAt

getLastModifiedBy

public LastModifiedBy getLastModifiedBy()

Value of createdBy.

Specified by:

getLastModifiedBy in interface Message

Returns:

lastModifiedBy

getCreatedBy

public CreatedBy getCreatedBy()

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

Specified by:

getCreatedBy in interface Message

Returns:

createdBy

getSequenceNumber

public Long getSequenceNumber()

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

Specified by:

getSequenceNumber in interface Message

Returns:

sequenceNumber

getResource

public Reference getResource()

Reference to the resource on which the change or action was performed.

Specified by:

getResource in interface Message

Returns:

resource

getResourceVersion

public Long getResourceVersion()

Version of the resource on which the change or action was performed.

Specified by:

getResourceVersion in interface Message

Returns:

resourceVersion

getType

public String getType()

Message Type of the Message.

Specified by:

getType in interface Message

Returns:

type

getResourceUserProvidedIdentifiers

public UserProvidedIdentifiers getResourceUserProvidedIdentifiers()

User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

Specified by:

getResourceUserProvidedIdentifiers in interface Message

Returns:

resourceUserProvidedIdentifiers

setId

public void setId(String id)

Description copied from interface: Message

Unique identifier of the Message. Can be used to track which Messages have been processed.

Specified by:

setId in interface BaseResource

Specified by:

setId in interface Message

Parameters:

id - value to be set

setVersion

public void setVersion(Long version)

Description copied from interface: Message

Version of a resource. In case of Messages, this is always 1.

Specified by:

setVersion in interface BaseResource

Specified by:

setVersion in interface Message

Parameters:

version - value to be set

setCreatedAt

public void setCreatedAt(ZonedDateTime createdAt)

Description copied from interface: Message

Date and time (UTC) the Message was generated.

Specified by:

setCreatedAt in interface BaseResource

Specified by:

setCreatedAt in interface Message

Parameters:

createdAt - value to be set

setLastModifiedAt

public void setLastModifiedAt(ZonedDateTime lastModifiedAt)

Description copied from interface: Message

Value of createdAt.

Specified by:

setLastModifiedAt in interface BaseResource

Specified by:

setLastModifiedAt in interface Message

Parameters:

lastModifiedAt - value to be set

setLastModifiedBy

public void setLastModifiedBy(LastModifiedBy lastModifiedBy)

Description copied from interface: Message

Value of createdBy.

Specified by:

setLastModifiedBy in interface Message

Parameters:

lastModifiedBy - value to be set

setCreatedBy

public void setCreatedBy(CreatedBy createdBy)

Description copied from interface: Message

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

Specified by:

setCreatedBy in interface Message

Parameters:

createdBy - value to be set

setSequenceNumber

public void setSequenceNumber(Long sequenceNumber)

Description copied from interface: Message

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

Specified by:

setSequenceNumber in interface Message

Parameters:

sequenceNumber - value to be set

setResource

public void setResource(Reference resource)

Description copied from interface: Message

Reference to the resource on which the change or action was performed.

Specified by:

setResource in interface Message

Parameters:

resource - value to be set

setResourceVersion

public void setResourceVersion(Long resourceVersion)

Description copied from interface: Message

Version of the resource on which the change or action was performed.

Specified by:

setResourceVersion in interface Message

Parameters:

resourceVersion - value to be set

setResourceUserProvidedIdentifiers

public void setResourceUserProvidedIdentifiers(UserProvidedIdentifiers resourceUserProvidedIdentifiers)

Description copied from interface: Message

User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

Specified by:

setResourceUserProvidedIdentifiers in interface Message

Parameters:

resourceUserProvidedIdentifiers - value to be set

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object