Package org.apache.camel.builder.endpoint.dsl

Interface SplunkEndpointBuilderFactory.SplunkEndpointConsumerBuilder

  • All Superinterfaces:
    org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver
    All Known Subinterfaces:
    SplunkEndpointBuilderFactory.SplunkEndpointBuilder
    Enclosing interface:
    SplunkEndpointBuilderFactory
    public static interface SplunkEndpointBuilderFactory.SplunkEndpointConsumerBuilder
extends org.apache.camel.builder.EndpointConsumerBuilder
    Builder for endpoint consumers for the Splunk component.

    • Method Detail

      • connectionTimeout

        default SplunkEndpointBuilderFactory.SplunkEndpointConsumerBuilder connectionTimeout​(int connectionTimeout)
        Timeout in MS when connecting to Splunk server. The option is a: <code>int</code> type. Default: 5000 Group: common
        Parameters:
        connectionTimeout - the value to set
        Returns:
        the dsl builder

      • connectionTimeout

        default SplunkEndpointBuilderFactory.SplunkEndpointConsumerBuilder connectionTimeout​(String connectionTimeout)
        Timeout in MS when connecting to Splunk server. The option will be converted to a <code>int</code> type. Default: 5000 Group: common
        Parameters:
        connectionTimeout - the value to set
        Returns:
        the dsl builder

      • sendEmptyMessageWhenIdle

        default SplunkEndpointBuilderFactory.SplunkEndpointConsumerBuilder sendEmptyMessageWhenIdle​(boolean sendEmptyMessageWhenIdle)
        If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead. The option is a: <code>boolean</code> type. Default: false Group: consumer
        Parameters:
        sendEmptyMessageWhenIdle - the value to set
        Returns:
        the dsl builder

      • sendEmptyMessageWhenIdle

        default SplunkEndpointBuilderFactory.SplunkEndpointConsumerBuilder sendEmptyMessageWhenIdle​(String sendEmptyMessageWhenIdle)
        If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead. The option will be converted to a <code>boolean</code> type. Default: false Group: consumer
        Parameters:
        sendEmptyMessageWhenIdle - the value to set
        Returns:
        the dsl builder

      • streaming

        default SplunkEndpointBuilderFactory.SplunkEndpointConsumerBuilder streaming​(boolean streaming)
        Sets streaming mode. Streaming mode sends exchanges as they are received, rather than in a batch. The option is a: <code>boolean</code> type. Default: false Group: consumer
        Parameters:
        streaming - the value to set
        Returns:
        the dsl builder

      • streaming

        default SplunkEndpointBuilderFactory.SplunkEndpointConsumerBuilder streaming​(String streaming)
        Sets streaming mode. Streaming mode sends exchanges as they are received, rather than in a batch. The option will be converted to a <code>boolean</code> type. Default: false Group: consumer
        Parameters:
        streaming - the value to set
        Returns:
        the dsl builder

      • backoffErrorThreshold

        default SplunkEndpointBuilderFactory.SplunkEndpointConsumerBuilder backoffErrorThreshold​(int backoffErrorThreshold)
        The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. The option is a: <code>int</code> type. Group: scheduler
        Parameters:
        backoffErrorThreshold - the value to set
        Returns:
        the dsl builder

      • backoffErrorThreshold

        default SplunkEndpointBuilderFactory.SplunkEndpointConsumerBuilder backoffErrorThreshold​(String backoffErrorThreshold)
        The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. The option will be converted to a <code>int</code> type. Group: scheduler
        Parameters:
        backoffErrorThreshold - the value to set
        Returns:
        the dsl builder

      • backoffIdleThreshold

        default SplunkEndpointBuilderFactory.SplunkEndpointConsumerBuilder backoffIdleThreshold​(int backoffIdleThreshold)
        The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. The option is a: <code>int</code> type. Group: scheduler
        Parameters:
        backoffIdleThreshold - the value to set
        Returns:
        the dsl builder

      • backoffIdleThreshold

        default SplunkEndpointBuilderFactory.SplunkEndpointConsumerBuilder backoffIdleThreshold​(String backoffIdleThreshold)
        The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. The option will be converted to a <code>int</code> type. Group: scheduler
        Parameters:
        backoffIdleThreshold - the value to set
        Returns:
        the dsl builder

      • backoffMultiplier

        default SplunkEndpointBuilderFactory.SplunkEndpointConsumerBuilder backoffMultiplier​(int backoffMultiplier)
        To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. The option is a: <code>int</code> type. Group: scheduler
        Parameters:
        backoffMultiplier - the value to set
        Returns:
        the dsl builder

      • backoffMultiplier

        default SplunkEndpointBuilderFactory.SplunkEndpointConsumerBuilder backoffMultiplier​(String backoffMultiplier)
        To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. The option will be converted to a <code>int</code> type. Group: scheduler
        Parameters:
        backoffMultiplier - the value to set
        Returns:
        the dsl builder

      • greedy

        default SplunkEndpointBuilderFactory.SplunkEndpointConsumerBuilder greedy​(boolean greedy)
        If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages. The option is a: <code>boolean</code> type. Default: false Group: scheduler
        Parameters:
        greedy - the value to set
        Returns:
        the dsl builder

      • greedy

        default SplunkEndpointBuilderFactory.SplunkEndpointConsumerBuilder greedy​(String greedy)
        If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages. The option will be converted to a <code>boolean</code> type. Default: false Group: scheduler
        Parameters:
        greedy - the value to set
        Returns:
        the dsl builder

      • initialDelay

        default SplunkEndpointBuilderFactory.SplunkEndpointConsumerBuilder initialDelay​(long initialDelay)
        Milliseconds before the first poll starts. The option is a: <code>long</code> type. Default: 1000 Group: scheduler
        Parameters:
        initialDelay - the value to set
        Returns:
        the dsl builder

      • initialDelay

        default SplunkEndpointBuilderFactory.SplunkEndpointConsumerBuilder initialDelay​(String initialDelay)
        Milliseconds before the first poll starts. The option will be converted to a <code>long</code> type. Default: 1000 Group: scheduler
        Parameters:
        initialDelay - the value to set
        Returns:
        the dsl builder

      • repeatCount

        default SplunkEndpointBuilderFactory.SplunkEndpointConsumerBuilder repeatCount​(long repeatCount)
        Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever. The option is a: <code>long</code> type. Default: 0 Group: scheduler
        Parameters:
        repeatCount - the value to set
        Returns:
        the dsl builder

      • repeatCount

        default SplunkEndpointBuilderFactory.SplunkEndpointConsumerBuilder repeatCount​(String repeatCount)
        Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever. The option will be converted to a <code>long</code> type. Default: 0 Group: scheduler
        Parameters:
        repeatCount - the value to set
        Returns:
        the dsl builder

      • runLoggingLevel

        default SplunkEndpointBuilderFactory.SplunkEndpointConsumerBuilder runLoggingLevel​(org.apache.camel.LoggingLevel runLoggingLevel)
        The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. The option is a: <code>org.apache.camel.LoggingLevel</code> type. Default: TRACE Group: scheduler
        Parameters:
        runLoggingLevel - the value to set
        Returns:
        the dsl builder

      • runLoggingLevel

        default SplunkEndpointBuilderFactory.SplunkEndpointConsumerBuilder runLoggingLevel​(String runLoggingLevel)
        The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. The option will be converted to a <code>org.apache.camel.LoggingLevel</code> type. Default: TRACE Group: scheduler
        Parameters:
        runLoggingLevel - the value to set
        Returns:
        the dsl builder

      • scheduledExecutorService

        default SplunkEndpointBuilderFactory.SplunkEndpointConsumerBuilder scheduledExecutorService​(ScheduledExecutorService scheduledExecutorService)
        Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. The option is a: <code>java.util.concurrent.ScheduledExecutorService</code> type. Group: scheduler
        Parameters:
        scheduledExecutorService - the value to set
        Returns:
        the dsl builder

      • scheduledExecutorService

        default SplunkEndpointBuilderFactory.SplunkEndpointConsumerBuilder scheduledExecutorService​(String scheduledExecutorService)
        Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. The option will be converted to a <code>java.util.concurrent.ScheduledExecutorService</code> type. Group: scheduler
        Parameters:
        scheduledExecutorService - the value to set
        Returns:
        the dsl builder

      • scheduler

        default SplunkEndpointBuilderFactory.SplunkEndpointConsumerBuilder scheduler​(Object scheduler)
        To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler. The option is a: <code>java.lang.Object</code> type. Default: none Group: scheduler
        Parameters:
        scheduler - the value to set
        Returns:
        the dsl builder

      • scheduler

        default SplunkEndpointBuilderFactory.SplunkEndpointConsumerBuilder scheduler​(String scheduler)
        To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler. The option will be converted to a <code>java.lang.Object</code> type. Default: none Group: scheduler
        Parameters:
        scheduler - the value to set
        Returns:
        the dsl builder

      • schedulerProperties

        default SplunkEndpointBuilderFactory.SplunkEndpointConsumerBuilder schedulerProperties​(String key,
                                                                                       Object value)
        To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler. The option is a: <code>java.util.Map&lt;java.lang.String, java.lang.Object&gt;</code> type. The option is multivalued, and you can use the schedulerProperties(String, Object) method to add a value (call the method multiple times to set more values). Group: scheduler
        Parameters:
        key - the option key
        value - the option value
        Returns:
        the dsl builder

      • schedulerProperties

        default SplunkEndpointBuilderFactory.SplunkEndpointConsumerBuilder schedulerProperties​(Map values)
        To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler. The option is a: <code>java.util.Map&lt;java.lang.String, java.lang.Object&gt;</code> type. The option is multivalued, and you can use the schedulerProperties(String, Object) method to add a value (call the method multiple times to set more values). Group: scheduler
        Parameters:
        values - the values
        Returns:
        the dsl builder

      • startScheduler

        default SplunkEndpointBuilderFactory.SplunkEndpointConsumerBuilder startScheduler​(boolean startScheduler)
        Whether the scheduler should be auto started. The option is a: <code>boolean</code> type. Default: true Group: scheduler
        Parameters:
        startScheduler - the value to set
        Returns:
        the dsl builder

      • startScheduler

        default SplunkEndpointBuilderFactory.SplunkEndpointConsumerBuilder startScheduler​(String startScheduler)
        Whether the scheduler should be auto started. The option will be converted to a <code>boolean</code> type. Default: true Group: scheduler
        Parameters:
        startScheduler - the value to set
        Returns:
        the dsl builder

      • timeUnit

        default SplunkEndpointBuilderFactory.SplunkEndpointConsumerBuilder timeUnit​(String timeUnit)
        Time unit for initialDelay and delay options. The option will be converted to a <code>java.util.concurrent.TimeUnit</code> type. Default: MILLISECONDS Group: scheduler
        Parameters:
        timeUnit - the value to set
        Returns:
        the dsl builder

      • useFixedDelay

        default SplunkEndpointBuilderFactory.SplunkEndpointConsumerBuilder useFixedDelay​(boolean useFixedDelay)
        Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. The option is a: <code>boolean</code> type. Default: true Group: scheduler
        Parameters:
        useFixedDelay - the value to set
        Returns:
        the dsl builder

      • useFixedDelay

        default SplunkEndpointBuilderFactory.SplunkEndpointConsumerBuilder useFixedDelay​(String useFixedDelay)
        Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. The option will be converted to a <code>boolean</code> type. Default: true Group: scheduler
        Parameters:
        useFixedDelay - the value to set
        Returns:
        the dsl builder

      • sslProtocol

        default SplunkEndpointBuilderFactory.SplunkEndpointConsumerBuilder sslProtocol​(com.splunk.SSLSecurityProtocol sslProtocol)
        Set the ssl protocol to use. The option is a: <code>com.splunk.SSLSecurityProtocol</code> type. Default: TLSv1.2 Group: security
        Parameters:
        sslProtocol - the value to set
        Returns:
        the dsl builder

      • sslProtocol

        default SplunkEndpointBuilderFactory.SplunkEndpointConsumerBuilder sslProtocol​(String sslProtocol)
        Set the ssl protocol to use. The option will be converted to a <code>com.splunk.SSLSecurityProtocol</code> type. Default: TLSv1.2 Group: security
        Parameters:
        sslProtocol - the value to set
        Returns:
        the dsl builder

      • useSunHttpsHandler

        default SplunkEndpointBuilderFactory.SplunkEndpointConsumerBuilder useSunHttpsHandler​(boolean useSunHttpsHandler)
        Use sun.net.www.protocol.https.Handler Https handler to establish the Splunk Connection. Can be useful when running in application servers to avoid app. server https handling. The option is a: <code>boolean</code> type. Default: false Group: security
        Parameters:
        useSunHttpsHandler - the value to set
        Returns:
        the dsl builder

      • useSunHttpsHandler

        default SplunkEndpointBuilderFactory.SplunkEndpointConsumerBuilder useSunHttpsHandler​(String useSunHttpsHandler)
        Use sun.net.www.protocol.https.Handler Https handler to establish the Splunk Connection. Can be useful when running in application servers to avoid app. server https handling. The option will be converted to a <code>boolean</code> type. Default: false Group: security
        Parameters:
        useSunHttpsHandler - the value to set
        Returns:
        the dsl builder