org.apache.flink.streaming.connectors.elasticsearch

Interface IndexRequestBuilder<T>

Type Parameters:

T - The type of the element handled by this IndexRequestBuilder

All Superinterfaces:

org.apache.flink.api.common.functions.Function, Serializable

public interface IndexRequestBuilder<T>
extends org.apache.flink.api.common.functions.Function, Serializable

Function that creates an IndexRequest from an element in a Stream.

This is used by ElasticsearchSink to prepare elements for sending them to Elasticsearch. See Index API for information about how to format data for adding it to an Elasticsearch index.

Example:

private static class MyIndexRequestBuilder implements IndexRequestBuilder<String> {

         public IndexRequest createIndexRequest(String element, RuntimeContext ctx) {
             Map<String, Object> json = new HashMap<>();
             json.put("data", element);

             return Requests.indexRequest()
                 .index("my-index")
                 .type("my-type")
                 .source(json);
         }
     }
 

Method Summary

Methods

Modifier and Type	Method and Description
org.elasticsearch.action.index.IndexRequest	createIndexRequest(T element, org.apache.flink.api.common.functions.RuntimeContext ctx) Creates an IndexRequest from an element.

Method Detail

createIndexRequest

org.elasticsearch.action.index.IndexRequest createIndexRequest(T element,
                                                             org.apache.flink.api.common.functions.RuntimeContext ctx)

Creates an IndexRequest from an element.

Parameters:

element - The element that needs to be turned in to an IndexRequest

ctx - The Flink RuntimeContext of the ElasticsearchSink

Returns:

The constructed IndexRequest