zeebe/component.json

{
  "component": {
    "kind": "component",
    "name": "zeebe",
    "title": "Zeebe",
    "description": "Zeebe component which integrates with Camunda Zeebe to interact with the API.",
    "deprecated": false,
    "firstVersion": "3.21.0",
    "label": "workflow,saas",
    "javaType": "org.apache.camel.component.zeebe.ZeebeComponent",
    "supportLevel": "Preview",
    "groupId": "org.apache.camel",
    "artifactId": "camel-zeebe",
    "version": "4.10.2",
    "scheme": "zeebe",
    "extendsScheme": "",
    "syntax": "zeebe:operationName",
    "async": false,
    "api": false,
    "consumerOnly": false,
    "producerOnly": false,
    "lenientProperties": false,
    "browsable": false,
    "remote": true
  },
  "headers": {
    "CamelZeebeResourceName": {
      "index": 0,
      "kind": "header",
      "displayName": "",
      "group": "producer",
      "label": "producer",
      "required": false,
      "javaType": "String",
      "deprecated": false,
      "deprecationNote": "",
      "autowired": false,
      "secret": false,
      "description": "The name of the resource.",
      "constantName": "org.apache.camel.component.zeebe.ZeebeConstants#RESOURCE_NAME"
    },
    "CamelZeebeIsSuccess": {
      "index": 1,
      "kind": "header",
      "displayName": "",
      "group": "producer",
      "label": "producer",
      "required": false,
      "javaType": "boolean",
      "deprecated": false,
      "deprecationNote": "",
      "autowired": false,
      "secret": false,
      "description": "True if the operation was successful.",
      "constantName": "org.apache.camel.component.zeebe.ZeebeConstants#IS_SUCCESS"
    },
    "CamelZeebeErrorMessage": {
      "index": 2,
      "kind": "header",
      "displayName": "",
      "group": "producer",
      "label": "producer",
      "required": false,
      "javaType": "String",
      "deprecated": false,
      "deprecationNote": "",
      "autowired": false,
      "secret": false,
      "description": "In case of an error, the error message.",
      "constantName": "org.apache.camel.component.zeebe.ZeebeConstants#ERROR_MESSAGE"
    },
    "CamelZeebeErrorCode": {
      "index": 3,
      "kind": "header",
      "displayName": "",
      "group": "producer",
      "label": "producer",
      "required": false,
      "javaType": "String",
      "deprecated": false,
      "deprecationNote": "",
      "autowired": false,
      "secret": false,
      "description": "In case of an error, the error code if available.",
      "constantName": "org.apache.camel.component.zeebe.ZeebeConstants#ERROR_CODE"
    },
    "CamelZeebeBPMNProcessId": {
      "index": 4,
      "kind": "header",
      "displayName": "",
      "group": "producer",
      "label": "producer",
      "required": false,
      "javaType": "String",
      "deprecated": false,
      "deprecationNote": "",
      "autowired": false,
      "secret": false,
      "description": "The process ID of a deployed process.",
      "constantName": "org.apache.camel.component.zeebe.ZeebeConstants#BPMN_PROCESS_ID"
    },
    "CamelZeebeVersion": {
      "index": 5,
      "kind": "header",
      "displayName": "",
      "group": "producer",
      "label": "producer",
      "required": false,
      "javaType": "int",
      "deprecated": false,
      "deprecationNote": "",
      "autowired": false,
      "secret": false,
      "description": "The version of a deployed process.",
      "constantName": "org.apache.camel.component.zeebe.ZeebeConstants#VERSION"
    },
    "CamelZeebeProcessDefinitionKey": {
      "index": 6,
      "kind": "header",
      "displayName": "",
      "group": "producer",
      "label": "producer",
      "required": false,
      "javaType": "long",
      "deprecated": false,
      "deprecationNote": "",
      "autowired": false,
      "secret": false,
      "description": "The process definition key of a deployed process.",
      "constantName": "org.apache.camel.component.zeebe.ZeebeConstants#PROCESS_DEFINITION_KEY"
    },
    "CamelZeebeJobKey": {
      "index": 7,
      "kind": "header",
      "displayName": "",
      "group": "common",
      "label": "common",
      "required": false,
      "javaType": "long",
      "deprecated": false,
      "deprecationNote": "",
      "autowired": false,
      "secret": false,
      "description": "The key of a job. The worker consumer adds the job key to the headers and the operations completeJob and failJob accept the job key in the header if no JobRequest is provided in the body.",
      "constantName": "org.apache.camel.component.zeebe.ZeebeConstants#JOB_KEY"
    }
  },
  "properties": {
    "operationName": {
      "index": 0,
      "kind": "path",
      "displayName": "Operation Name",
      "group": "common",
      "label": "common",
      "required": true,
      "type": "object",
      "javaType": "org.apache.camel.component.zeebe.internal.OperationName",
      "enum": [
        "startProcess",
        "cancelProcess",
        "publishMessage",
        "completeJob",
        "failJob",
        "updateJobRetries",
        "worker",
        "throwError",
        "deployResource"
      ],
      "deprecated": false,
      "deprecationNote": "",
      "autowired": false,
      "secret": false,
      "description": "The operation to use"
    },
    "formatJSON": {
      "index": 1,
      "kind": "parameter",
      "displayName": "Format JSON",
      "group": "common",
      "label": "",
      "required": false,
      "type": "boolean",
      "javaType": "boolean",
      "deprecated": false,
      "deprecationNote": "",
      "autowired": false,
      "secret": false,
      "defaultValue": false,
      "description": "Format the result in the body as JSON."
    },
    "jobKey": {
      "index": 2,
      "kind": "parameter",
      "displayName": "Job Key",
      "group": "consumer",
      "label": "consumer",
      "required": false,
      "type": "string",
      "javaType": "java.lang.String",
      "deprecated": false,
      "deprecationNote": "",
      "autowired": false,
      "secret": false,
      "description": "JobKey for the job worker."
    },
    "timeout": {
      "index": 3,
      "kind": "parameter",
      "displayName": "Timeout",
      "group": "consumer",
      "label": "consumer",
      "required": false,
      "type": "integer",
      "javaType": "int",
      "deprecated": false,
      "deprecationNote": "",
      "autowired": false,
      "secret": false,
      "defaultValue": 10,
      "description": "Timeout for job worker."
    },
    "bridgeErrorHandler": {
      "index": 4,
      "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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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": {
      "index": 5,
      "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": {
      "index": 6,
      "kind": "parameter",
      "displayName": "Exchange Pattern",
      "group": "consumer (advanced)",
      "label": "consumer,advanced",
      "required": false,
      "type": "object",
      "javaType": "org.apache.camel.ExchangePattern",
      "enum": [
        "InOnly",
        "InOut"
      ],
      "deprecated": false,
      "autowired": false,
      "secret": false,
      "description": "Sets the exchange pattern when the consumer creates an exchange."
    },
    "lazyStartProducer": {
      "index": 7,
      "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."
    }
  }
}