ElasticsearchIO.ConnectionConfiguration (Apache Beam 2.54.0)

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()

Constructors
Constructor and Description
`ConnectionConfiguration()`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`static ElasticsearchIO.ConnectionConfiguration`	`create(java.lang.String[] addresses)` Creates a new Elasticsearch connection configuration with no default index nor type.
`static ElasticsearchIO.ConnectionConfiguration`	`create(java.lang.String[] addresses, java.lang.String index)` Creates a new Elasticsearch connection configuration with no default type.
`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 @Nullable java.lang.String`	`getApiKey()`
`java.lang.String`	`getApiPrefix()` Generates the API endpoint prefix based on the set values.
`abstract @Nullable java.lang.String`	`getBearerToken()`
`java.lang.String`	`getBulkEndPoint()`
`abstract @Nullable java.lang.Integer`	`getConnectTimeout()`
`java.lang.String`	`getCountEndPoint()`
`abstract @Nullable java.util.List<Header>`	`getDefaultHeaders()`
`abstract java.lang.String`	`getIndex()`
`abstract @Nullable java.lang.String`	`getKeystorePassword()`
`abstract @Nullable java.lang.String`	`getKeystorePath()`
`abstract @Nullable java.lang.String`	`getPassword()`
`abstract @Nullable java.lang.String`	`getPathPrefix()`
`java.lang.String`	`getPrefixedEndpoint(java.lang.String endpoint)`
`java.lang.String`	`getSearchEndPoint()`
`abstract @Nullable java.lang.Integer`	`getSocketTimeout()`
`abstract @Nullable java.lang.String`	`getType()`
`abstract @Nullable java.lang.String`	`getUsername()`
`abstract boolean`	`isTrustSelfSignedCerts()`
`ElasticsearchIO.ConnectionConfiguration`	`withApiKey(java.lang.String apiKey)` If Elasticsearch authentication is enabled, provide an API key.
`ElasticsearchIO.ConnectionConfiguration`	`withBearerToken(java.lang.String bearerToken)` If Elasticsearch authentication is enabled, provide a bearer token.
`ElasticsearchIO.ConnectionConfiguration`	`withConnectTimeout(java.lang.Integer connectTimeout)` If set, overwrites the default connect timeout (1000ms) in the `RequestConfig` of the Elastic `RestClient`.
`ElasticsearchIO.ConnectionConfiguration`	`withDefaultHeaders(Header[] defaultHeaders)` For authentication or custom requirements, provide a set if default headers for the client.
`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`	`withPathPrefix(java.lang.String pathPrefix)` If Elasticsearch is not running at the root path, e.g.
`ElasticsearchIO.ConnectionConfiguration`	`withSocketTimeout(java.lang.Integer socketTimeout)` 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`	`withTrustSelfSignedCerts(boolean trustSelfSignedCerts)` If Elasticsearch uses SSL/TLS then configure whether to trust self signed certs or not.
`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
```
public abstract @Nullable java.lang.String getUsername()
```
  - getPassword
```
public abstract @Nullable java.lang.String getPassword()
```
  - getApiKey
```
public abstract @Nullable java.lang.String getApiKey()
```
  - getBearerToken
```
public abstract @Nullable java.lang.String getBearerToken()
```
  - getDefaultHeaders
```
public abstract @Nullable java.util.List<Header> getDefaultHeaders()
```
  - getKeystorePath
```
public abstract @Nullable java.lang.String getKeystorePath()
```
  - getKeystorePassword
```
public abstract @Nullable java.lang.String getKeystorePassword()
```
  - getPathPrefix
```
public abstract @Nullable java.lang.String getPathPrefix()
```
  - getIndex
```
public abstract java.lang.String getIndex()
```
  - getType
```
public abstract @Nullable java.lang.String getType()
```
  - getSocketTimeout
```
public abstract @Nullable java.lang.Integer getSocketTimeout()
```
  - getConnectTimeout
```
public abstract @Nullable java.lang.Integer getConnectTimeout()
```
  - isTrustSelfSignedCerts
```
public abstract boolean isTrustSelfSignedCerts()
```
  - 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
  - create
```
public static ElasticsearchIO.ConnectionConfiguration create(java.lang.String[] addresses,
                                                             java.lang.String index)
```
    Creates a new Elasticsearch connection configuration with no default type.
    
    Parameters:
    
    addresses - list of addresses of Elasticsearch nodes
    
    index - the index toward which the requests will be issued
    
    Returns:
    
    the connection configuration object
  - create
