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

Interface JiraEndpointBuilderFactory.JiraEndpointConsumerBuilder

All Superinterfaces:
org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver
All Known Subinterfaces:
JiraEndpointBuilderFactory.JiraEndpointBuilder
Enclosing interface:
JiraEndpointBuilderFactory
public static interface JiraEndpointBuilderFactory.JiraEndpointConsumerBuilder extends org.apache.camel.builder.EndpointConsumerBuilder
Builder for endpoint consumers for the Jira component.

  • Method Details

    • advanced

      default JiraEndpointBuilderFactory.AdvancedJiraEndpointConsumerBuilder advanced()

    • delay

      default JiraEndpointBuilderFactory.JiraEndpointConsumerBuilder delay(Integer delay)
      Time in milliseconds to elapse for the next poll. The option is a: java.lang.Integer type. Default: 6000 Group: common
      Parameters:
      delay - the value to set
      Returns:
      the dsl builder

    • delay

      default JiraEndpointBuilderFactory.JiraEndpointConsumerBuilder delay(String delay)
      Time in milliseconds to elapse for the next poll. The option will be converted to a java.lang.Integer type. Default: 6000 Group: common
      Parameters:
      delay - the value to set
      Returns:
      the dsl builder

    • jiraUrl

      default JiraEndpointBuilderFactory.JiraEndpointConsumerBuilder jiraUrl(String jiraUrl)
      The Jira server url, for example http://my_jira.com:8081. The option is a: java.lang.String type. Required: true Group: common
      Parameters:
      jiraUrl - the value to set
      Returns:
      the dsl builder

    • jql

      default JiraEndpointBuilderFactory.JiraEndpointConsumerBuilder jql(String jql)
      JQL is the query language from JIRA which allows you to retrieve the data you want. For example jql=project=MyProject Where MyProject is the product key in Jira. It is important to use the RAW() and set the JQL inside it to prevent camel parsing it, example: RAW(project in (MYP, COM) AND resolution = Unresolved). The option is a: java.lang.String type. Group: consumer
      Parameters:
      jql - the value to set
      Returns:
      the dsl builder

    • maxResults

      default JiraEndpointBuilderFactory.JiraEndpointConsumerBuilder maxResults(Integer maxResults)
      Max number of issues to search for. The option is a: java.lang.Integer type. Default: 50 Group: consumer
      Parameters:
      maxResults - the value to set
      Returns:
      the dsl builder

    • maxResults

      default JiraEndpointBuilderFactory.JiraEndpointConsumerBuilder maxResults(String maxResults)
      Max number of issues to search for. The option will be converted to a java.lang.Integer type. Default: 50 Group: consumer
      Parameters:
      maxResults - the value to set
      Returns:
      the dsl builder

    • sendEmptyMessageWhenIdle

      default JiraEndpointBuilderFactory.JiraEndpointConsumerBuilder 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: boolean type. Default: false Group: consumer
      Parameters:
      sendEmptyMessageWhenIdle - the value to set
      Returns:
      the dsl builder

    • sendEmptyMessageWhenIdle

      default JiraEndpointBuilderFactory.JiraEndpointConsumerBuilder 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 boolean type. Default: false Group: consumer
      Parameters:
      sendEmptyMessageWhenIdle - the value to set
      Returns:
      the dsl builder

    • sendOnlyUpdatedField

      default JiraEndpointBuilderFactory.JiraEndpointConsumerBuilder sendOnlyUpdatedField(boolean sendOnlyUpdatedField)
      Indicator for sending only changed fields in exchange body or issue object. By default consumer sends only changed fields. The option is a: boolean type. Default: true Group: consumer
      Parameters:
      sendOnlyUpdatedField - the value to set
      Returns:
      the dsl builder

    • sendOnlyUpdatedField

      default JiraEndpointBuilderFactory.JiraEndpointConsumerBuilder sendOnlyUpdatedField(String sendOnlyUpdatedField)
      Indicator for sending only changed fields in exchange body or issue object. By default consumer sends only changed fields. The option will be converted to a boolean type. Default: true Group: consumer
      Parameters:
      sendOnlyUpdatedField - the value to set
      Returns:
      the dsl builder

    • watchedFields

      default JiraEndpointBuilderFactory.JiraEndpointConsumerBuilder watchedFields(String watchedFields)
      Comma separated list of fields to watch for changes. Status,Priority are the defaults. The option is a: java.lang.String type. Default: Status,Priority Group: consumer
      Parameters:
      watchedFields - the value to set
      Returns:
      the dsl builder

    • backoffErrorThreshold

      default JiraEndpointBuilderFactory.JiraEndpointConsumerBuilder 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: int type. Group: scheduler
      Parameters:
      backoffErrorThreshold - the value to set
      Returns:
      the dsl builder

    • backoffErrorThreshold

      default JiraEndpointBuilderFactory.JiraEndpointConsumerBuilder 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 int type. Group: scheduler
      Parameters:
      backoffErrorThreshold - the value to set
      Returns:
      the dsl builder

    • backoffIdleThreshold

      default JiraEndpointBuilderFactory.JiraEndpointConsumerBuilder backoffIdleThreshold(int backoffIdleThreshold)
      The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. The option is a: int type. Group: scheduler
      Parameters:
      backoffIdleThreshold - the value to set
      Returns:
      the dsl builder

    • backoffIdleThreshold

      default JiraEndpointBuilderFactory.JiraEndpointConsumerBuilder 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 int type. Group: scheduler
      Parameters:
      backoffIdleThreshold - the value to set
      Returns:
      the dsl builder

    • backoffMultiplier

      default JiraEndpointBuilderFactory.JiraEndpointConsumerBuilder 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: int type. Group: scheduler
      Parameters:
      backoffMultiplier - the value to set
      Returns:
      the dsl builder

    • backoffMultiplier

      default JiraEndpointBuilderFactory.JiraEndpointConsumerBuilder 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 int type. Group: scheduler
      Parameters:
      backoffMultiplier - the value to set
      Returns:
      the dsl builder

    • greedy

      default JiraEndpointBuilderFactory.JiraEndpointConsumerBuilder 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: boolean type. Default: false Group: scheduler
      Parameters:
      greedy - the value to set
      Returns:
      the dsl builder

    • greedy

      default JiraEndpointBuilderFactory.JiraEndpointConsumerBuilder 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 boolean type. Default: false Group: scheduler
      Parameters:
      greedy - the value to set
      Returns:
      the dsl builder

    • initialDelay

      default JiraEndpointBuilderFactory.JiraEndpointConsumerBuilder initialDelay(long initialDelay)
      Milliseconds before the first poll starts. The option is a: long type. Default: 1000 Group: scheduler
      Parameters:
      initialDelay - the value to set
      Returns:
      the dsl builder

    • initialDelay

      default JiraEndpointBuilderFactory.JiraEndpointConsumerBuilder initialDelay(String initialDelay)
      Milliseconds before the first poll starts. The option will be converted to a long type. Default: 1000 Group: scheduler
      Parameters:
      initialDelay - the value to set
      Returns:
      the dsl builder

    • repeatCount

      default JiraEndpointBuilderFactory.JiraEndpointConsumerBuilder 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: long type. Default: 0 Group: scheduler
      Parameters:
      repeatCount - the value to set
      Returns:
      the dsl builder

    • repeatCount

      default JiraEndpointBuilderFactory.JiraEndpointConsumerBuilder 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 long type. Default: 0 Group: scheduler
      Parameters:
      repeatCount - the value to set
      Returns:
      the dsl builder

    • runLoggingLevel

      default JiraEndpointBuilderFactory.JiraEndpointConsumerBuilder 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 JiraEndpointBuilderFactory.JiraEndpointConsumerBuilder 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

    • scheduledExecutorService

      default JiraEndpointBuilderFactory.JiraEndpointConsumerBuilder 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: java.util.concurrent.ScheduledExecutorService type. Group: scheduler
      Parameters:
      scheduledExecutorService - the value to set
      Returns:
      the dsl builder

    • scheduledExecutorService

      default JiraEndpointBuilderFactory.JiraEndpointConsumerBuilder 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 java.util.concurrent.ScheduledExecutorService type. Group: scheduler
      Parameters:
      scheduledExecutorService - the value to set
      Returns:
      the dsl builder

    • scheduler

      default JiraEndpointBuilderFactory.JiraEndpointConsumerBuilder 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: java.lang.Object type. Default: none Group: scheduler
      Parameters:
      scheduler - the value to set
      Returns:
      the dsl builder

    • scheduler

      default JiraEndpointBuilderFactory.JiraEndpointConsumerBuilder 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 java.lang.Object type. Default: none Group: scheduler
      Parameters:
      scheduler - the value to set
      Returns:
      the dsl builder

    • schedulerProperties

      default JiraEndpointBuilderFactory.JiraEndpointConsumerBuilder 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: java.util.Map<java.lang.String, java.lang.Object> 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 JiraEndpointBuilderFactory.JiraEndpointConsumerBuilder schedulerProperties(Map values)
      To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler. The option is a: java.util.Map<java.lang.String, java.lang.Object> 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 JiraEndpointBuilderFactory.JiraEndpointConsumerBuilder startScheduler(boolean startScheduler)
      Whether the scheduler should be auto started. The option is a: boolean type. Default: true Group: scheduler
      Parameters:
      startScheduler - the value to set
      Returns:
      the dsl builder

    • startScheduler

      default JiraEndpointBuilderFactory.JiraEndpointConsumerBuilder startScheduler(String startScheduler)
      Whether the scheduler should be auto started. The option will be converted to a boolean type. Default: true Group: scheduler
      Parameters:
      startScheduler - the value to set
      Returns:
      the dsl builder

    • timeUnit

      default JiraEndpointBuilderFactory.JiraEndpointConsumerBuilder timeUnit(TimeUnit timeUnit)
      Time unit for initialDelay and delay options. The option is a: java.util.concurrent.TimeUnit type. Default: MILLISECONDS Group: scheduler
      Parameters:
      timeUnit - the value to set
      Returns:
      the dsl builder

    • timeUnit

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

    • useFixedDelay

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

    • useFixedDelay

      default JiraEndpointBuilderFactory.JiraEndpointConsumerBuilder 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 boolean type. Default: true Group: scheduler
      Parameters:
      useFixedDelay - the value to set
      Returns:
      the dsl builder

    • accessToken

      default JiraEndpointBuilderFactory.JiraEndpointConsumerBuilder accessToken(String accessToken)
      (OAuth or Personal Access Token authentication) The access token generated by the Jira server. The option is a: java.lang.String type. Group: security
      Parameters:
      accessToken - the value to set
      Returns:
      the dsl builder

    • consumerKey

      default JiraEndpointBuilderFactory.JiraEndpointConsumerBuilder consumerKey(String consumerKey)
      (OAuth only) The consumer key from Jira settings. The option is a: java.lang.String type. Group: security
      Parameters:
      consumerKey - the value to set
      Returns:
      the dsl builder

    • password

      default JiraEndpointBuilderFactory.JiraEndpointConsumerBuilder password(String password)
      (Basic authentication only) The password or the API Token to authenticate to the Jira server. Use only if username basic authentication is used. The option is a: java.lang.String type. Group: security
      Parameters:
      password - the value to set
      Returns:
      the dsl builder

    • privateKey

      default JiraEndpointBuilderFactory.JiraEndpointConsumerBuilder privateKey(String privateKey)
      (OAuth only) The private key generated by the client to encrypt the conversation to the server. The option is a: java.lang.String type. Group: security
      Parameters:
      privateKey - the value to set
      Returns:
      the dsl builder

    • username

      default JiraEndpointBuilderFactory.JiraEndpointConsumerBuilder username(String username)
      (Basic authentication only) The username to authenticate to the Jira server. Use only if OAuth is not enabled on the Jira server. Do not set the username and OAuth token parameter, if they are both set, the username basic authentication takes precedence. The option is a: java.lang.String type. Group: security
      Parameters:
      username - the value to set
      Returns:
      the dsl builder

    • verificationCode

      default JiraEndpointBuilderFactory.JiraEndpointConsumerBuilder verificationCode(String verificationCode)
      (OAuth only) The verification code from Jira generated in the first step of the authorization proccess. The option is a: java.lang.String type. Group: security
      Parameters:
      verificationCode - the value to set
      Returns:
      the dsl builder