[FLINK-8199] [elasticsearch] Properly annotate APIs of Elasticsearch …

…connector This closes apache#5124.
laubersder · Jan 12, 2018 · 9b5fce6 · 9b5fce6
1 parent 5a318de
commit 9b5fce6
Show file tree

Hide file tree

Showing 18 changed files with 42 additions and 0 deletions.
diff --git a/...java/org/apache/flink/streaming/connectors/elasticsearch/ActionRequestFailureHandler.java b/...java/org/apache/flink/streaming/connectors/elasticsearch/ActionRequestFailureHandler.java
@@ -17,6 +17,8 @@
 
 package org.apache.flink.streaming.connectors.elasticsearch;
 
+import org.apache.flink.annotation.PublicEvolving;
+
 import org.elasticsearch.action.ActionRequest;
 
 import java.io.Serializable;
@@ -56,6 +58,7 @@
  * could not be retrieved through the older version Java client APIs (thus, the types will be general {@link Exception}s
  * and only differ in the failure message). In this case, it is recommended to match on the provided REST status code.
  */
+@PublicEvolving
 public interface ActionRequestFailureHandler extends Serializable {
 
  /**

diff --git a/...c/main/java/org/apache/flink/streaming/connectors/elasticsearch/BulkProcessorIndexer.java b/...c/main/java/org/apache/flink/streaming/connectors/elasticsearch/BulkProcessorIndexer.java
@@ -18,6 +18,8 @@
 
 package org.apache.flink.streaming.connectors.elasticsearch;
 
+import org.apache.flink.annotation.Internal;
+
 import org.elasticsearch.action.ActionRequest;
 import org.elasticsearch.action.bulk.BulkProcessor;
 
@@ -29,6 +31,7 @@
  * Implementation of a {@link RequestIndexer}, using a {@link BulkProcessor}.
  * {@link ActionRequest ActionRequests} will be buffered before sending a bulk request to the Elasticsearch cluster.
  */
+@Internal
 class BulkProcessorIndexer implements RequestIndexer {
 
  private final BulkProcessor bulkProcessor;

diff --git a/.../java/org/apache/flink/streaming/connectors/elasticsearch/ElasticsearchApiCallBridge.java b/.../java/org/apache/flink/streaming/connectors/elasticsearch/ElasticsearchApiCallBridge.java
@@ -18,6 +18,8 @@
 
 package org.apache.flink.streaming.connectors.elasticsearch;
 
+import org.apache.flink.annotation.Internal;
+
 import org.elasticsearch.action.bulk.BulkItemResponse;
 import org.elasticsearch.action.bulk.BulkProcessor;
 import org.elasticsearch.client.Client;
@@ -36,6 +38,7 @@
  * is allowed, the call bridge will hold reference to the created embedded node. Each instance of the sink will hold
  * exactly one instance of the call bridge, and state cleanup is performed when the sink is closed.
  */
+@Internal
 public interface ElasticsearchApiCallBridge extends Serializable {
 
  /**

diff --git a/.../main/java/org/apache/flink/streaming/connectors/elasticsearch/ElasticsearchSinkBase.java b/.../main/java/org/apache/flink/streaming/connectors/elasticsearch/ElasticsearchSinkBase.java
@@ -17,6 +17,7 @@
 
 package org.apache.flink.streaming.connectors.elasticsearch;
 
+import org.apache.flink.annotation.Internal;
 import org.apache.flink.annotation.VisibleForTesting;
 import org.apache.flink.api.java.utils.ParameterTool;
 import org.apache.flink.configuration.Configuration;
@@ -61,6 +62,7 @@
  *
  * @param <T> Type of the elements handled by this sink
  */
+@Internal
 public abstract class ElasticsearchSinkBase<T> extends RichSinkFunction<T> implements CheckpointedFunction {
 
  private static final long serialVersionUID = -1007596293618451942L;

diff --git a/...n/java/org/apache/flink/streaming/connectors/elasticsearch/ElasticsearchSinkFunction.java b/...n/java/org/apache/flink/streaming/connectors/elasticsearch/ElasticsearchSinkFunction.java
@@ -18,6 +18,7 @@
 
 package org.apache.flink.streaming.connectors.elasticsearch;
 
+import org.apache.flink.annotation.PublicEvolving;
 import org.apache.flink.api.common.functions.Function;
 import org.apache.flink.api.common.functions.RuntimeContext;
 
@@ -56,6 +57,7 @@
  *
  * @param <T> The type of the element handled by this {@code ElasticsearchSinkFunction}
  */
+@PublicEvolving
 public interface ElasticsearchSinkFunction<T> extends Serializable, Function {
 
  /**

diff --git a/...ase/src/main/java/org/apache/flink/streaming/connectors/elasticsearch/RequestIndexer.java b/...ase/src/main/java/org/apache/flink/streaming/connectors/elasticsearch/RequestIndexer.java
@@ -18,12 +18,15 @@
 
 package org.apache.flink.streaming.connectors.elasticsearch;
 
+import org.apache.flink.annotation.PublicEvolving;
+
 import org.elasticsearch.action.ActionRequest;
 
 /**
  * Users add multiple {@link ActionRequest ActionRequests} to a {@link RequestIndexer} to prepare
  * them for sending to an Elasticsearch cluster.
  */
+@PublicEvolving
 public interface RequestIndexer {
 
  /**

diff --git a/...ain/java/org/apache/flink/streaming/connectors/elasticsearch/util/ElasticsearchUtils.java b/...ain/java/org/apache/flink/streaming/connectors/elasticsearch/util/ElasticsearchUtils.java
@@ -18,6 +18,8 @@
 
 package org.apache.flink.streaming.connectors.elasticsearch.util;
 
+import org.apache.flink.annotation.Internal;
+
 import org.elasticsearch.common.transport.InetSocketTransportAddress;
 import org.elasticsearch.common.transport.TransportAddress;
 
@@ -28,6 +30,7 @@
 /**
  * Suite of utility methods for Elasticsearch.
  */
+@Internal
 public class ElasticsearchUtils {
 
  /**

diff --git a/...ain/java/org/apache/flink/streaming/connectors/elasticsearch/util/NoOpFailureHandler.java b/...ain/java/org/apache/flink/streaming/connectors/elasticsearch/util/NoOpFailureHandler.java
@@ -17,6 +17,7 @@
 
 package org.apache.flink.streaming.connectors.elasticsearch.util;
 
+import org.apache.flink.annotation.Internal;
 import org.apache.flink.streaming.connectors.elasticsearch.ActionRequestFailureHandler;
 import org.apache.flink.streaming.connectors.elasticsearch.RequestIndexer;
 
@@ -25,6 +26,7 @@
 /**
  * An {@link ActionRequestFailureHandler} that simply fails the sink on any failures.
  */
+@Internal
 public class NoOpFailureHandler implements ActionRequestFailureHandler {
 
  private static final long serialVersionUID = 737941343410827885L;

diff --git a/...e/flink/streaming/connectors/elasticsearch/util/RetryRejectedExecutionFailureHandler.java b/...e/flink/streaming/connectors/elasticsearch/util/RetryRejectedExecutionFailureHandler.java
@@ -18,6 +18,7 @@
 
 package org.apache.flink.streaming.connectors.elasticsearch.util;
 
+import org.apache.flink.annotation.PublicEvolving;
 import org.apache.flink.streaming.connectors.elasticsearch.ActionRequestFailureHandler;
 import org.apache.flink.streaming.connectors.elasticsearch.RequestIndexer;
 import org.apache.flink.util.ExceptionUtils;
@@ -30,6 +31,7 @@
  * {@link EsRejectedExecutionException}s (which means that Elasticsearch node queues are currently full),
  * and fails for all other failures.
  */
+@PublicEvolving
 public class RetryRejectedExecutionFailureHandler implements ActionRequestFailureHandler {
 
  private static final long serialVersionUID = -7423562912824511906L;

diff --git a/...java/org/apache/flink/streaming/connectors/elasticsearch/Elasticsearch1ApiCallBridge.java b/...java/org/apache/flink/streaming/connectors/elasticsearch/Elasticsearch1ApiCallBridge.java
@@ -17,6 +17,7 @@
 
 package org.apache.flink.streaming.connectors.elasticsearch;
 
+import org.apache.flink.annotation.Internal;
 import org.apache.flink.util.Preconditions;
 
 import org.elasticsearch.action.bulk.BulkItemResponse;
@@ -40,6 +41,7 @@
 /**
  * Implementation of {@link ElasticsearchApiCallBridge} for Elasticsearch 1.x.
  */
+@Internal
 public class Elasticsearch1ApiCallBridge implements ElasticsearchApiCallBridge {
 
  private static final long serialVersionUID = -2632363720584123682L;

diff --git a/.../src/main/java/org/apache/flink/streaming/connectors/elasticsearch/ElasticsearchSink.java b/.../src/main/java/org/apache/flink/streaming/connectors/elasticsearch/ElasticsearchSink.java
@@ -17,6 +17,7 @@
 
 package org.apache.flink.streaming.connectors.elasticsearch;
 
+import org.apache.flink.annotation.PublicEvolving;
 import org.apache.flink.streaming.connectors.elasticsearch.util.NoOpFailureHandler;
 
 import org.elasticsearch.action.ActionRequest;
@@ -62,6 +63,7 @@
  *
  * @param <T> Type of the elements handled by this sink
  */
+@PublicEvolving
 public class ElasticsearchSink<T> extends ElasticsearchSinkBase<T> {
 
  private static final long serialVersionUID = 1L;

diff --git a/...g/apache/flink/streaming/connectors/elasticsearch/IndexRequestBuilderWrapperFunction.java b/...g/apache/flink/streaming/connectors/elasticsearch/IndexRequestBuilderWrapperFunction.java
@@ -18,12 +18,14 @@
 
 package org.apache.flink.streaming.connectors.elasticsearch;
 
+import org.apache.flink.annotation.Internal;
 import org.apache.flink.api.common.functions.RuntimeContext;
 
 /**
  * A dummy {@link ElasticsearchSinkFunction} that wraps a {@link IndexRequestBuilder}.
  * This serves as a bridge for the usage deprecation of the {@code IndexRequestBuilder} interface.
  */
+@Internal
 class IndexRequestBuilderWrapperFunction<T> implements ElasticsearchSinkFunction<T> {
 
  private static final long serialVersionUID = 289876038414250101L;

diff --git a/...ava/org/apache/flink/streaming/connectors/elasticsearch2/Elasticsearch2ApiCallBridge.java b/...ava/org/apache/flink/streaming/connectors/elasticsearch2/Elasticsearch2ApiCallBridge.java
@@ -17,6 +17,7 @@
 
 package org.apache.flink.streaming.connectors.elasticsearch2;
 
+import org.apache.flink.annotation.Internal;
 import org.apache.flink.streaming.connectors.elasticsearch.ElasticsearchApiCallBridge;
 import org.apache.flink.streaming.connectors.elasticsearch.ElasticsearchSinkBase;
 import org.apache.flink.streaming.connectors.elasticsearch.util.ElasticsearchUtils;
@@ -42,6 +43,7 @@
 /**
  * Implementation of {@link ElasticsearchApiCallBridge} for Elasticsearch 2.x.
  */
+@Internal
 public class Elasticsearch2ApiCallBridge implements ElasticsearchApiCallBridge {
 
  private static final long serialVersionUID = 2638252694744361079L;

diff --git a/...src/main/java/org/apache/flink/streaming/connectors/elasticsearch2/ElasticsearchSink.java b/...src/main/java/org/apache/flink/streaming/connectors/elasticsearch2/ElasticsearchSink.java
@@ -17,6 +17,7 @@
 
 package org.apache.flink.streaming.connectors.elasticsearch2;
 
+import org.apache.flink.annotation.PublicEvolving;
 import org.apache.flink.streaming.connectors.elasticsearch.ActionRequestFailureHandler;
 import org.apache.flink.streaming.connectors.elasticsearch.ElasticsearchSinkBase;
 import org.apache.flink.streaming.connectors.elasticsearch.util.NoOpFailureHandler;
@@ -56,6 +57,7 @@
  *
  * @param <T> Type of the elements handled by this sink
  */
+@PublicEvolving
 public class ElasticsearchSink<T> extends ElasticsearchSinkBase<T> {
 
  private static final long serialVersionUID = 1L;

diff --git a/...ache/flink/streaming/connectors/elasticsearch2/OldNewElasticsearchSinkFunctionBridge.java b/...ache/flink/streaming/connectors/elasticsearch2/OldNewElasticsearchSinkFunctionBridge.java
@@ -17,13 +17,15 @@
 
 package org.apache.flink.streaming.connectors.elasticsearch2;
 
+import org.apache.flink.annotation.Internal;
 import org.apache.flink.api.common.functions.RuntimeContext;
 import org.apache.flink.streaming.connectors.elasticsearch.RequestIndexer;
 
 /**
  * A dummy {@link org.apache.flink.streaming.connectors.elasticsearch.ElasticsearchSinkFunction} to bridge
  * the migration from the deprecated {@link ElasticsearchSinkFunction}.
  */
+@Internal
 class OldNewElasticsearchSinkFunctionBridge<T> implements org.apache.flink.streaming.connectors.elasticsearch.ElasticsearchSinkFunction<T> {
 
  private static final long serialVersionUID = 2415651895272659448L;

diff --git a/...java/org/apache/flink/streaming/connectors/elasticsearch2/OldNewRequestIndexerBridge.java b/...java/org/apache/flink/streaming/connectors/elasticsearch2/OldNewRequestIndexerBridge.java
@@ -17,12 +17,15 @@
 
 package org.apache.flink.streaming.connectors.elasticsearch2;
 
+import org.apache.flink.annotation.Internal;
+
 import org.elasticsearch.action.ActionRequest;
 
 /**
  * A dummy {@link org.apache.flink.streaming.connectors.elasticsearch.RequestIndexer} to bridge
  * the migration from the deprecated {@link RequestIndexer}.
  */
+@Internal
 class OldNewRequestIndexerBridge implements RequestIndexer {
 
  private static final long serialVersionUID = 4213982619497149416L;

diff --git a/...ava/org/apache/flink/streaming/connectors/elasticsearch5/Elasticsearch5ApiCallBridge.java b/...ava/org/apache/flink/streaming/connectors/elasticsearch5/Elasticsearch5ApiCallBridge.java
@@ -17,6 +17,7 @@
 
 package org.apache.flink.streaming.connectors.elasticsearch5;
 
+import org.apache.flink.annotation.Internal;
 import org.apache.flink.streaming.connectors.elasticsearch.ElasticsearchApiCallBridge;
 import org.apache.flink.streaming.connectors.elasticsearch.ElasticsearchSinkBase;
 import org.apache.flink.streaming.connectors.elasticsearch.util.ElasticsearchUtils;
@@ -45,6 +46,7 @@
 /**
  * Implementation of {@link ElasticsearchApiCallBridge} for Elasticsearch 5.x.
  */
+@Internal
 public class Elasticsearch5ApiCallBridge implements ElasticsearchApiCallBridge {
 
  private static final long serialVersionUID = -5222683870097809633L;

diff --git a/...src/main/java/org/apache/flink/streaming/connectors/elasticsearch5/ElasticsearchSink.java b/...src/main/java/org/apache/flink/streaming/connectors/elasticsearch5/ElasticsearchSink.java
@@ -17,6 +17,7 @@
 
 package org.apache.flink.streaming.connectors.elasticsearch5;
 
+import org.apache.flink.annotation.PublicEvolving;
 import org.apache.flink.streaming.connectors.elasticsearch.ActionRequestFailureHandler;
 import org.apache.flink.streaming.connectors.elasticsearch.ElasticsearchSinkBase;
 import org.apache.flink.streaming.connectors.elasticsearch.ElasticsearchSinkFunction;
@@ -57,6 +58,7 @@
  *
  * @param <T> Type of the elements handled by this sink
  */
+@PublicEvolving
 public class ElasticsearchSink<T> extends ElasticsearchSinkBase<T> {
 
  private static final long serialVersionUID = 1L;