org.apache.flink.streaming.connectors.elasticsearch6

Class Elasticsearch6ApiCallBridge

java.lang.Object

org.apache.flink.streaming.connectors.elasticsearch6.Elasticsearch6ApiCallBridge

All Implemented Interfaces:

Serializable, ElasticsearchApiCallBridge<org.elasticsearch.client.RestHighLevelClient>

@Internal
public class Elasticsearch6ApiCallBridge
extends Object
implements ElasticsearchApiCallBridge<org.elasticsearch.client.RestHighLevelClient>

Implementation of ElasticsearchApiCallBridge for Elasticsearch 6 and later versions.

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
void	configureBulkProcessorBackoff(org.elasticsearch.action.bulk.BulkProcessor.Builder builder, ElasticsearchSinkBase.BulkFlushBackoffPolicy flushBackoffPolicy) Set backoff-related configurations on the provided BulkProcessor.Builder.
org.elasticsearch.action.bulk.BulkProcessor.Builder	createBulkProcessorBuilder(org.elasticsearch.client.RestHighLevelClient client, org.elasticsearch.action.bulk.BulkProcessor.Listener listener) Creates a BulkProcessor.Builder for creating the bulk processor.
RequestIndexer	createBulkProcessorIndexer(org.elasticsearch.action.bulk.BulkProcessor bulkProcessor, boolean flushOnCheckpoint, AtomicLong numPendingRequestsRef) Creates a RequestIndexer that is able to work with BulkProcessor binary compatible.
org.elasticsearch.client.RestHighLevelClient	createClient(Map<String,String> clientConfig) Creates an Elasticsearch client implementing AutoCloseable.
Throwable	extractFailureCauseFromBulkItemResponse(org.elasticsearch.action.bulk.BulkItemResponse bulkItemResponse) Extracts the cause of failure of a bulk item action.
void	verifyClientConnection(org.elasticsearch.client.RestHighLevelClient client) Verify the client connection by making a test request/ping to the Elasticsearch cluster.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.flink.streaming.connectors.elasticsearch.ElasticsearchApiCallBridge

cleanup

Method Detail

createClient

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

Description copied from interface: ElasticsearchApiCallBridge

Creates an Elasticsearch client implementing AutoCloseable.

Specified by:

createClient in interface ElasticsearchApiCallBridge<org.elasticsearch.client.RestHighLevelClient>

Parameters:

clientConfig - The configuration to use when constructing the client.

Returns:

The created client.

createBulkProcessorBuilder

public org.elasticsearch.action.bulk.BulkProcessor.Builder createBulkProcessorBuilder(org.elasticsearch.client.RestHighLevelClient client,
                                                                                      org.elasticsearch.action.bulk.BulkProcessor.Listener listener)

Description copied from interface: ElasticsearchApiCallBridge

Creates a BulkProcessor.Builder for creating the bulk processor.

Specified by:

createBulkProcessorBuilder in interface ElasticsearchApiCallBridge<org.elasticsearch.client.RestHighLevelClient>

Parameters:

client - the Elasticsearch client.

listener - the bulk processor listender.

Returns:

the bulk processor builder.

extractFailureCauseFromBulkItemResponse

public Throwable extractFailureCauseFromBulkItemResponse(org.elasticsearch.action.bulk.BulkItemResponse bulkItemResponse)

Description copied from interface: ElasticsearchApiCallBridge

Extracts the cause of failure of a bulk item action.

Specified by:

extractFailureCauseFromBulkItemResponse in interface ElasticsearchApiCallBridge<org.elasticsearch.client.RestHighLevelClient>

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

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

Description copied from interface: ElasticsearchApiCallBridge

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

Specified by:

configureBulkProcessorBackoff in interface ElasticsearchApiCallBridge<org.elasticsearch.client.RestHighLevelClient>

Parameters:

builder - the BulkProcessor.Builder to configure.

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

createBulkProcessorIndexer

public RequestIndexer createBulkProcessorIndexer(org.elasticsearch.action.bulk.BulkProcessor bulkProcessor,
                                                 boolean flushOnCheckpoint,
                                                 AtomicLong numPendingRequestsRef)

Description copied from interface: ElasticsearchApiCallBridge

Creates a RequestIndexer that is able to work with BulkProcessor binary compatible.

Specified by:

createBulkProcessorIndexer in interface ElasticsearchApiCallBridge<org.elasticsearch.client.RestHighLevelClient>

verifyClientConnection

public void verifyClientConnection(org.elasticsearch.client.RestHighLevelClient client)
                            throws IOException

Description copied from interface: ElasticsearchApiCallBridge

Verify the client connection by making a test request/ping to the Elasticsearch cluster.

Called by ElasticsearchSinkBase.open(org.apache.flink.configuration.Configuration) after creating the client. This makes sure the underlying client is closed if the connection is not successful and preventing thread leak.

Specified by:

verifyClientConnection in interface ElasticsearchApiCallBridge<org.elasticsearch.client.RestHighLevelClient>

Parameters:

client - the Elasticsearch client.

Throws:

IOException