org.apache.flink.streaming.connectors.elasticsearch7

Class ElasticsearchSink.Builder<T>

java.lang.Object

org.apache.flink.streaming.connectors.elasticsearch7.ElasticsearchSink.Builder<T>

Type Parameters:

T - Type of the elements handled by the sink this builder creates.

Enclosing class:

ElasticsearchSink<T>

@PublicEvolving
public static class ElasticsearchSink.Builder<T>
extends Object

A builder for creating an ElasticsearchSink.

Constructor Summary

Constructors

Constructor and Description
Builder(List<org.apache.http.HttpHost> httpHosts, org.apache.flink.streaming.connectors.elasticsearch.ElasticsearchSinkFunction<T> elasticsearchSinkFunction) Creates a new ElasticsearchSink that connects to the cluster using a RestHighLevelClient.

Method Summary

Modifier and Type	Method and Description
ElasticsearchSink<T>	build() Creates the Elasticsearch sink.
boolean	equals(Object o)
int	hashCode()
void	setBulkFlushBackoff(boolean enabled) Sets whether or not to enable bulk flush backoff behaviour.
void	setBulkFlushBackoffDelay(long delayMillis) Sets the amount of delay between each backoff attempt when flushing bulk requests, in milliseconds.
void	setBulkFlushBackoffRetries(int maxRetries) Sets the maximum number of retries for a backoff attempt when flushing bulk requests.
void	setBulkFlushBackoffType(org.apache.flink.streaming.connectors.elasticsearch.ElasticsearchSinkBase.FlushBackoffType flushBackoffType) Sets the type of back of to use when flushing bulk requests.
void	setBulkFlushInterval(long intervalMillis) Sets the bulk flush interval, in milliseconds.
void	setBulkFlushMaxActions(int numMaxActions) Sets the maximum number of actions to buffer for each bulk request.
void	setBulkFlushMaxSizeMb(int maxSizeMb) Sets the maximum size of buffered actions, in mb, per bulk request.
void	setFailureHandler(org.apache.flink.streaming.connectors.elasticsearch.ActionRequestFailureHandler failureHandler) Sets a failure handler for action requests.
void	setRestClientFactory(RestClientFactory restClientFactory) Sets a REST client factory for custom client configuration.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder(List<org.apache.http.HttpHost> httpHosts,
               org.apache.flink.streaming.connectors.elasticsearch.ElasticsearchSinkFunction<T> elasticsearchSinkFunction)

Creates a new ElasticsearchSink that connects to the cluster using a RestHighLevelClient.

Parameters:

httpHosts - The list of HttpHost to which the RestHighLevelClient connects to.

elasticsearchSinkFunction - This is used to generate multiple ActionRequest from the incoming element.

Method Detail

setBulkFlushMaxActions

public void setBulkFlushMaxActions(int numMaxActions)

Sets the maximum number of actions to buffer for each bulk request. You can pass -1 to disable it.

Parameters:

numMaxActions - the maximum number of actions to buffer per bulk request.

setBulkFlushMaxSizeMb

public void setBulkFlushMaxSizeMb(int maxSizeMb)

Sets the maximum size of buffered actions, in mb, per bulk request. You can pass -1 to disable it.

Parameters:

maxSizeMb - the maximum size of buffered actions, in mb.

setBulkFlushInterval

public void setBulkFlushInterval(long intervalMillis)

Sets the bulk flush interval, in milliseconds. You can pass -1 to disable it.

Parameters:

intervalMillis - the bulk flush interval, in milliseconds.

setBulkFlushBackoff

public void setBulkFlushBackoff(boolean enabled)

Sets whether or not to enable bulk flush backoff behaviour.

Parameters:

enabled - whether or not to enable backoffs.

setBulkFlushBackoffType

public void setBulkFlushBackoffType(org.apache.flink.streaming.connectors.elasticsearch.ElasticsearchSinkBase.FlushBackoffType flushBackoffType)

Sets the type of back of to use when flushing bulk requests.

Parameters:

flushBackoffType - the backoff type to use.

setBulkFlushBackoffRetries

public void setBulkFlushBackoffRetries(int maxRetries)

Sets the maximum number of retries for a backoff attempt when flushing bulk requests.

Parameters:

maxRetries - the maximum number of retries for a backoff attempt when flushing bulk requests

setBulkFlushBackoffDelay

public void setBulkFlushBackoffDelay(long delayMillis)

Sets the amount of delay between each backoff attempt when flushing bulk requests, in milliseconds.

Parameters:

delayMillis - the amount of delay between each backoff attempt when flushing bulk requests, in milliseconds.

setFailureHandler

public void setFailureHandler(org.apache.flink.streaming.connectors.elasticsearch.ActionRequestFailureHandler failureHandler)

Sets a failure handler for action requests.

Parameters:

failureHandler - This is used to handle failed ActionRequest.

setRestClientFactory

public void setRestClientFactory(RestClientFactory restClientFactory)

Sets a REST client factory for custom client configuration.

Parameters:

restClientFactory - the factory that configures the rest client.

build

public ElasticsearchSink<T> build()

Creates the Elasticsearch sink.

Returns:

the created Elasticsearch sink.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object