org.apache.flink.connector.base

Enum DeliveryGuarantee

java.lang.Object

java.lang.Enum<DeliveryGuarantee>

org.apache.flink.connector.base.DeliveryGuarantee

All Implemented Interfaces:

Serializable, Comparable<DeliveryGuarantee>, DescribedEnum

@PublicEvolving
public enum DeliveryGuarantee
extends Enum<DeliveryGuarantee>
implements DescribedEnum

DeliverGuarantees that can be chosen. In general your pipeline can only offer the lowest delivery guarantee which is supported by your sources and sinks.

Enum Constant Summary

Enum Constants

Enum Constant and Description
AT_LEAST_ONCE Records are ensured to be delivered but it may happen that the same record is delivered multiple times.
EXACTLY_ONCE Records are only delivered exactly-once also under failover scenarios.
NONE Records are delivered on a best effort basis.

Method Summary

Modifier and Type	Method and Description
InlineElement	getDescription() Returns the description for the enum constant.
String	toString()
static DeliveryGuarantee	valueOf(String name) Returns the enum constant of this type with the specified name.
static DeliveryGuarantee[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

EXACTLY_ONCE

public static final DeliveryGuarantee EXACTLY_ONCE

Records are only delivered exactly-once also under failover scenarios. To build a complete exactly-once pipeline is required that the source and sink support exactly-once and are properly configured.

AT_LEAST_ONCE

public static final DeliveryGuarantee AT_LEAST_ONCE

Records are ensured to be delivered but it may happen that the same record is delivered multiple times. Usually, this guarantee is faster than the exactly-once delivery.

NONE

public static final DeliveryGuarantee NONE

Records are delivered on a best effort basis. It is often the fastest way to process records but it may happen that records are lost or duplicated.

Method Detail

values

public static DeliveryGuarantee[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (DeliveryGuarantee c : DeliveryGuarantee.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static DeliveryGuarantee valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getDescription

public InlineElement getDescription()

Description copied from interface: DescribedEnum

Returns the description for the enum constant.

If you want to include links or code blocks, use TextElement.wrap(InlineElement...) to wrap multiple inline elements into a single one.

Specified by:

getDescription in interface DescribedEnum

toString

public String toString()

Overrides:

toString in class Enum<DeliveryGuarantee>