JiraEndpointBuilderFactory.JiraEndpointConsumerBuilder (Camel

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 Summary

All Methods Instance Methods Default Methods
Modifier and Type	Method and Description
`default JiraEndpointBuilderFactory.JiraEndpointConsumerBuilder`	`accessToken(String accessToken)` (OAuth only) The access token generated by the Jira server.
`default JiraEndpointBuilderFactory.AdvancedJiraEndpointConsumerBuilder`	`advanced()`
`default JiraEndpointBuilderFactory.JiraEndpointConsumerBuilder`	`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.
`default JiraEndpointBuilderFactory.JiraEndpointConsumerBuilder`	`bridgeErrorHandler(String 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.
`default JiraEndpointBuilderFactory.JiraEndpointConsumerBuilder`	`consumerKey(String consumerKey)` (OAuth only) The consumer key from Jira settings.
`default JiraEndpointBuilderFactory.JiraEndpointConsumerBuilder`	`delay(Integer delay)` Time in milliseconds to elapse for the next poll.
`default JiraEndpointBuilderFactory.JiraEndpointConsumerBuilder`	`delay(String delay)` Time in milliseconds to elapse for the next poll.
`default JiraEndpointBuilderFactory.JiraEndpointConsumerBuilder`	`jiraUrl(String jiraUrl)` The Jira server url, example: http://my_jira.com:8081.
`default JiraEndpointBuilderFactory.JiraEndpointConsumerBuilder`	`jql(String jql)` JQL is the query language from JIRA which allows you to retrieve the data you want.
`default JiraEndpointBuilderFactory.JiraEndpointConsumerBuilder`	`maxResults(Integer maxResults)` Max number of issues to search for.
`default JiraEndpointBuilderFactory.JiraEndpointConsumerBuilder`	`maxResults(String maxResults)` Max number of issues to search for.
`default JiraEndpointBuilderFactory.JiraEndpointConsumerBuilder`	`password(String password)` (Basic authentication only) The password to authenticate to the Jira server.
`default JiraEndpointBuilderFactory.JiraEndpointConsumerBuilder`	`privateKey(String privateKey)` (OAuth only) The private key generated by the client to encrypt the conversation to the server.
`default JiraEndpointBuilderFactory.JiraEndpointConsumerBuilder`	`sendOnlyUpdatedField(boolean sendOnlyUpdatedField)` Indicator for sending only changed fields in exchange body or issue object.
`default JiraEndpointBuilderFactory.JiraEndpointConsumerBuilder`	`sendOnlyUpdatedField(String sendOnlyUpdatedField)` Indicator for sending only changed fields in exchange body or issue object.
`default JiraEndpointBuilderFactory.JiraEndpointConsumerBuilder`	`username(String username)` (Basic authentication only) The username to authenticate to the Jira server.
`default JiraEndpointBuilderFactory.JiraEndpointConsumerBuilder`	`verificationCode(String verificationCode)` (OAuth only) The verification code from Jira generated in the first step of the authorization proccess.
`default JiraEndpointBuilderFactory.JiraEndpointConsumerBuilder`	`watchedFields(String watchedFields)` Comma separated list of fields to watch for changes.

Methods inherited from interface org.apache.camel.builder.EndpointConsumerBuilder
doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, getUri

Methods inherited from interface org.apache.camel.EndpointConsumerResolver
resolve, resolve

- Method Detail
  - 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: <code>java.lang.Integer</code> 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 <code>java.lang.Integer</code> 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, example: http://my_jira.com:8081. The option is a: <code>java.lang.String</code> type. Required: true Group: common
    
    Parameters:
    
    jiraUrl - the value to set
    
    Returns:
    
    the dsl builder
  - bridgeErrorHandler
```
default JiraEndpointBuilderFactory.JiraEndpointConsumerBuilder 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
  - bridgeErrorHandler
```
default JiraEndpointBuilderFactory.JiraEndpointConsumerBuilder bridgeErrorHandler(String 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 will be converted to a <code>boolean</code> type. Default: false Group: consumer
    
    Parameters:
    
    bridgeErrorHandler - 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: <code>java.lang.String</code> 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: <code>java.lang.Integer</code> 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 <code>java.lang.Integer</code> type. Default: 50 Group: consumer
    
    Parameters:
    
    maxResults - 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: <code>boolean</code> 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 <code>boolean</code> 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: <code>java.lang.String</code> type. Default: Status,Priority Group: consumer
    
    Parameters:
    
    watchedFields - the value to set
    
    Returns:
    
    the dsl builder
  - accessToken
```
default JiraEndpointBuilderFactory.JiraEndpointConsumerBuilder accessToken(String accessToken)
```
    (OAuth only) The access token generated by the Jira server. The option is a: <code>java.lang.String</code> 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: <code>java.lang.String</code> 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 to authenticate to the Jira server. Use only if username basic authentication is used. The option is a: <code>java.lang.String</code> 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: <code>java.lang.String</code> 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: <code>java.lang.String</code> 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: <code>java.lang.String</code> type. Group: security
    
    Parameters:
    
    verificationCode - the value to set
    
    Returns:
    
    the dsl builder

Interface JiraEndpointBuilderFactory.JiraEndpointConsumerBuilder

Method Summary

Methods inherited from interface org.apache.camel.builder.EndpointConsumerBuilder

Methods inherited from interface org.apache.camel.EndpointConsumerResolver

Method Detail

advanced

delay

delay

jiraUrl

bridgeErrorHandler

bridgeErrorHandler

jql

maxResults

maxResults

sendOnlyUpdatedField

sendOnlyUpdatedField

watchedFields

accessToken

consumerKey

password

privateKey

username

verificationCode