| {"component":{"kind":"component","name":"jira","title":"Jira","description":"Interact with JIRA issue tracker.","deprecated":false,"firstVersion":"3.0","label":"api,reporting","javaType":"org.apache.camel.component.jira.JiraComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-jira","version":"3.18.1","scheme":"jira","extendsScheme":"","syntax":"jira:type","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false},"headers":{"IssueAssignee":{"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The assignee's name of the issue","constantName":"org.apache.camel.component.jira.JiraConstants#ISSUE_ASSIGNEE"},"IssueComponents":{"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The comma separated list of the issue's components","constantName":"org.apache.camel.component.jira.JiraConstants#ISSUE_COMPONENTS"},"IssueChanged":{"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the updated field (i.e Status)","constantName":"org.apache.camel.component.jira.JiraConstants#ISSUE_CHANGED"},"IssueKey":{"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The id of the issue","constantName":"org.apache.camel.component.jira.JiraConstants#ISSUE_KEY"},"IssuePriorityId":{"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The priority's id of the issue","constantName":"org.apache.camel.component.jira.JiraConstants#ISSUE_PRIORITY_ID"},"IssuePriorityName":{"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The priority's name of the issue","constantName":"org.apache.camel.component.jira.JiraConstants#ISSUE_PRIORITY_NAME"},"ProjectKey":{"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The project's id of the issue","constantName":"org.apache.camel.component.jira.JiraConstants#ISSUE_PROJECT_KEY"},"IssueSummary":{"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The summary of the issue","constantName":"org.apache.camel.component.jira.JiraConstants#ISSUE_SUMMARY"},"IssueTransitionId":{"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The transition id","constantName":"org.apache.camel.component.jira.JiraConstants#ISSUE_TRANSITION_ID"},"IssueTypeId":{"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The type's id of the issue","constantName":"org.apache.camel.component.jira.JiraConstants#ISSUE_TYPE_ID"},"IssueTypeName":{"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The type's name of the issue","constantName":"org.apache.camel.component.jira.JiraConstants#ISSUE_TYPE_NAME"},"IssueWatchedIssues":{"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The list of all issue keys that are watched in the time of update","constantName":"org.apache.camel.component.jira.JiraConstants#ISSUE_WATCHED_ISSUES"},"IssueWatchersAdd":{"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The comma separated list of watchers to add to the issue","constantName":"org.apache.camel.component.jira.JiraConstants#ISSUE_WATCHERS_ADD"},"IssueWatchersRemove":{"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The watchers of the issue to remove","constantName":"org.apache.camel.component.jira.JiraConstants#ISSUE_WATCHERS_REMOVE"},"ParentIssueKey":{"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The id of the parent issue","constantName":"org.apache.camel.component.jira.JiraConstants#PARENT_ISSUE_KEY"},"ChildIssueKey":{"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The id of the child issue","constantName":"org.apache.camel.component.jira.JiraConstants#CHILD_ISSUE_KEY"},"linkType":{"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The type of link","constantName":"org.apache.camel.component.jira.JiraConstants#LINK_TYPE"},"minutesSpent":{"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":"-1","description":"The minutes spent","constantName":"org.apache.camel.component.jira.JiraConstants#MINUTES_SPENT"}},"properties":{"type":{"kind":"path","displayName":"Type","group":"common","label":"","required":true,"type":"object","javaType":"org.apache.camel.component.jira.JiraType","enum":["ADDCOMMENT","ADDISSUE","ATTACH","DELETEISSUE","NEWISSUES","NEWCOMMENTS","WATCHUPDATES","UPDATEISSUE","TRANSITIONISSUE","WATCHERS","ADDISSUELINK","ADDWORKLOG","FETCHISSUE","FETCHCOMMENTS"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Operation to perform. Consumers: NewIssues, NewComments. Producers: AddIssue, AttachFile, DeleteIssue, TransitionIssue, UpdateIssue, Watchers. See this class javadoc description for more information."},"delay":{"kind":"parameter","displayName":"Delay","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"6000","configurationClass":"org.apache.camel.component.jira.JiraConfiguration","configurationField":"configuration","description":"Time in milliseconds to elapse for the next poll."},"jiraUrl":{"kind":"parameter","displayName":"Jira Url","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jira.JiraConfiguration","configurationField":"configuration","description":"The Jira server url, example: http://my_jira.com:8081"},"jql":{"kind":"parameter","displayName":"Jql","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"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)"},"maxResults":{"kind":"parameter","displayName":"Max Results","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"50","description":"Max number of issues to search for"},"sendOnlyUpdatedField":{"kind":"parameter","displayName":"Send Only Updated Field","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Indicator for sending only changed fields in exchange body or issue object. By default consumer sends only changed fields."},"watchedFields":{"kind":"parameter","displayName":"Watched Fields","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"Status,Priority","description":"Comma separated list of fields to watch for changes. Status,Priority are the defaults."},"bridgeErrorHandler":{"kind":"parameter","displayName":"Bridge Error Handler","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"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."},"exceptionHandler":{"kind":"parameter","displayName":"Exception Handler","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.ExceptionHandler","optionalPrefix":"consumer.","deprecated":false,"autowired":false,"secret":false,"description":"To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored."},"exchangePattern":{"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut","InOptionalOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"lazyStartProducer":{"kind":"parameter","displayName":"Lazy Start Producer","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing."},"accessToken":{"kind":"parameter","displayName":"Access Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.jira.JiraConfiguration","configurationField":"configuration","description":"(OAuth or Personal Access Token authentication) The access token generated by the Jira server."},"consumerKey":{"kind":"parameter","displayName":"Consumer Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.jira.JiraConfiguration","configurationField":"configuration","description":"(OAuth only) The consumer key from Jira settings."},"password":{"kind":"parameter","displayName":"Password","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.jira.JiraConfiguration","configurationField":"configuration","description":"(Basic authentication only) The password or the API Token to authenticate to the Jira server. Use only if username basic authentication is used."},"privateKey":{"kind":"parameter","displayName":"Private Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.jira.JiraConfiguration","configurationField":"configuration","description":"(OAuth only) The private key generated by the client to encrypt the conversation to the server."},"username":{"kind":"parameter","displayName":"Username","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.jira.JiraConfiguration","configurationField":"configuration","description":"(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."},"verificationCode":{"kind":"parameter","displayName":"Verification Code","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.jira.JiraConfiguration","configurationField":"configuration","description":"(OAuth only) The verification code from Jira generated in the first step of the authorization proccess."}}} |