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 Summary

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, 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: java.lang.Integer type. Default: 6000 Group: common

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

jiraUrl

default JiraEndpointBuilderFactory.JiraEndpointConsumerBuilder jiraUrl(String jiraUrl)

The Jira server url, example: http://my_jira.com:8081. The option is a: java.lang.String type. Required: true Group: common

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: boolean type. Default: false Group: consumer

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 boolean type. Default: false Group: consumer

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

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

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

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

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

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

accessToken

default JiraEndpointBuilderFactory.JiraEndpointConsumerBuilder accessToken(String accessToken)

(OAuth only) The access token generated by the Jira server. The option is a: java.lang.String type. Group: security

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

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: java.lang.String type. Group: security

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

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

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