Package com.commercetools.api.models.subscription

Interface CloudEventsFormat

All Superinterfaces:

DeliveryFormat

All Known Subinterfaces:

DeliveryCloudEventsFormat

All Known Implementing Classes:

CloudEventsFormatImpl

public interface CloudEventsFormat
extends DeliveryFormat

The CloudEventsFormat can be used with any Destination, and the payload is delivered in the JSON Event Format. AzureEventGridDestination offers native support to filter and route CloudEvents.

Example to create an instance using the builder pattern

     CloudEventsFormat cloudEventsFormat = CloudEventsFormat.builder()
             .cloudEventsVersion("{cloudEventsVersion}")
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CLOUD_EVENTS	discriminator value for CloudEventsFormat

Method Summary

Modifier and Type	Method	Description
static CloudEventsFormatBuilder	builder()	builder factory method for CloudEventsFormat
static CloudEventsFormatBuilder	builder(CloudEventsFormat template)	create builder for CloudEventsFormat instance
static CloudEventsFormat	deepCopy(CloudEventsFormat template)	factory method to create a deep copy of CloudEventsFormat
@NotNull String	getCloudEventsVersion()
static CloudEventsFormat	of()	factory method
static CloudEventsFormat	of(CloudEventsFormat template)	factory method to create a shallow copy CloudEventsFormat
void	setCloudEventsVersion(String cloudEventsVersion)	set cloudEventsVersion
static com.fasterxml.jackson.core.type.TypeReference<CloudEventsFormat>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withCloudEventsFormat(Function<CloudEventsFormat,T> helper)	accessor map function

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

getType, withDeliveryFormat

Field Details

CLOUD_EVENTS

static final String CLOUD_EVENTS

discriminator value for CloudEventsFormat

See Also:

• Constant Field Values

Method Details

getCloudEventsVersion

@NotNull
@NotNull String getCloudEventsVersion()

Returns:

cloudEventsVersion

setCloudEventsVersion

void setCloudEventsVersion(String cloudEventsVersion)

set cloudEventsVersion

Parameters:

cloudEventsVersion - value to be set

of

static CloudEventsFormat of()

factory method

Returns:

instance of CloudEventsFormat

of

static CloudEventsFormat of(CloudEventsFormat template)

factory method to create a shallow copy CloudEventsFormat

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static CloudEventsFormat deepCopy(@Nullable
 CloudEventsFormat template)

factory method to create a deep copy of CloudEventsFormat

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static CloudEventsFormatBuilder builder()

builder factory method for CloudEventsFormat

Returns:

builder

builder

static CloudEventsFormatBuilder builder(CloudEventsFormat template)

create builder for CloudEventsFormat instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withCloudEventsFormat

default <T> T withCloudEventsFormat(Function<CloudEventsFormat,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<CloudEventsFormat> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference