Interface ElasticsearchEndpointBuilderFactory.ElasticsearchEndpointBuilder
- All Superinterfaces:
org.apache.camel.builder.EndpointProducerBuilder
,org.apache.camel.EndpointProducerResolver
- Enclosing interface:
ElasticsearchEndpointBuilderFactory
public static interface ElasticsearchEndpointBuilderFactory.ElasticsearchEndpointBuilder
extends org.apache.camel.builder.EndpointProducerBuilder
Builder for endpoint for the Elasticsearch component.
-
Method Summary
Modifier and TypeMethodDescriptionadvanced()
certificatePath
(String certificatePath) The certificate that can be used to access the ES Cluster.connectionTimeout
(int connectionTimeout) The time in ms to wait before connection will time out.connectionTimeout
(String connectionTimeout) The time in ms to wait before connection will time out.disconnect
(boolean disconnect) Disconnect after it finish calling the producer.disconnect
(String disconnect) Disconnect after it finish calling the producer.enableDocumentOnlyMode
(boolean enableDocumentOnlyMode) Indicates whether the body of the message contains only documents.enableDocumentOnlyMode
(String enableDocumentOnlyMode) Indicates whether the body of the message contains only documents.enableSSL
(boolean enableSSL) Enable SSL.Enable SSL.Starting index of the response.Starting index of the response.hostAddresses
(String hostAddresses) Comma separated list with ip:port formatted remote transport addresses to use.The name of the index to act against.maxRetryTimeout
(int maxRetryTimeout) The time in ms before retry.maxRetryTimeout
(String maxRetryTimeout) The time in ms before retry.What operation to perform.operation
(org.apache.camel.component.es.ElasticsearchOperation operation) What operation to perform.scrollKeepAliveMs
(int scrollKeepAliveMs) Time in ms during which elasticsearch will keep search context alive.scrollKeepAliveMs
(String scrollKeepAliveMs) Time in ms during which elasticsearch will keep search context alive.Size of the response.Size of the response.socketTimeout
(int socketTimeout) The timeout in ms to wait before the socket will time out.socketTimeout
(String socketTimeout) The timeout in ms to wait before the socket will time out.useScroll
(boolean useScroll) Enable scroll usage.Enable scroll usage.waitForActiveShards
(int waitForActiveShards) Index creation waits for the write consistency number of shards to be available.waitForActiveShards
(String waitForActiveShards) Index creation waits for the write consistency number of shards to be available.Methods inherited from interface org.apache.camel.builder.EndpointProducerBuilder
doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, getRawUri, getUri
Methods inherited from interface org.apache.camel.EndpointProducerResolver
resolve, resolve
-
Method Details
-
advanced
-
connectionTimeout
default ElasticsearchEndpointBuilderFactory.ElasticsearchEndpointBuilder connectionTimeout(int connectionTimeout) The time in ms to wait before connection will time out. The option is a:int
type. Default: 30000 Group: producer- Parameters:
connectionTimeout
- the value to set- Returns:
- the dsl builder
-
connectionTimeout
default ElasticsearchEndpointBuilderFactory.ElasticsearchEndpointBuilder connectionTimeout(String connectionTimeout) The time in ms to wait before connection will time out. The option will be converted to aint
type. Default: 30000 Group: producer- Parameters:
connectionTimeout
- the value to set- Returns:
- the dsl builder
-
disconnect
default ElasticsearchEndpointBuilderFactory.ElasticsearchEndpointBuilder disconnect(boolean disconnect) Disconnect after it finish calling the producer. The option is a:boolean
type. Default: false Group: producer- Parameters:
disconnect
- the value to set- Returns:
- the dsl builder
-
disconnect
default ElasticsearchEndpointBuilderFactory.ElasticsearchEndpointBuilder disconnect(String disconnect) Disconnect after it finish calling the producer. The option will be converted to aboolean
type. Default: false Group: producer- Parameters:
disconnect
- the value to set- Returns:
- the dsl builder
-
enableDocumentOnlyMode
default ElasticsearchEndpointBuilderFactory.ElasticsearchEndpointBuilder enableDocumentOnlyMode(boolean enableDocumentOnlyMode) Indicates whether the body of the message contains only documents. By default, it is set to false to be able to do the same requests as what the Document API supports (see https://www.elastic.co/guide/en/elasticsearch/reference/current/docs.html for more details). To ease the migration of routes based on the legacy component camel-elasticsearch-rest, you should consider enabling the mode, especially if your routes do update operations. The option is a:boolean
type. Default: false Group: producer- Parameters:
enableDocumentOnlyMode
- the value to set- Returns:
- the dsl builder
-
enableDocumentOnlyMode
default ElasticsearchEndpointBuilderFactory.ElasticsearchEndpointBuilder enableDocumentOnlyMode(String enableDocumentOnlyMode) Indicates whether the body of the message contains only documents. By default, it is set to false to be able to do the same requests as what the Document API supports (see https://www.elastic.co/guide/en/elasticsearch/reference/current/docs.html for more details). To ease the migration of routes based on the legacy component camel-elasticsearch-rest, you should consider enabling the mode, especially if your routes do update operations. The option will be converted to aboolean
type. Default: false Group: producer- Parameters:
enableDocumentOnlyMode
- the value to set- Returns:
- the dsl builder
-
from
Starting index of the response. The option is a:java.lang.Integer
type. Group: producer- Parameters:
from
- the value to set- Returns:
- the dsl builder
-
from
Starting index of the response. The option will be converted to ajava.lang.Integer
type. Group: producer- Parameters:
from
- the value to set- Returns:
- the dsl builder
-
hostAddresses
default ElasticsearchEndpointBuilderFactory.ElasticsearchEndpointBuilder hostAddresses(String hostAddresses) Comma separated list with ip:port formatted remote transport addresses to use. The option is a:java.lang.String
type. Group: producer- Parameters:
hostAddresses
- the value to set- Returns:
- the dsl builder
-
indexName
default ElasticsearchEndpointBuilderFactory.ElasticsearchEndpointBuilder indexName(String indexName) The name of the index to act against. The option is a:java.lang.String
type. Group: producer- Parameters:
indexName
- the value to set- Returns:
- the dsl builder
-
maxRetryTimeout
default ElasticsearchEndpointBuilderFactory.ElasticsearchEndpointBuilder maxRetryTimeout(int maxRetryTimeout) The time in ms before retry. The option is a:int
type. Default: 30000 Group: producer- Parameters:
maxRetryTimeout
- the value to set- Returns:
- the dsl builder
-
maxRetryTimeout
default ElasticsearchEndpointBuilderFactory.ElasticsearchEndpointBuilder maxRetryTimeout(String maxRetryTimeout) The time in ms before retry. The option will be converted to aint
type. Default: 30000 Group: producer- Parameters:
maxRetryTimeout
- the value to set- Returns:
- the dsl builder
-
operation
default ElasticsearchEndpointBuilderFactory.ElasticsearchEndpointBuilder operation(org.apache.camel.component.es.ElasticsearchOperation operation) What operation to perform. The option is a:org.apache.camel.component.es.ElasticsearchOperation
type. Group: producer- Parameters:
operation
- the value to set- Returns:
- the dsl builder
-
operation
default ElasticsearchEndpointBuilderFactory.ElasticsearchEndpointBuilder operation(String operation) What operation to perform. The option will be converted to aorg.apache.camel.component.es.ElasticsearchOperation
type. Group: producer- Parameters:
operation
- the value to set- Returns:
- the dsl builder
-
scrollKeepAliveMs
default ElasticsearchEndpointBuilderFactory.ElasticsearchEndpointBuilder scrollKeepAliveMs(int scrollKeepAliveMs) Time in ms during which elasticsearch will keep search context alive. The option is a:int
type. Default: 60000 Group: producer- Parameters:
scrollKeepAliveMs
- the value to set- Returns:
- the dsl builder
-
scrollKeepAliveMs
default ElasticsearchEndpointBuilderFactory.ElasticsearchEndpointBuilder scrollKeepAliveMs(String scrollKeepAliveMs) Time in ms during which elasticsearch will keep search context alive. The option will be converted to aint
type. Default: 60000 Group: producer- Parameters:
scrollKeepAliveMs
- the value to set- Returns:
- the dsl builder
-
size
Size of the response. The option is a:java.lang.Integer
type. Group: producer- Parameters:
size
- the value to set- Returns:
- the dsl builder
-
size
Size of the response. The option will be converted to ajava.lang.Integer
type. Group: producer- Parameters:
size
- the value to set- Returns:
- the dsl builder
-
socketTimeout
default ElasticsearchEndpointBuilderFactory.ElasticsearchEndpointBuilder socketTimeout(int socketTimeout) The timeout in ms to wait before the socket will time out. The option is a:int
type. Default: 30000 Group: producer- Parameters:
socketTimeout
- the value to set- Returns:
- the dsl builder
-
socketTimeout
default ElasticsearchEndpointBuilderFactory.ElasticsearchEndpointBuilder socketTimeout(String socketTimeout) The timeout in ms to wait before the socket will time out. The option will be converted to aint
type. Default: 30000 Group: producer- Parameters:
socketTimeout
- the value to set- Returns:
- the dsl builder
-
useScroll
default ElasticsearchEndpointBuilderFactory.ElasticsearchEndpointBuilder useScroll(boolean useScroll) Enable scroll usage. The option is a:boolean
type. Default: false Group: producer- Parameters:
useScroll
- the value to set- Returns:
- the dsl builder
-
useScroll
default ElasticsearchEndpointBuilderFactory.ElasticsearchEndpointBuilder useScroll(String useScroll) Enable scroll usage. The option will be converted to aboolean
type. Default: false Group: producer- Parameters:
useScroll
- the value to set- Returns:
- the dsl builder
-
waitForActiveShards
default ElasticsearchEndpointBuilderFactory.ElasticsearchEndpointBuilder waitForActiveShards(int waitForActiveShards) Index creation waits for the write consistency number of shards to be available. The option is a:int
type. Default: 1 Group: producer- Parameters:
waitForActiveShards
- the value to set- Returns:
- the dsl builder
-
waitForActiveShards
default ElasticsearchEndpointBuilderFactory.ElasticsearchEndpointBuilder waitForActiveShards(String waitForActiveShards) Index creation waits for the write consistency number of shards to be available. The option will be converted to aint
type. Default: 1 Group: producer- Parameters:
waitForActiveShards
- the value to set- Returns:
- the dsl builder
-
certificatePath
default ElasticsearchEndpointBuilderFactory.ElasticsearchEndpointBuilder certificatePath(String certificatePath) The certificate that can be used to access the ES Cluster. It can be loaded by default from classpath, but you can prefix with classpath:, file:, or http: to load the resource from different systems. This option can also be loaded from an existing file, by prefixing with file: or classpath: followed by the location of the file. The option is a:java.lang.String
type. Group: security- Parameters:
certificatePath
- the value to set- Returns:
- the dsl builder
-
enableSSL
default ElasticsearchEndpointBuilderFactory.ElasticsearchEndpointBuilder enableSSL(boolean enableSSL) Enable SSL. The option is a:boolean
type. Default: false Group: security- Parameters:
enableSSL
- the value to set- Returns:
- the dsl builder
-
enableSSL
default ElasticsearchEndpointBuilderFactory.ElasticsearchEndpointBuilder enableSSL(String enableSSL) Enable SSL. The option will be converted to aboolean
type. Default: false Group: security- Parameters:
enableSSL
- the value to set- Returns:
- the dsl builder
-