Package org.apache.flink.connector.elasticsearch.sink

Interface ElasticsearchEmitter<T>

  • Type Parameters:
    T - The type of the element handled by this ElasticsearchEmitter
    All Superinterfaces:
    org.apache.flink.api.common.functions.Function, Serializable
    All Known Implementing Classes:
    MapElasticsearchEmitter
    @PublicEvolving
public interface ElasticsearchEmitter<T>
extends org.apache.flink.api.common.functions.Function
    Creates none or multiple ActionRequests from the incoming elements.

    This is used by sinks to prepare elements for sending them to Elasticsearch.

    Example: 

    
 private static class TestElasticsearchEmitter implements ElasticsearchEmitter<Tuple2<Integer, String>> {

     public IndexRequest createIndexRequest(Tuple2<Integer, String> element) {
         Map<String, Object> document = new HashMap<>();
 		   document.put("data", element.f1);

 	       return Requests.indexRequest()
 		       .index("my-index")
 			   .type("my-type")
 			   .id(element.f0.toString())
 			   .source(document);
     }

 	   public void emit(Tuple2<Integer, String> element, RequestIndexer indexer) {
 	       indexer.add(createIndexRequest(element));
     }
 }

    • Method Summary

      All Methods Instance Methods Abstract Methods Default Methods 
      Modifier and Type Method Description
      default void close()
      Tear-down method for the function.
      void emit​(T element, org.apache.flink.api.connector.sink2.SinkWriter.Context context, RequestIndexer indexer)
      Process the incoming element to produce multiple ActionRequests.
      default void open()
      Initialization method for the function.

    • Method Detail

      • open

        default void open()
           throws Exception
        Initialization method for the function. It is called once before the actual working process methods.
        Throws:
        Exception

      • close

        default void close()
            throws Exception
        Tear-down method for the function. It is called when the sink closes.
        Throws:
        Exception

      • emit

        void emit​(T element,
          org.apache.flink.api.connector.sink2.SinkWriter.Context context,
          RequestIndexer indexer)
        Process the incoming element to produce multiple ActionRequests. The produced requests should be added to the provided RequestIndexer.
        Parameters:
        element - incoming element to process
        context - to access additional information about the record
        indexer - request indexer that ActionRequest should be added to