Package com.commercetools.api.models.subscription

Interface SubscriptionChangeDestinationAction

All Superinterfaces:

ResourceUpdateAction<SubscriptionUpdateAction>, SubscriptionUpdateAction

public interface SubscriptionChangeDestinationAction
extends SubscriptionUpdateAction

A test notification is sent to ensure the correct configuration of the Destination. If the notification cannot be delivered, the update will fail. The payload of the test notification is of type ResourceCreated for the resourceTypeId subscription. The status will change to Healthy, if it isn't already.

Example to create an instance using the builder pattern

     SubscriptionChangeDestinationAction subscriptionChangeDestinationAction = SubscriptionChangeDestinationAction.builder()
             .destination(destinationBuilder -> destinationBuilder)
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CHANGE_DESTINATION	discriminator value for SubscriptionChangeDestinationAction

Method Summary

Modifier and Type	Method	Description
static SubscriptionChangeDestinationActionBuilder	builder()	builder factory method for SubscriptionChangeDestinationAction
static SubscriptionChangeDestinationActionBuilder	builder(SubscriptionChangeDestinationAction template)	create builder for SubscriptionChangeDestinationAction instance
static SubscriptionChangeDestinationAction	deepCopy(SubscriptionChangeDestinationAction template)	factory method to create a deep copy of SubscriptionChangeDestinationAction
@NotNull @Valid Destination	getDestination()	New value to set.
static SubscriptionChangeDestinationAction	of()	factory method
static SubscriptionChangeDestinationAction	of(SubscriptionChangeDestinationAction template)	factory method to create a shallow copy SubscriptionChangeDestinationAction
void	setDestination(Destination destination)	New value to set.
static com.fasterxml.jackson.core.type.TypeReference<SubscriptionChangeDestinationAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withSubscriptionChangeDestinationAction(Function<SubscriptionChangeDestinationAction,T> helper)	accessor map function

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

get

Methods inherited from interface com.commercetools.api.models.subscription.SubscriptionUpdateAction

getAction, withSubscriptionUpdateAction

Field Details

CHANGE_DESTINATION

static final String CHANGE_DESTINATION

discriminator value for SubscriptionChangeDestinationAction

See Also:

• Constant Field Values

Method Details

getDestination

@NotNull
@Valid
@NotNull @Valid Destination getDestination()

New value to set. Must not be empty.

Returns:

destination

setDestination

void setDestination(Destination destination)

New value to set. Must not be empty.

Parameters:

destination - value to be set

of

static SubscriptionChangeDestinationAction of()

factory method

Returns:

instance of SubscriptionChangeDestinationAction

of

static SubscriptionChangeDestinationAction of(SubscriptionChangeDestinationAction template)

factory method to create a shallow copy SubscriptionChangeDestinationAction

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static SubscriptionChangeDestinationAction deepCopy(@Nullable
 SubscriptionChangeDestinationAction template)

factory method to create a deep copy of SubscriptionChangeDestinationAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static SubscriptionChangeDestinationActionBuilder builder()

builder factory method for SubscriptionChangeDestinationAction

Returns:

builder

builder

static SubscriptionChangeDestinationActionBuilder builder(SubscriptionChangeDestinationAction template)

create builder for SubscriptionChangeDestinationAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withSubscriptionChangeDestinationAction

default <T> T withSubscriptionChangeDestinationAction(Function<SubscriptionChangeDestinationAction,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<SubscriptionChangeDestinationAction> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference