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 TypeMethodDescriptionaccessToken
(String accessToken) (OAuth or Personal Access Token authentication) The access token generated by the Jira server.advanced()
consumerKey
(String consumerKey) (OAuth only) The consumer key from Jira settings.Time in milliseconds to elapse for the next poll.Time in milliseconds to elapse for the next poll.The Jira server url, example: http://my_jira.com:8081.JQL is the query language from JIRA which allows you to retrieve the data you want.maxResults
(Integer maxResults) Max number of issues to search for.maxResults
(String maxResults) Max number of issues to search for.(Basic authentication only) The password or the API Token to authenticate to the Jira server.privateKey
(String privateKey) (OAuth only) The private key generated by the client to encrypt the conversation to the server.sendOnlyUpdatedField
(boolean sendOnlyUpdatedField) Indicator for sending only changed fields in exchange body or issue object.sendOnlyUpdatedField
(String sendOnlyUpdatedField) Indicator for sending only changed fields in exchange body or issue object.(Basic authentication only) The username to authenticate to the Jira server.verificationCode
(String verificationCode) (OAuth only) The verification code from Jira generated in the first step of the authorization proccess.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, getRawUri, getUri
Methods inherited from interface org.apache.camel.EndpointConsumerResolver
resolve, resolve
-
Method Details
-
advanced
-
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
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
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
-
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
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
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
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
(OAuth or Personal Access Token authentication) 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
(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
(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: <code>java.lang.String</code> type. Group: security- Parameters:
password
- the value to set- Returns:
- the dsl builder
-
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
(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
-