Package com.commercetools.api.models.subscription

Interface Destination

All Known Subinterfaces:

AzureEventGridDestination, AzureServiceBusDestination, ConfluentCloudDestination, EventBridgeDestination, GoogleCloudPubSubDestination, SnsDestination, SqsDestination

All Known Implementing Classes:

AzureEventGridDestinationImpl, AzureServiceBusDestinationImpl, ConfluentCloudDestinationImpl, DestinationImpl, EventBridgeDestinationImpl, GoogleCloudPubSubDestinationImpl, SnsDestinationImpl, SqsDestinationImpl

public interface Destination

Destination Example to create a subtype instance using the builder pattern

     Destination destination = Destination.eventGridBuilder()
             uri("{uri}")
             accessKey("{accessKey}")
             .build()
 

Method Summary

Modifier and Type	Method	Description
static AzureServiceBusDestinationBuilder	azureServiceBusBuilder()	builder for azureServiceBus subtype
static ConfluentCloudDestinationBuilder	confluentCloudBuilder()	builder for confluentCloud subtype
static Destination	deepCopy(Destination template)	factory method to create a deep copy of Destination
static EventBridgeDestinationBuilder	eventBridgeBuilder()	builder for eventBridge subtype
static AzureEventGridDestinationBuilder	eventGridBuilder()	builder for eventGrid subtype
@NotNull String	getType()
static GoogleCloudPubSubDestinationBuilder	googleCloudPubSubBuilder()	builder for googleCloudPubSub subtype
static SnsDestinationBuilder	snsBuilder()	builder for sns subtype
static SqsDestinationBuilder	sqsBuilder()	builder for sqs subtype
static com.fasterxml.jackson.core.type.TypeReference<Destination>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withDestination(Function<Destination,T> helper)	accessor map function

Method Details

getType

@NotNull
@NotNull String getType()

Returns:

type

deepCopy

@Nullable
static Destination deepCopy(@Nullable
 Destination template)

factory method to create a deep copy of Destination

Parameters:

template - instance to be copied

Returns:

copy instance

eventGridBuilder

static AzureEventGridDestinationBuilder eventGridBuilder()

builder for eventGrid subtype

Returns:

builder

azureServiceBusBuilder

static AzureServiceBusDestinationBuilder azureServiceBusBuilder()

builder for azureServiceBus subtype

Returns:

builder

confluentCloudBuilder

static ConfluentCloudDestinationBuilder confluentCloudBuilder()

builder for confluentCloud subtype

Returns:

builder

eventBridgeBuilder

static EventBridgeDestinationBuilder eventBridgeBuilder()

builder for eventBridge subtype

Returns:

builder

googleCloudPubSubBuilder

static GoogleCloudPubSubDestinationBuilder googleCloudPubSubBuilder()

builder for googleCloudPubSub subtype

Returns:

builder

snsBuilder

static SnsDestinationBuilder snsBuilder()

builder for sns subtype

Returns:

builder

sqsBuilder

static SqsDestinationBuilder sqsBuilder()

builder for sqs subtype

Returns:

builder

withDestination

default <T> T withDestination(Function<Destination,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<Destination> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference