org.apache.beam.sdk.io.elasticsearch

Class ElasticsearchIO.ConnectionConfiguration

java.lang.Object

org.apache.beam.sdk.io.elasticsearch.ElasticsearchIO.ConnectionConfiguration

All Implemented Interfaces:

java.io.Serializable

Enclosing class:

ElasticsearchIO

public abstract static class ElasticsearchIO.ConnectionConfiguration
extends java.lang.Object
implements java.io.Serializable

A POJO describing a connection configuration to Elasticsearch.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ConnectionConfiguration()

Method Summary

Modifier and Type	Method and Description
static ElasticsearchIO.ConnectionConfiguration	create(java.lang.String[] addresses, java.lang.String index, java.lang.String type) Creates a new Elasticsearch connection configuration.
abstract java.util.List<java.lang.String>	getAddresses()
abstract java.lang.Integer	getConnectTimeout()
abstract java.lang.String	getIndex()
abstract java.lang.String	getKeystorePassword()
abstract java.lang.String	getKeystorePath()
abstract java.lang.String	getPassword()
abstract java.lang.Integer	getSocketAndRetryTimeout()
abstract java.lang.String	getType()
abstract java.lang.String	getUsername()
ElasticsearchIO.ConnectionConfiguration	withConnectTimeout(java.lang.Integer connectTimeout) If set, overwrites the default connect timeout (1000ms) in the RequestConfig of the Elastic RestClient.
ElasticsearchIO.ConnectionConfiguration	withKeystorePassword(java.lang.String keystorePassword) If Elasticsearch uses SSL/TLS with mutual authentication (via shield), provide the password to open the client keystore.
ElasticsearchIO.ConnectionConfiguration	withKeystorePath(java.lang.String keystorePath) If Elasticsearch uses SSL/TLS with mutual authentication (via shield), provide the keystore containing the client key.
ElasticsearchIO.ConnectionConfiguration	withPassword(java.lang.String password) If Elasticsearch authentication is enabled, provide the password.
ElasticsearchIO.ConnectionConfiguration	withSocketAndRetryTimeout(java.lang.Integer socketAndRetryTimeout) If set, overwrites the default max retry timeout (30000ms) in the Elastic RestClient and the default socket timeout (30000ms) in the RequestConfig of the Elastic RestClient.
ElasticsearchIO.ConnectionConfiguration	withUsername(java.lang.String username) If Elasticsearch authentication is enabled, provide the username.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConnectionConfiguration

public ConnectionConfiguration()

Method Detail

getAddresses

public abstract java.util.List<java.lang.String> getAddresses()

getUsername

@Nullable
public abstract java.lang.String getUsername()

getPassword

@Nullable
public abstract java.lang.String getPassword()

getKeystorePath

@Nullable
public abstract java.lang.String getKeystorePath()

getKeystorePassword

@Nullable
public abstract java.lang.String getKeystorePassword()

getIndex

public abstract java.lang.String getIndex()

getType

public abstract java.lang.String getType()

getSocketAndRetryTimeout

@Nullable
public abstract java.lang.Integer getSocketAndRetryTimeout()

getConnectTimeout

@Nullable
public abstract java.lang.Integer getConnectTimeout()

create

public static ElasticsearchIO.ConnectionConfiguration create(java.lang.String[] addresses,
                                                             java.lang.String index,
                                                             java.lang.String type)

Creates a new Elasticsearch connection configuration.

Parameters:

addresses - list of addresses of Elasticsearch nodes

index - the index toward which the requests will be issued

type - the document type toward which the requests will be issued

Returns:

the connection configuration object

withUsername

public ElasticsearchIO.ConnectionConfiguration withUsername(java.lang.String username)

If Elasticsearch authentication is enabled, provide the username.

Parameters:

username - the username used to authenticate to Elasticsearch

Returns:

a ElasticsearchIO.ConnectionConfiguration describes a connection configuration to Elasticsearch.

withPassword

public ElasticsearchIO.ConnectionConfiguration withPassword(java.lang.String password)

If Elasticsearch authentication is enabled, provide the password.

Parameters:

password - the password used to authenticate to Elasticsearch

Returns:

a ElasticsearchIO.ConnectionConfiguration describes a connection configuration to Elasticsearch.

withKeystorePath

public ElasticsearchIO.ConnectionConfiguration withKeystorePath(java.lang.String keystorePath)

If Elasticsearch uses SSL/TLS with mutual authentication (via shield), provide the keystore containing the client key.

Parameters:

keystorePath - the location of the keystore containing the client key.

Returns:

a ElasticsearchIO.ConnectionConfiguration describes a connection configuration to Elasticsearch.

withKeystorePassword

public ElasticsearchIO.ConnectionConfiguration withKeystorePassword(java.lang.String keystorePassword)

If Elasticsearch uses SSL/TLS with mutual authentication (via shield), provide the password to open the client keystore.

Parameters:

keystorePassword - the password of the client keystore.

Returns:

a ElasticsearchIO.ConnectionConfiguration describes a connection configuration to Elasticsearch.

withSocketAndRetryTimeout

public ElasticsearchIO.ConnectionConfiguration withSocketAndRetryTimeout(java.lang.Integer socketAndRetryTimeout)

If set, overwrites the default max retry timeout (30000ms) in the Elastic RestClient and the default socket timeout (30000ms) in the RequestConfig of the Elastic RestClient.

Parameters:

socketAndRetryTimeout - the socket and retry timeout in millis.

Returns:

a ElasticsearchIO.ConnectionConfiguration describes a connection configuration to Elasticsearch.

withConnectTimeout

public ElasticsearchIO.ConnectionConfiguration withConnectTimeout(java.lang.Integer connectTimeout)

If set, overwrites the default connect timeout (1000ms) in the RequestConfig of the Elastic RestClient.

Parameters:

connectTimeout - the socket and retry timeout in millis.

Returns:

a ElasticsearchIO.ConnectionConfiguration describes a connection configuration to Elasticsearch.