/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.apache.flink.connector.base;

/**
 * DeliverGuarantees that can be chosen. In general your pipeline can only offer the lowest delivery
 * guarantee which is supported by your sources and sinks.
 */
public enum DeliveryGuarantee {
    /**
     * 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.
     */
    EXACTLY_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.
     */
    AT_LEAST_ONCE,
    /**
     * 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.
     */
    NONE
}

@@ -837,16 +837,262 @@
 .base;%0A%0A
+import org.apache.flink.annotation.PublicEvolving;%0Aimport org.apache.flink.configuration.DescribedEnum;%0Aimport org.apache.flink.configuration.description.InlineElement;%0A%0Aimport static org.apache.flink.configuration.description.TextElement.text;%0A%0A
 /**%0A * D
@@ -1251,16 +1251,32 @@
 ks.%0A */%0A
+@PublicEvolving%0A
 public e
@@ -1297,16 +1297,41 @@
 arantee 
+implements DescribedEnum 
 %7B%0A    /*
@@ -1581,414 +1581,1519 @@
 ONCE
-,%0A    /**%0A     * Records are ensured to be delivered but it may happen that the same record is delivered%0A     * multiple times. Usually, this guarantee is faster than the exactly-once delivery.%0A     */%0A    AT_LEAST_ONCE,%0A    /**%0A     * Records are delivered on a best effort basis. It is often the fastest way to process records%0A     * but it may happen that records are lost or duplicated.%0A     */%0A    NONE
+(%0A            %22exactly-once%22,%0A            text(%0A                    %22Records 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.%22)),%0A    /**%0A     * Records are ensured to be delivered but it may happen that the same record is delivered%0A     * multiple times. Usually, this guarantee is faster than the exactly-once delivery.%0A     */%0A    AT_LEAST_ONCE(%0A            %22at-least-once%22,%0A            text(%0A                    %22Records 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.%22)),%0A    /**%0A     * Records are delivered on a best effort basis. It is often the fastest way to process records%0A     * but it may happen that records are lost or duplicated.%0A     */%0A    NONE(%0A            %22none%22,%0A            text(%0A                    %22Records 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.%22));%0A%0A    private final String name;%0A    private final InlineElement description;%0A%0A    DeliveryGuarantee(String name, InlineElement description) %7B%0A        this.name = name;%0A        this.description = description;%0A    %7D%0A%0A    @Override%0A    public InlineElement getDescription() %7B%0A        return description;%0A    %7D%0A%0A    @Override%0A    public String toString() %7B%0A        return name;%0A    %7D
 %0A%7D%0A

Implement DescribedEnum with DeliveryGuarantee to use it as Table API configuration