Package com.commercetools.api.models.message

Interface MessagesConfigurationDraft

All Superinterfaces:

io.vrap.rmf.base.client.Draft<MessagesConfigurationDraft>

All Known Subinterfaces:

MessageConfigurationDraft

All Known Implementing Classes:

MessagesConfigurationDraftImpl

public interface MessagesConfigurationDraft
extends io.vrap.rmf.base.client.Draft<MessagesConfigurationDraft>

Defines the configuration for the Messages Query feature for the Project.

Example to create an instance using the builder pattern

     MessagesConfigurationDraft messagesConfigurationDraft = MessagesConfigurationDraft.builder()
             .enabled(true)
             .deleteDaysAfterCreation(0.3)
             .build()
 

Method Summary

Modifier and Type	Method	Description
static MessagesConfigurationDraftBuilder	builder()	builder factory method for MessagesConfigurationDraft
static MessagesConfigurationDraftBuilder	builder(MessagesConfigurationDraft template)	create builder for MessagesConfigurationDraft instance
static MessagesConfigurationDraft	deepCopy(MessagesConfigurationDraft template)	factory method to create a deep copy of MessagesConfigurationDraft
@NotNull Integer	getDeleteDaysAfterCreation()	Specifies the number of days each Message should be available via the Messages Query API.
@NotNull Boolean	getEnabled()	Setting to true activates the Messages Query feature.
static MessagesConfigurationDraft	of()	factory method
static MessagesConfigurationDraft	of(MessagesConfigurationDraft template)	factory method to create a shallow copy MessagesConfigurationDraft
void	setDeleteDaysAfterCreation(Integer deleteDaysAfterCreation)	Specifies the number of days each Message should be available via the Messages Query API.
void	setEnabled(Boolean enabled)	Setting to true activates the Messages Query feature.
static com.fasterxml.jackson.core.type.TypeReference<MessagesConfigurationDraft>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withMessagesConfigurationDraft(Function<MessagesConfigurationDraft,T> helper)	accessor map function

Method Details

getEnabled

@NotNull
@NotNull Boolean getEnabled()

Setting to true activates the Messages Query feature.

Returns:

enabled

getDeleteDaysAfterCreation

@NotNull
@NotNull Integer getDeleteDaysAfterCreation()

Specifies the number of days each Message should be available via the Messages Query API. For Messages older than the specified period, it is not guaranteed that they are still accessible via the API.

Returns:

deleteDaysAfterCreation

setEnabled

void setEnabled(Boolean enabled)

Setting to true activates the Messages Query feature.

Parameters:

enabled - value to be set

setDeleteDaysAfterCreation

void setDeleteDaysAfterCreation(Integer deleteDaysAfterCreation)

Specifies the number of days each Message should be available via the Messages Query API. For Messages older than the specified period, it is not guaranteed that they are still accessible via the API.

Parameters:

deleteDaysAfterCreation - value to be set

of

static MessagesConfigurationDraft of()

factory method

Returns:

instance of MessagesConfigurationDraft

of

static MessagesConfigurationDraft of(MessagesConfigurationDraft template)

factory method to create a shallow copy MessagesConfigurationDraft

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static MessagesConfigurationDraft deepCopy(@Nullable
 MessagesConfigurationDraft template)

factory method to create a deep copy of MessagesConfigurationDraft

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static MessagesConfigurationDraftBuilder builder()

builder factory method for MessagesConfigurationDraft

Returns:

builder

builder

static MessagesConfigurationDraftBuilder builder(MessagesConfigurationDraft template)

create builder for MessagesConfigurationDraft instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withMessagesConfigurationDraft

default <T> T withMessagesConfigurationDraft(Function<MessagesConfigurationDraft,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<MessagesConfigurationDraft> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference