Package com.commercetools.api.models.subscription

Interface AzureEventGridDestination

All Superinterfaces:

Destination

All Known Implementing Classes:

AzureEventGridDestinationImpl

public interface AzureEventGridDestination
extends Destination

Azure Event Grid can be used to push messages to Azure Functions, HTTP endpoints (webhooks), and several other Azure tools. Event Grid can only be used with the CloudEventsFormat. To set up a Subscription with Azure Event Grid, first create a topic in the Azure Portal. To allow Composable Commerce to push messages to your topic, provide an access key.

Example to create an instance using the builder pattern

     AzureEventGridDestination azureEventGridDestination = AzureEventGridDestination.builder()
             .uri("{uri}")
             .accessKey("{accessKey}")
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	EVENT_GRID	discriminator value for AzureEventGridDestination

Method Summary

Modifier and Type	Method	Description
static AzureEventGridDestinationBuilder	builder()	builder factory method for AzureEventGridDestination
static AzureEventGridDestinationBuilder	builder(AzureEventGridDestination template)	create builder for AzureEventGridDestination instance
static AzureEventGridDestination	deepCopy(AzureEventGridDestination template)	factory method to create a deep copy of AzureEventGridDestination
@NotNull String	getAccessKey()	Partially hidden on retrieval for security reasons.
@NotNull String	getUri()	URI of the topic.
static AzureEventGridDestination	of()	factory method
static AzureEventGridDestination	of(AzureEventGridDestination template)	factory method to create a shallow copy AzureEventGridDestination
void	setAccessKey(String accessKey)	Partially hidden on retrieval for security reasons.
void	setUri(String uri)	URI of the topic.
static com.fasterxml.jackson.core.type.TypeReference<AzureEventGridDestination>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withAzureEventGridDestination(Function<AzureEventGridDestination,T> helper)	accessor map function

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

getType, withDestination

Field Details

EVENT_GRID

static final String EVENT_GRID

discriminator value for AzureEventGridDestination

See Also:

• Constant Field Values

Method Details

getUri

@NotNull
@NotNull String getUri()

URI of the topic.

Returns:

uri

getAccessKey

@NotNull
@NotNull String getAccessKey()

Partially hidden on retrieval for security reasons.

Returns:

accessKey

setUri

void setUri(String uri)

URI of the topic.

Parameters:

uri - value to be set

setAccessKey

void setAccessKey(String accessKey)

Partially hidden on retrieval for security reasons.

Parameters:

accessKey - value to be set

of

static AzureEventGridDestination of()

factory method

Returns:

instance of AzureEventGridDestination

of

static AzureEventGridDestination of(AzureEventGridDestination template)

factory method to create a shallow copy AzureEventGridDestination

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static AzureEventGridDestination deepCopy(@Nullable
 AzureEventGridDestination template)

factory method to create a deep copy of AzureEventGridDestination

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static AzureEventGridDestinationBuilder builder()

builder factory method for AzureEventGridDestination

Returns:

builder

builder

static AzureEventGridDestinationBuilder builder(AzureEventGridDestination template)

create builder for AzureEventGridDestination instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withAzureEventGridDestination

default <T> T withAzureEventGridDestination(Function<AzureEventGridDestination,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<AzureEventGridDestination> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference