JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder (Camel

All Superinterfaces:

org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver

All Known Subinterfaces:

JBPMEndpointBuilderFactory.JBPMEndpointBuilder

Enclosing interface:

JBPMEndpointBuilderFactory
```
public static interface JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder
extends org.apache.camel.builder.EndpointConsumerBuilder
```
Builder for endpoint consumers for the JBPM component.

Method Summary

All Methods Instance Methods Default Methods
Modifier and Type	Method and Description
`default JBPMEndpointBuilderFactory.AdvancedJBPMEndpointConsumerBuilder`	`advanced()`
`default JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder`	`attachmentId(Long attachmentId)` attachId to use when retrieving attachments.
`default JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder`	`attachmentId(String attachmentId)` attachId to use when retrieving attachments.
`default JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder`	`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 JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder`	`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 JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder`	`contentId(Long contentId)` contentId to use when retrieving attachments.
`default JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder`	`contentId(String contentId)` contentId to use when retrieving attachments.
`default JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder`	`deploymentId(String deploymentId)` The id of the deployment.
`default JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder`	`emitterSendItems(Boolean emitterSendItems)` Sets if event produced by emitter should be sent as single items or complete collection.
`default JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder`	`emitterSendItems(String emitterSendItems)` Sets if event produced by emitter should be sent as single items or complete collection.
`default JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder`	`event(Object event)` the data associated with this event when signalEvent operation is performed.
`default JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder`	`event(String event)` the data associated with this event when signalEvent operation is performed.
`default JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder`	`eventType(String eventType)` the type of event to use when signalEvent operation is performed.
`default JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder`	`identifier(String identifier)` identifier the global identifier.
`default JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder`	`maxNumber(Integer maxNumber)` the maximum number of rules that should be fired.
`default JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder`	`maxNumber(String maxNumber)` the maximum number of rules that should be fired.
`default JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder`	`page(Integer page)` The page to use when retrieving user tasks.
`default JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder`	`page(String page)` The page to use when retrieving user tasks.
`default JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder`	`pageSize(Integer pageSize)` The page size to use when retrieving user tasks.
`default JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder`	`pageSize(String pageSize)` The page size to use when retrieving user tasks.
`default JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder`	`password(String password)` Password for authentication.
`default JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder`	`processId(String processId)` the id of the process that should be acted upon.
`default JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder`	`processInstanceId(Long processInstanceId)` the id of the process instance.
`default JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder`	`processInstanceId(String processInstanceId)` the id of the process instance.
`default JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder`	`statuses(List<String> statuses)` The list of status to use when filtering tasks.
`default JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder`	`statuses(String statuses)` The list of status to use when filtering tasks.
`default JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder`	`targetUserId(String targetUserId)` The targetUserId used when delegating a task.
`default JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder`	`task(Object task)` The task instance to use with task operations.
`default JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder`	`task(String task)` The task instance to use with task operations.
`default JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder`	`taskId(Long taskId)` the id of the task.
`default JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder`	`taskId(String taskId)` the id of the task.
`default JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder`	`timeout(Integer timeout)` A timeout value.
`default JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder`	`timeout(String timeout)` A timeout value.
`default JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder`	`userId(String userId)` userId to use with task operations.
`default JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder`	`userName(String userName)` Username for authentication.
`default JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder`	`value(Object value)` the value to assign to the global identifier.
`default JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder`	`value(String value)` the value to assign to the global identifier.
`default JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder`	`workItemId(Long workItemId)` the id of the work item.
`default JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder`	`workItemId(String workItemId)` the id of the work item.

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 JBPMEndpointBuilderFactory.AdvancedJBPMEndpointConsumerBuilder advanced()
```
  - attachmentId
```
default JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder attachmentId(Long attachmentId)
```
    attachId to use when retrieving attachments. The option is a: java.lang.Long type. Group: common
  - attachmentId
```
default JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder attachmentId(String attachmentId)
```
    attachId to use when retrieving attachments. The option will be converted to a java.lang.Long type. Group: common
  - contentId
```
default JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder contentId(Long contentId)
```
    contentId to use when retrieving attachments. The option is a: java.lang.Long type. Group: common
  - contentId
```
default JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder contentId(String contentId)
```
    contentId to use when retrieving attachments. The option will be converted to a java.lang.Long type. Group: common
  - deploymentId
```
default JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder deploymentId(String deploymentId)
```
    The id of the deployment. The option is a: java.lang.String type. Required: true Group: common
  - emitterSendItems
```
default JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder emitterSendItems(Boolean emitterSendItems)
```
    Sets if event produced by emitter should be sent as single items or complete collection. The option is a: java.lang.Boolean type. Group: common
  - emitterSendItems
```
default JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder emitterSendItems(String emitterSendItems)
```
    Sets if event produced by emitter should be sent as single items or complete collection. The option will be converted to a java.lang.Boolean type. Group: common
  - event
```
default JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder event(Object event)
```
    the data associated with this event when signalEvent operation is performed. The option is a: java.lang.Object type. Group: common
  - event
```
default JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder event(String event)
```
    the data associated with this event when signalEvent operation is performed. The option will be converted to a java.lang.Object type. Group: common
  - eventType
```
default JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder eventType(String eventType)
```
    the type of event to use when signalEvent operation is performed. The option is a: java.lang.String type. Group: common
  - identifier
```
default JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder identifier(String identifier)
```
    identifier the global identifier. The option is a: java.lang.String type. Group: common
  - maxNumber
```
default JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder maxNumber(Integer maxNumber)
```
    the maximum number of rules that should be fired. The option is a: java.lang.Integer type. Group: common
  - maxNumber
```
default JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder maxNumber(String maxNumber)
```
    the maximum number of rules that should be fired. The option will be converted to a java.lang.Integer type. Group: common
  - page
```
default JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder page(Integer page)
```
    The page to use when retrieving user tasks. The option is a: java.lang.Integer type. Group: common
  - page
```
default JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder page(String page)
```
    The page to use when retrieving user tasks. The option will be converted to a java.lang.Integer type. Group: common
  - pageSize
```
default JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder pageSize(Integer pageSize)
```
    The page size to use when retrieving user tasks. The option is a: java.lang.Integer type. Group: common
  - pageSize
```
default JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder pageSize(String pageSize)
```
    The page size to use when retrieving user tasks. The option will be converted to a java.lang.Integer type. Group: common
  - processId
```
default JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder processId(String processId)
```
    the id of the process that should be acted upon. The option is a: java.lang.String type. Group: common
  - processInstanceId
```
default JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder processInstanceId(Long processInstanceId)
```
    the id of the process instance. The option is a: java.lang.Long type. Group: common
  - processInstanceId
```
default JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder processInstanceId(String processInstanceId)
```
    the id of the process instance. The option will be converted to a java.lang.Long type. Group: common
  - targetUserId
```
default JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder targetUserId(String targetUserId)
```
    The targetUserId used when delegating a task. The option is a: java.lang.String type. Group: common
  - task
```
default JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder task(Object task)
```
    The task instance to use with task operations. The option is a: org.kie.api.task.model.Task type. Group: common
  - task
```
default JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder task(String task)
```
    The task instance to use with task operations. The option will be converted to a org.kie.api.task.model.Task type. Group: common
  - taskId
```
default JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder taskId(Long taskId)
```
    the id of the task. The option is a: java.lang.Long type. Group: common
  - taskId
```
default JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder taskId(String taskId)
```
    the id of the task. The option will be converted to a java.lang.Long type. Group: common
  - timeout
```
default JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder timeout(Integer timeout)
```
    A timeout value. The option is a: java.lang.Integer type. Group: common
  - timeout
```
default JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder timeout(String timeout)
```
    A timeout value. The option will be converted to a java.lang.Integer type. Group: common
  - userId
```
default JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder userId(String userId)
```
    userId to use with task operations. The option is a: java.lang.String type. Group: common
  - value
```
default JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder value(Object value)
```
    the value to assign to the global identifier. The option is a: java.lang.Object type. Group: common
  - value
```
default JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder value(String value)
```
    the value to assign to the global identifier. The option will be converted to a java.lang.Object type. Group: common
  - workItemId
```
default JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder workItemId(Long workItemId)
```
    the id of the work item. The option is a: java.lang.Long type. Group: common
  - workItemId
```
default JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder workItemId(String workItemId)
```
    the id of the work item. The option will be converted to a java.lang.Long type. Group: common
  - bridgeErrorHandler
```
default JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder 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 JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder 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
  - statuses
```
default JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder statuses(List<String> statuses)
```
    The list of status to use when filtering tasks. The option is a: java.util.List<java.lang.String> type. Group: filter
  - statuses
```
default JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder statuses(String statuses)
```
    The list of status to use when filtering tasks. The option will be converted to a java.util.List<java.lang.String> type. Group: filter
  - password
```
default JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder password(String password)
```
    Password for authentication. The option is a: java.lang.String type. Group: security
  - userName
```
default JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder userName(String userName)
```
    Username for authentication. The option is a: java.lang.String type. Group: security

Interface JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder

Method Summary

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

Methods inherited from interface org.apache.camel.EndpointConsumerResolver

Method Detail

advanced

attachmentId

attachmentId

contentId

contentId

deploymentId

emitterSendItems

emitterSendItems

event

event

eventType

identifier

maxNumber

maxNumber

page

page

pageSize

pageSize

processId

processInstanceId

processInstanceId

targetUserId

task

task

taskId

taskId

timeout

timeout

userId

value

value

workItemId

workItemId

bridgeErrorHandler

bridgeErrorHandler

statuses

statuses

password

userName