org.apache.flink.streaming.connectors.elasticsearch

Interface ElasticsearchApiCallBridge

All Superinterfaces:

Serializable

All Known Implementing Classes:

Elasticsearch1ApiCallBridge, Elasticsearch2ApiCallBridge, Elasticsearch5ApiCallBridge

@Internal
public interface ElasticsearchApiCallBridge
extends Serializable

An ElasticsearchApiCallBridge is used to bridge incompatible Elasticsearch Java API calls across different versions. This includes calls to create Elasticsearch clients, handle failed item responses, etc. Any incompatible Elasticsearch Java APIs should be bridged using this interface.

Implementations are allowed to be stateful. For example, for Elasticsearch 1.x, since connecting via an embedded node 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.

Method Summary

Modifier and Type	Method and Description
void	cleanup() Perform any necessary state cleanup.
void	configureBulkProcessorBackoff(org.elasticsearch.action.bulk.BulkProcessor.Builder builder, ElasticsearchSinkBase.BulkFlushBackoffPolicy flushBackoffPolicy) Set backoff-related configurations on the provided BulkProcessor.Builder.
org.elasticsearch.client.Client	createClient(Map<String,String> clientConfig) Creates an Elasticsearch Client.
Throwable	extractFailureCauseFromBulkItemResponse(org.elasticsearch.action.bulk.BulkItemResponse bulkItemResponse) Extracts the cause of failure of a bulk item action.

Method Detail

createClient

org.elasticsearch.client.Client createClient(Map<String,String> clientConfig)

Creates an Elasticsearch Client.

Parameters:

clientConfig - The configuration to use when constructing the client.

Returns:

The created client.

extractFailureCauseFromBulkItemResponse

@Nullable
Throwable extractFailureCauseFromBulkItemResponse(org.elasticsearch.action.bulk.BulkItemResponse bulkItemResponse)

Extracts the cause of failure of a bulk item action.

Parameters:

bulkItemResponse - the bulk item response to extract cause of failure

Returns:

the extracted Throwable from the response (null is the response is successful).

configureBulkProcessorBackoff

void configureBulkProcessorBackoff(org.elasticsearch.action.bulk.BulkProcessor.Builder builder,
                                   @Nullable
                                   ElasticsearchSinkBase.BulkFlushBackoffPolicy flushBackoffPolicy)

Set backoff-related configurations on the provided BulkProcessor.Builder. The builder will be later on used to instantiate the actual BulkProcessor.

Parameters:

builder - the BulkProcessor.Builder to configure.

flushBackoffPolicy - user-provided backoff retry settings (null if the user disabled backoff retries).

cleanup

void cleanup()

Perform any necessary state cleanup.