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

Interface OpensearchComponentBuilderFactory.OpensearchComponentBuilder

All Superinterfaces:
ComponentBuilder<org.apache.camel.component.opensearch.OpensearchComponent>
All Known Implementing Classes:
OpensearchComponentBuilderFactory.OpensearchComponentBuilderImpl
Enclosing interface:
OpensearchComponentBuilderFactory
public static interface OpensearchComponentBuilderFactory.OpensearchComponentBuilder extends ComponentBuilder<org.apache.camel.component.opensearch.OpensearchComponent>
Builder for the OpenSearch component.

  • Method Details

    • connectionTimeout

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

    • hostAddresses

      default OpensearchComponentBuilderFactory.OpensearchComponentBuilder 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 OpensearchComponentBuilderFactory.OpensearchComponentBuilder 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 OpensearchComponentBuilderFactory.OpensearchComponentBuilder 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 OpensearchComponentBuilderFactory.OpensearchComponentBuilder socketTimeout(int socketTimeout)
      The timeout in ms to wait before the socket will time out. The option is a: <code>int</code> type. Default: 30000 Group: producer
      Parameters:
      socketTimeout - the value to set
      Returns:
      the dsl builder

    • autowiredEnabled

      default OpensearchComponentBuilderFactory.OpensearchComponentBuilder 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 OpensearchComponentBuilderFactory.OpensearchComponentBuilder client(org.opensearch.client.RestClient client)
      To use an existing configured OpenSearch client, instead of creating a client per endpoint. This allows to customize the client with specific settings. The option is a: <code>org.opensearch.client.RestClient</code> type. Group: advanced
      Parameters:
      client - the value to set
      Returns:
      the dsl builder

    • enableSniffer

      default OpensearchComponentBuilderFactory.OpensearchComponentBuilder enableSniffer(boolean enableSniffer)
      Enable automatically discover nodes from a running OpenSearch 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 OpensearchComponentBuilderFactory.OpensearchComponentBuilder 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 OpensearchComponentBuilderFactory.OpensearchComponentBuilder 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

    • enableSSL

      default OpensearchComponentBuilderFactory.OpensearchComponentBuilder 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 OpensearchComponentBuilderFactory.OpensearchComponentBuilder 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 OpensearchComponentBuilderFactory.OpensearchComponentBuilder 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