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

Interface ConsulComponentBuilderFactory.ConsulComponentBuilder

All Superinterfaces:
ComponentBuilder<org.apache.camel.component.consul.ConsulComponent>
All Known Implementing Classes:
ConsulComponentBuilderFactory.ConsulComponentBuilderImpl
Enclosing interface:
ConsulComponentBuilderFactory
public static interface ConsulComponentBuilderFactory.ConsulComponentBuilder extends ComponentBuilder<org.apache.camel.component.consul.ConsulComponent>
Builder for the Consul component.

  • Method Details

    • connectTimeout

      default ConsulComponentBuilderFactory.ConsulComponentBuilder connectTimeout(Duration connectTimeout)
      Connect timeout for OkHttpClient. The option is a: <code>java.time.Duration</code> type. Group: common
      Parameters:
      connectTimeout - the value to set
      Returns:
      the dsl builder

    • consulClient

      default ConsulComponentBuilderFactory.ConsulComponentBuilder consulClient(com.orbitz.consul.Consul consulClient)
      Reference to a com.orbitz.consul.Consul in the registry. The option is a: <code>com.orbitz.consul.Consul</code> type. Group: common
      Parameters:
      consulClient - the value to set
      Returns:
      the dsl builder

    • key

      default ConsulComponentBuilderFactory.ConsulComponentBuilder key(String key)
      The default key. Can be overridden by CamelConsulKey. The option is a: <code>java.lang.String</code> type. Group: common
      Parameters:
      key - the value to set
      Returns:
      the dsl builder

    • pingInstance

      default ConsulComponentBuilderFactory.ConsulComponentBuilder pingInstance(boolean pingInstance)
      Configure if the AgentClient should attempt a ping before returning the Consul instance. The option is a: <code>boolean</code> type. Default: true Group: common
      Parameters:
      pingInstance - the value to set
      Returns:
      the dsl builder

    • readTimeout

      default ConsulComponentBuilderFactory.ConsulComponentBuilder readTimeout(Duration readTimeout)
      Read timeout for OkHttpClient. The option is a: <code>java.time.Duration</code> type. Group: common
      Parameters:
      readTimeout - the value to set
      Returns:
      the dsl builder

    • tags

      default ConsulComponentBuilderFactory.ConsulComponentBuilder tags(String tags)
      Set tags. You can separate multiple tags by comma. The option is a: <code>java.lang.String</code> type. Group: common
      Parameters:
      tags - the value to set
      Returns:
      the dsl builder

    • url

      default ConsulComponentBuilderFactory.ConsulComponentBuilder url(String url)
      The Consul agent URL. The option is a: <code>java.lang.String</code> type. Group: common
      Parameters:
      url - the value to set
      Returns:
      the dsl builder

    • writeTimeout

      default ConsulComponentBuilderFactory.ConsulComponentBuilder writeTimeout(Duration writeTimeout)
      Write timeout for OkHttpClient. The option is a: <code>java.time.Duration</code> type. Group: common
      Parameters:
      writeTimeout - the value to set
      Returns:
      the dsl builder

    • bridgeErrorHandler

      default ConsulComponentBuilderFactory.ConsulComponentBuilder bridgeErrorHandler(boolean bridgeErrorHandler)
      Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored. The option is a: <code>boolean</code> type. Default: false Group: consumer
      Parameters:
      bridgeErrorHandler - the value to set
      Returns:
      the dsl builder

    • action

      default ConsulComponentBuilderFactory.ConsulComponentBuilder action(String action)
      The default action. Can be overridden by CamelConsulAction. The option is a: <code>java.lang.String</code> type. Group: producer
      Parameters:
      action - the value to set
      Returns:
      the dsl builder

    • lazyStartProducer

      default ConsulComponentBuilderFactory.ConsulComponentBuilder 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

    • valueAsString

      default ConsulComponentBuilderFactory.ConsulComponentBuilder valueAsString(boolean valueAsString)
      Default to transform values retrieved from Consul i.e. on KV endpoint to string. The option is a: <code>boolean</code> type. Default: false Group: producer
      Parameters:
      valueAsString - the value to set
      Returns:
      the dsl builder

    • autowiredEnabled

      default ConsulComponentBuilderFactory.ConsulComponentBuilder 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

    • configuration

      default ConsulComponentBuilderFactory.ConsulComponentBuilder configuration(org.apache.camel.component.consul.ConsulConfiguration configuration)
      Consul configuration. The option is a: <code>org.apache.camel.component.consul.ConsulConfiguration</code> type. Group: advanced
      Parameters:
      configuration - the value to set
      Returns:
      the dsl builder

    • consistencyMode

      default ConsulComponentBuilderFactory.ConsulComponentBuilder consistencyMode(com.orbitz.consul.option.ConsistencyMode consistencyMode)
      The consistencyMode used for queries, default ConsistencyMode.DEFAULT. The option is a: <code>com.orbitz.consul.option.ConsistencyMode</code> type. Default: DEFAULT Group: advanced
      Parameters:
      consistencyMode - the value to set
      Returns:
      the dsl builder

    • datacenter

      default ConsulComponentBuilderFactory.ConsulComponentBuilder datacenter(String datacenter)
      The data center. The option is a: <code>java.lang.String</code> type. Group: advanced
      Parameters:
      datacenter - the value to set
      Returns:
      the dsl builder

    • nearNode

      default ConsulComponentBuilderFactory.ConsulComponentBuilder nearNode(String nearNode)
      The near node to use for queries. The option is a: <code>java.lang.String</code> type. Group: advanced
      Parameters:
      nearNode - the value to set
      Returns:
      the dsl builder

    • nodeMeta

      default ConsulComponentBuilderFactory.ConsulComponentBuilder nodeMeta(List<String> nodeMeta)
      The note meta-data to use for queries. The option is a: <code>java.util.List&lt;java.lang.String&gt;</code> type. Group: advanced
      Parameters:
      nodeMeta - the value to set
      Returns:
      the dsl builder

    • aclToken

      default ConsulComponentBuilderFactory.ConsulComponentBuilder aclToken(String aclToken)
      Sets the ACL token to be used with Consul. The option is a: <code>java.lang.String</code> type. Group: security
      Parameters:
      aclToken - the value to set
      Returns:
      the dsl builder

    • password

      default ConsulComponentBuilderFactory.ConsulComponentBuilder password(String password)
      Sets the password to be used for basic authentication. The option is a: <code>java.lang.String</code> type. Group: security
      Parameters:
      password - the value to set
      Returns:
      the dsl builder

    • sslContextParameters

      default ConsulComponentBuilderFactory.ConsulComponentBuilder sslContextParameters(org.apache.camel.support.jsse.SSLContextParameters sslContextParameters)
      SSL configuration using an org.apache.camel.support.jsse.SSLContextParameters instance. The option is a: <code>org.apache.camel.support.jsse.SSLContextParameters</code> type. Group: security
      Parameters:
      sslContextParameters - the value to set
      Returns:
      the dsl builder

    • useGlobalSslContextParameters

      default ConsulComponentBuilderFactory.ConsulComponentBuilder useGlobalSslContextParameters(boolean useGlobalSslContextParameters)
      Enable usage of global SSL context parameters. The option is a: <code>boolean</code> type. Default: false Group: security
      Parameters:
      useGlobalSslContextParameters - the value to set
      Returns:
      the dsl builder

    • userName

      default ConsulComponentBuilderFactory.ConsulComponentBuilder userName(String userName)
      Sets the username to be used for basic authentication. The option is a: <code>java.lang.String</code> type. Group: security
      Parameters:
      userName - the value to set
      Returns:
      the dsl builder

    • blockSeconds

      default ConsulComponentBuilderFactory.ConsulComponentBuilder blockSeconds(Integer blockSeconds)
      The second to wait for a watch event, default 10 seconds. The option is a: <code>java.lang.Integer</code> type. Default: 10 Group: watch
      Parameters:
      blockSeconds - the value to set
      Returns:
      the dsl builder

    • firstIndex

      default ConsulComponentBuilderFactory.ConsulComponentBuilder firstIndex(BigInteger firstIndex)
      The first index for watch for, default 0. The option is a: <code>java.math.BigInteger</code> type. Default: 0 Group: watch
      Parameters:
      firstIndex - the value to set
      Returns:
      the dsl builder

    • recursive

      default ConsulComponentBuilderFactory.ConsulComponentBuilder recursive(boolean recursive)
      Recursively watch, default false. The option is a: <code>boolean</code> type. Default: false Group: watch
      Parameters:
      recursive - the value to set
      Returns:
      the dsl builder