```
public static ElasticsearchIO.ConnectionConfiguration create(java.lang.String[] addresses)
```
    Creates a new Elasticsearch connection configuration with no default index nor type.
    
    Parameters:
    
    addresses - list of addresses of Elasticsearch nodes
    
    Returns:
    
    the connection configuration object
  - getApiPrefix
```
public java.lang.String getApiPrefix()
```
    Generates the API endpoint prefix based on the set values.
    Based on ConnectionConfiguration constructors, we know that one of the following is true:
    - index and type are non-empty strings
    - index is non-empty string, type is empty string
    - index and type are empty string
    Example valid endpoints therefore include:
    - /_bulk
    - /index_name/_bulk
    - /index_name/type_name/_bulk
  - getPrefixedEndpoint
```
public java.lang.String getPrefixedEndpoint(java.lang.String endpoint)
```
  - getBulkEndPoint
```
public java.lang.String getBulkEndPoint()
```
  - getSearchEndPoint
```
public java.lang.String getSearchEndPoint()
```
  - getCountEndPoint
```
public java.lang.String getCountEndPoint()
```
  - 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.
  - withPathPrefix
```
public ElasticsearchIO.ConnectionConfiguration withPathPrefix(java.lang.String pathPrefix)
```
    If Elasticsearch is not running at the root path, e.g. 'host:9200/path/to/index', specify path prefix 'path/to'.
    
    Parameters:
    
    pathPrefix - the path prefix used in Elasticsearch instance.
    
    Returns:
    
    a ElasticsearchIO.ConnectionConfiguration describes a connection configuration to Elasticsearch.
  - withApiKey
```
public ElasticsearchIO.ConnectionConfiguration withApiKey(java.lang.String apiKey)
```
    If Elasticsearch authentication is enabled, provide an API key. Be aware that you can only use one of , withBearerToken() and withDefaultHeaders at the same time, as they (potentially) use the same header.
    
    Parameters:
    
    apiKey - the API key used to authenticate to Elasticsearch
    
    Returns:
    
    a ElasticsearchIO.ConnectionConfiguration describes a connection configuration to Elasticsearch.
  - withBearerToken
```
public ElasticsearchIO.ConnectionConfiguration withBearerToken(java.lang.String bearerToken)
```
    If Elasticsearch authentication is enabled, provide a bearer token. Be aware that you can only use one of , withBearerToken() and withDefaultHeaders at the same time, as they (potentially) use the same header.
    
    Parameters:
    
    bearerToken - the bearer token used to authenticate to Elasticsearch
    
    Returns:
    
    a ElasticsearchIO.ConnectionConfiguration describes a connection configuration to Elasticsearch.
  - withDefaultHeaders
```
public ElasticsearchIO.ConnectionConfiguration withDefaultHeaders(Header[] defaultHeaders)
```
    For authentication or custom requirements, provide a set if default headers for the client. Be aware that you can only use one of withApiToken(), withBearerToken() and withDefaultHeaders at the same time, as they (potentially) use the same header.
    An example of where this could be useful is if the client needs to use short-lived credentials that need to be renewed on a certain interval. To implement that, a user could implement a custom header that tracks the renewal period, for example:
```
 {@code class OAuthTokenHeader extends BasicHeader {
     OAuthToken accessToken;

     ...
```
    Parameters:
    
    defaultHeaders - the headers to add to outgoing requests
    
    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.
  - withTrustSelfSignedCerts
```
public ElasticsearchIO.ConnectionConfiguration withTrustSelfSignedCerts(boolean trustSelfSignedCerts)
```
    If Elasticsearch uses SSL/TLS then configure whether to trust self signed certs or not. The default is false.
    
    Parameters:
    
    trustSelfSignedCerts - Whether to trust self signed certs
    
    Returns:
    
    a ElasticsearchIO.ConnectionConfiguration describes a connection configuration to Elasticsearch.
  - withSocketTimeout
```
public ElasticsearchIO.ConnectionConfiguration withSocketTimeout(java.lang.Integer socketTimeout)
```
    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:
    
    socketTimeout - 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.

Class ElasticsearchIO.ConnectionConfiguration

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ConnectionConfiguration

Method Detail

getAddresses

getUsername

getPassword

getApiKey

getBearerToken

getDefaultHeaders

getKeystorePath

getKeystorePassword

getPathPrefix

getIndex

getType

getSocketTimeout

getConnectTimeout

isTrustSelfSignedCerts

create

create

create

getApiPrefix

getPrefixedEndpoint

getBulkEndPoint

getSearchEndPoint

getCountEndPoint

withUsername

withPassword

withPathPrefix

withApiKey

withBearerToken

withDefaultHeaders

withKeystorePath

withKeystorePassword

withTrustSelfSignedCerts

withSocketTimeout

withConnectTimeout