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

Interface TimerEndpointBuilderFactory.TimerEndpointBuilder

All Superinterfaces:
org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver
Enclosing interface:
TimerEndpointBuilderFactory
public static interface TimerEndpointBuilderFactory.TimerEndpointBuilder extends org.apache.camel.builder.EndpointConsumerBuilder
Builder for endpoint for the Timer component.

  • Method Details

    • advanced

      default TimerEndpointBuilderFactory.AdvancedTimerEndpointBuilder advanced()

    • delay

      default TimerEndpointBuilderFactory.TimerEndpointBuilder delay(long delay)
      The number of milliseconds to wait before the first event is generated. Should not be used in conjunction with the time option. The default value is 1000. The option is a: long type. Default: 1000 Group: consumer
      Parameters:
      delay - the value to set
      Returns:
      the dsl builder

    • delay

      default TimerEndpointBuilderFactory.TimerEndpointBuilder delay(String delay)
      The number of milliseconds to wait before the first event is generated. Should not be used in conjunction with the time option. The default value is 1000. The option will be converted to a long type. Default: 1000 Group: consumer
      Parameters:
      delay - the value to set
      Returns:
      the dsl builder

    • fixedRate

      default TimerEndpointBuilderFactory.TimerEndpointBuilder fixedRate(boolean fixedRate)
      Events take place at approximately regular intervals, separated by the specified period. The option is a: boolean type. Default: false Group: consumer
      Parameters:
      fixedRate - the value to set
      Returns:
      the dsl builder

    • fixedRate

      default TimerEndpointBuilderFactory.TimerEndpointBuilder fixedRate(String fixedRate)
      Events take place at approximately regular intervals, separated by the specified period. The option will be converted to a boolean type. Default: false Group: consumer
      Parameters:
      fixedRate - the value to set
      Returns:
      the dsl builder

    • includeMetadata

      default TimerEndpointBuilderFactory.TimerEndpointBuilder includeMetadata(boolean includeMetadata)
      Whether to include metadata in the exchange such as fired time, timer name, timer count etc. The option is a: boolean type. Default: false Group: consumer
      Parameters:
      includeMetadata - the value to set
      Returns:
      the dsl builder

    • includeMetadata

      default TimerEndpointBuilderFactory.TimerEndpointBuilder includeMetadata(String includeMetadata)
      Whether to include metadata in the exchange such as fired time, timer name, timer count etc. The option will be converted to a boolean type. Default: false Group: consumer
      Parameters:
      includeMetadata - the value to set
      Returns:
      the dsl builder

    • period

      default TimerEndpointBuilderFactory.TimerEndpointBuilder period(long period)
      Generate periodic events every period. Must be zero or positive value. The default value is 1000. The option is a: long type. Default: 1000 Group: consumer
      Parameters:
      period - the value to set
      Returns:
      the dsl builder

    • period

      default TimerEndpointBuilderFactory.TimerEndpointBuilder period(String period)
      Generate periodic events every period. Must be zero or positive value. The default value is 1000. The option will be converted to a long type. Default: 1000 Group: consumer
      Parameters:
      period - the value to set
      Returns:
      the dsl builder

    • repeatCount

      default TimerEndpointBuilderFactory.TimerEndpointBuilder repeatCount(long repeatCount)
      Specifies a maximum limit for the number of fires. Therefore, if you set it to 1, the timer 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: long type. Group: consumer
      Parameters:
      repeatCount - the value to set
      Returns:
      the dsl builder

    • repeatCount

      default TimerEndpointBuilderFactory.TimerEndpointBuilder repeatCount(String repeatCount)
      Specifies a maximum limit for the number of fires. Therefore, if you set it to 1, the timer 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 long type. Group: consumer
      Parameters:
      repeatCount - the value to set
      Returns:
      the dsl builder

    • runLoggingLevel

      default TimerEndpointBuilderFactory.TimerEndpointBuilder 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: org.apache.camel.LoggingLevel type. Default: TRACE Group: scheduler
      Parameters:
      runLoggingLevel - the value to set
      Returns:
      the dsl builder

    • runLoggingLevel

      default TimerEndpointBuilderFactory.TimerEndpointBuilder 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 org.apache.camel.LoggingLevel type. Default: TRACE Group: scheduler
      Parameters:
      runLoggingLevel - the value to set
      Returns:
      the dsl builder