Package org.apache.camel.builder.component.dsl

Interface ElasticsearchComponentBuilderFactory.ElasticsearchComponentBuilder

All Superinterfaces:
ComponentBuilder<org.apache.camel.component.es.ElasticsearchComponent>
All Known Implementing Classes:
ElasticsearchComponentBuilderFactory.ElasticsearchComponentBuilderImpl
Enclosing interface:
ElasticsearchComponentBuilderFactory
public static interface ElasticsearchComponentBuilderFactory.ElasticsearchComponentBuilder extends ComponentBuilder<org.apache.camel.component.es.ElasticsearchComponent>
Builder for the Elasticsearch component.

  • Method Details

    • connectionTimeout

      default ElasticsearchComponentBuilderFactory.ElasticsearchComponentBuilder connectionTimeout(int connectionTimeout)
      The time in ms to wait before connection will timeout. The option is a: <code>int</code> type. Default: 30000 Group: producer
      Parameters:
      connectionTimeout - the value to set
      Returns:
      the dsl builder

    • enableDocumentOnlyMode

      default ElasticsearchComponentBuilderFactory.ElasticsearchComponentBuilder 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: <code>boolean</code> type. Default: false Group: producer
      Parameters:
      enableDocumentOnlyMode - the value to set
      Returns:
      the dsl builder

    • hostAddresses

      default ElasticsearchComponentBuilderFactory.ElasticsearchComponentBuilder hostAddresses(String hostAddresses)
      Comma separated list with ip:port formatted remote transport addresses to use. The ip and port options must be left blank for hostAddresses to be considered instead. The option is a: <code>java.lang.String</code> type. Group: producer
      Parameters:
      hostAddresses - the value to set
      Returns:
      the dsl builder

    • lazyStartProducer

      default ElasticsearchComponentBuilderFactory.ElasticsearchComponentBuilder lazyStartProducer(boolean lazyStartProducer)
      Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. The option is a: <code>boolean</code> type. Default: false Group: producer
      Parameters:
      lazyStartProducer - the value to set
      Returns:
      the dsl builder

    • maxRetryTimeout

      default ElasticsearchComponentBuilderFactory.ElasticsearchComponentBuilder maxRetryTimeout(int maxRetryTimeout)
      The time in ms before retry. The option is a: <code>int</code> type. Default: 30000 Group: producer
      Parameters:
      maxRetryTimeout - the value to set
      Returns:
      the dsl builder

    • socketTimeout

      default ElasticsearchComponentBuilderFactory.ElasticsearchComponentBuilder socketTimeout(int socketTimeout)
      The timeout in ms to wait before the socket will timeout. The option is a: <code>int</code> type. Default: 30000 Group: producer
      Parameters:
      socketTimeout - the value to set
      Returns:
      the dsl builder

    • autowiredEnabled

      default ElasticsearchComponentBuilderFactory.ElasticsearchComponentBuilder autowiredEnabled(boolean autowiredEnabled)
      Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc. The option is a: <code>boolean</code> type. Default: true Group: advanced
      Parameters:
      autowiredEnabled - the value to set
      Returns:
      the dsl builder

    • client

      default ElasticsearchComponentBuilderFactory.ElasticsearchComponentBuilder client(org.elasticsearch.client.RestClient client)
      To use an existing configured Elasticsearch client, instead of creating a client per endpoint. This allow to customize the client with specific settings. The option is a: <code>org.elasticsearch.client.RestClient</code> type. Group: advanced
      Parameters:
      client - the value to set
      Returns:
      the dsl builder

    • enableSniffer

      default ElasticsearchComponentBuilderFactory.ElasticsearchComponentBuilder enableSniffer(boolean enableSniffer)
      Enable automatically discover nodes from a running Elasticsearch cluster. If this option is used in conjunction with Spring Boot then it's managed by the Spring Boot configuration (see: Disable Sniffer in Spring Boot). The option is a: <code>boolean</code> type. Default: false Group: advanced
      Parameters:
      enableSniffer - the value to set
      Returns:
      the dsl builder

    • sniffAfterFailureDelay

      default ElasticsearchComponentBuilderFactory.ElasticsearchComponentBuilder sniffAfterFailureDelay(int sniffAfterFailureDelay)
      The delay of a sniff execution scheduled after a failure (in milliseconds). The option is a: <code>int</code> type. Default: 60000 Group: advanced
      Parameters:
      sniffAfterFailureDelay - the value to set
      Returns:
      the dsl builder

    • snifferInterval

      default ElasticsearchComponentBuilderFactory.ElasticsearchComponentBuilder snifferInterval(int snifferInterval)
      The interval between consecutive ordinary sniff executions in milliseconds. Will be honoured when sniffOnFailure is disabled or when there are no failures between consecutive sniff executions. The option is a: <code>int</code> type. Default: 300000 Group: advanced
      Parameters:
      snifferInterval - the value to set
      Returns:
      the dsl builder

    • certificatePath

      default ElasticsearchComponentBuilderFactory.ElasticsearchComponentBuilder certificatePath(String certificatePath)
      The path of the self-signed certificate to use to access to Elasticsearch. The option is a: <code>java.lang.String</code> type. Group: security
      Parameters:
      certificatePath - the value to set
      Returns:
      the dsl builder

    • enableSSL

      default ElasticsearchComponentBuilderFactory.ElasticsearchComponentBuilder enableSSL(boolean enableSSL)
      Enable SSL. The option is a: <code>boolean</code> type. Default: false Group: security
      Parameters:
      enableSSL - the value to set
      Returns:
      the dsl builder

    • password

      default ElasticsearchComponentBuilderFactory.ElasticsearchComponentBuilder password(String password)
      Password for authenticate. The option is a: <code>java.lang.String</code> type. Group: security
      Parameters:
      password - the value to set
      Returns:
      the dsl builder

    • user

      default ElasticsearchComponentBuilderFactory.ElasticsearchComponentBuilder user(String user)
      Basic authenticate user. The option is a: <code>java.lang.String</code> type. Group: security
      Parameters:
      user - the value to set
      Returns:
      the dsl builder