HBaseEndpointBuilderFactory.HBaseEndpointConsumerBuilder (Camel

All Superinterfaces:

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

All Known Subinterfaces:

HBaseEndpointBuilderFactory.HBaseEndpointBuilder

Enclosing interface:

HBaseEndpointBuilderFactory
```
public static interface HBaseEndpointBuilderFactory.HBaseEndpointConsumerBuilder
extends org.apache.camel.builder.EndpointConsumerBuilder
```
Builder for endpoint consumers for the HBase component.

Method Summary

All Methods Instance Methods Default Methods
Modifier and Type	Method and Description
`default HBaseEndpointBuilderFactory.AdvancedHBaseEndpointConsumerBuilder`	`advanced()`
`default HBaseEndpointBuilderFactory.HBaseEndpointConsumerBuilder`	`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 HBaseEndpointBuilderFactory.HBaseEndpointConsumerBuilder`	`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 HBaseEndpointBuilderFactory.HBaseEndpointConsumerBuilder`	`cellMappingStrategyFactory(Object cellMappingStrategyFactory)` To use a custom CellMappingStrategyFactory that is responsible for mapping cells.
`default HBaseEndpointBuilderFactory.HBaseEndpointConsumerBuilder`	`cellMappingStrategyFactory(String cellMappingStrategyFactory)` To use a custom CellMappingStrategyFactory that is responsible for mapping cells.
`default HBaseEndpointBuilderFactory.HBaseEndpointConsumerBuilder`	`filters(List<Object> filters)` A list of filters to use.
`default HBaseEndpointBuilderFactory.HBaseEndpointConsumerBuilder`	`filters(String filters)` A list of filters to use.
`default HBaseEndpointBuilderFactory.HBaseEndpointConsumerBuilder`	`mappingStrategyClassName(String mappingStrategyClassName)` The class name of a custom mapping strategy implementation.
`default HBaseEndpointBuilderFactory.HBaseEndpointConsumerBuilder`	`mappingStrategyName(String mappingStrategyName)` The strategy to use for mapping Camel messages to HBase columns.
`default HBaseEndpointBuilderFactory.HBaseEndpointConsumerBuilder`	`maxMessagesPerPoll(int maxMessagesPerPoll)` Gets the maximum number of messages as a limit to poll at each polling.
`default HBaseEndpointBuilderFactory.HBaseEndpointConsumerBuilder`	`maxMessagesPerPoll(String maxMessagesPerPoll)` Gets the maximum number of messages as a limit to poll at each polling.
`default HBaseEndpointBuilderFactory.HBaseEndpointConsumerBuilder`	`operation(String operation)` The HBase operation to perform.
`default HBaseEndpointBuilderFactory.HBaseEndpointConsumerBuilder`	`remove(boolean remove)` If the option is true, Camel HBase Consumer will remove the rows which it processes.
`default HBaseEndpointBuilderFactory.HBaseEndpointConsumerBuilder`	`remove(String remove)` If the option is true, Camel HBase Consumer will remove the rows which it processes.
`default HBaseEndpointBuilderFactory.HBaseEndpointConsumerBuilder`	`removeHandler(Object removeHandler)` To use a custom HBaseRemoveHandler that is executed when a row is to be removed.
`default HBaseEndpointBuilderFactory.HBaseEndpointConsumerBuilder`	`removeHandler(String removeHandler)` To use a custom HBaseRemoveHandler that is executed when a row is to be removed.
`default HBaseEndpointBuilderFactory.HBaseEndpointConsumerBuilder`	`rowMapping(Map values)` To map the key/values from the Map to a HBaseRow.
`default HBaseEndpointBuilderFactory.HBaseEndpointConsumerBuilder`	`rowMapping(String key, Object value)` To map the key/values from the Map to a HBaseRow.
`default HBaseEndpointBuilderFactory.HBaseEndpointConsumerBuilder`	`rowModel(Object rowModel)` An instance of org.apache.camel.component.hbase.model.HBaseRow which describes how each row should be modeled.
`default HBaseEndpointBuilderFactory.HBaseEndpointConsumerBuilder`	`rowModel(String rowModel)` An instance of org.apache.camel.component.hbase.model.HBaseRow which describes how each row should be modeled.
`default HBaseEndpointBuilderFactory.HBaseEndpointConsumerBuilder`	`userGroupInformation(Object userGroupInformation)` Defines privileges to communicate with HBase such as using kerberos.
`default HBaseEndpointBuilderFactory.HBaseEndpointConsumerBuilder`	`userGroupInformation(String userGroupInformation)` Defines privileges to communicate with HBase such as using kerberos.

Methods inherited from interface org.apache.camel.builder.EndpointConsumerBuilder
doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, expr, getUri

Methods inherited from interface org.apache.camel.EndpointConsumerResolver
resolve, resolve

- Method Detail
  - advanced
```
default HBaseEndpointBuilderFactory.AdvancedHBaseEndpointConsumerBuilder advanced()
```
  - cellMappingStrategyFactory
```
default HBaseEndpointBuilderFactory.HBaseEndpointConsumerBuilder cellMappingStrategyFactory(Object cellMappingStrategyFactory)
```
    To use a custom CellMappingStrategyFactory that is responsible for mapping cells. The option is a: <code>org.apache.camel.component.hbase.mapping.CellMappingStrategyFactory</code> type. Group: common
    
    Parameters:
    
    cellMappingStrategyFactory - the value to set
    
    Returns:
    
    the dsl builder
  - cellMappingStrategyFactory
```
default HBaseEndpointBuilderFactory.HBaseEndpointConsumerBuilder cellMappingStrategyFactory(String cellMappingStrategyFactory)
```
    To use a custom CellMappingStrategyFactory that is responsible for mapping cells. The option will be converted to a <code>org.apache.camel.component.hbase.mapping.CellMappingStrategyFactory</code> type. Group: common
    
    Parameters:
    
    cellMappingStrategyFactory - the value to set
    
    Returns:
    
    the dsl builder
  - filters
```
default HBaseEndpointBuilderFactory.HBaseEndpointConsumerBuilder filters(List<Object> filters)
```
    A list of filters to use. The option is a: <code>java.util.List<org.apache.hadoop.hbase.filter.Filter></code> type. Group: common
    
    Parameters:
    
    filters - the value to set
    
    Returns:
    
    the dsl builder
  - filters
```
default HBaseEndpointBuilderFactory.HBaseEndpointConsumerBuilder filters(String filters)
```
    A list of filters to use. The option will be converted to a <code>java.util.List<org.apache.hadoop.hbase.filter.Filter></code> type. Group: common
    
    Parameters:
    
    filters - the value to set
    
    Returns:
    
    the dsl builder
  - mappingStrategyClassName
```
default HBaseEndpointBuilderFactory.HBaseEndpointConsumerBuilder mappingStrategyClassName(String mappingStrategyClassName)
```
    The class name of a custom mapping strategy implementation. The option is a: <code>java.lang.String</code> type. Group: common
    
    Parameters:
    
    mappingStrategyClassName - the value to set
    
    Returns:
    
    the dsl builder
  - mappingStrategyName
```
default HBaseEndpointBuilderFactory.HBaseEndpointConsumerBuilder mappingStrategyName(String mappingStrategyName)
```
    The strategy to use for mapping Camel messages to HBase columns. Supported values: header, or body. The option is a: <code>java.lang.String</code> type. Group: common
    
    Parameters:
    
    mappingStrategyName - the value to set
    
    Returns:
    
    the dsl builder
  - rowMapping
```
default HBaseEndpointBuilderFactory.HBaseEndpointConsumerBuilder rowMapping(String key,
                                                                            Object value)
```
    To map the key/values from the Map to a HBaseRow. The following keys is supported: rowId - The id of the row. This has limited use as the row usually changes per Exchange. rowType - The type to covert row id to. Supported operations: CamelHBaseScan. family - The column family. Supports a number suffix for referring to more than one columns. qualifier - The column qualifier. Supports a number suffix for referring to more than one columns. value - The value. Supports a number suffix for referring to more than one columns valueType - The value type. Supports a number suffix for referring to more than one columns. Supported operations: CamelHBaseGet, and CamelHBaseScan. The option is a: <code>java.util.Map<java.lang.String, java.lang.Object></code> type. The option is multivalued, and you can use the rowMapping(String, Object) method to add a value (call the method multiple times to set more values). Group: common
    
    Parameters:
    
    key - the option key
    
    value - the option value
    
    Returns:
    
    the dsl builder
  - rowMapping
```
default HBaseEndpointBuilderFactory.HBaseEndpointConsumerBuilder rowMapping(Map values)
```
    To map the key/values from the Map to a HBaseRow. The following keys is supported: rowId - The id of the row. This has limited use as the row usually changes per Exchange. rowType - The type to covert row id to. Supported operations: CamelHBaseScan. family - The column family. Supports a number suffix for referring to more than one columns. qualifier - The column qualifier. Supports a number suffix for referring to more than one columns. value - The value. Supports a number suffix for referring to more than one columns valueType - The value type. Supports a number suffix for referring to more than one columns. Supported operations: CamelHBaseGet, and CamelHBaseScan. The option is a: <code>java.util.Map<java.lang.String, java.lang.Object></code> type. The option is multivalued, and you can use the rowMapping(String, Object) method to add a value (call the method multiple times to set more values). Group: common
    
    Parameters:
    
    values - the values
    
    Returns:
    
    the dsl builder
  - rowModel
```
default HBaseEndpointBuilderFactory.HBaseEndpointConsumerBuilder rowModel(Object rowModel)
```
    An instance of org.apache.camel.component.hbase.model.HBaseRow which describes how each row should be modeled. The option is a: <code>org.apache.camel.component.hbase.model.HBaseRow</code> type. Group: common
    
    Parameters:
    
    rowModel - the value to set
    
    Returns:
    
    the dsl builder
  - rowModel
```
default HBaseEndpointBuilderFactory.HBaseEndpointConsumerBuilder rowModel(String rowModel)
```
    An instance of org.apache.camel.component.hbase.model.HBaseRow which describes how each row should be modeled. The option will be converted to a <code>org.apache.camel.component.hbase.model.HBaseRow</code> type. Group: common
    
    Parameters:
    
    rowModel - the value to set
    
    Returns:
    
    the dsl builder
  - userGroupInformation
```
default HBaseEndpointBuilderFactory.HBaseEndpointConsumerBuilder userGroupInformation(Object userGroupInformation)
```
    Defines privileges to communicate with HBase such as using kerberos. The option is a: <code>org.apache.hadoop.security.UserGroupInformation</code> type. Group: common
    
    Parameters:
    
    userGroupInformation - the value to set
    
    Returns:
    
    the dsl builder
  - userGroupInformation
```
default HBaseEndpointBuilderFactory.HBaseEndpointConsumerBuilder userGroupInformation(String userGroupInformation)
```
    Defines privileges to communicate with HBase such as using kerberos. The option will be converted to a <code>org.apache.hadoop.security.UserGroupInformation</code> type. Group: common
    
    Parameters:
    
    userGroupInformation - the value to set
    
    Returns:
    
    the dsl builder
  - bridgeErrorHandler
```
default HBaseEndpointBuilderFactory.HBaseEndpointConsumerBuilder 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: <code>boolean</code> type. Default: false Group: consumer
    
    Parameters:
    
    bridgeErrorHandler - the value to set
    
    Returns:
    
    the dsl builder
  - bridgeErrorHandler
```
default HBaseEndpointBuilderFactory.HBaseEndpointConsumerBuilder 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 <code>boolean</code> type. Default: false Group: consumer
    
    Parameters:
    
    bridgeErrorHandler - the value to set
    
    Returns:
    
    the dsl builder
  - maxMessagesPerPoll
```
default HBaseEndpointBuilderFactory.HBaseEndpointConsumerBuilder maxMessagesPerPoll(int maxMessagesPerPoll)
```
    Gets the maximum number of messages as a limit to poll at each polling. Is default unlimited, but use 0 or negative number to disable it as unlimited. The option is a: <code>int</code> type. Group: consumer
    
    Parameters:
    
    maxMessagesPerPoll - the value to set
    
    Returns:
    
    the dsl builder
  - maxMessagesPerPoll
```
default HBaseEndpointBuilderFactory.HBaseEndpointConsumerBuilder maxMessagesPerPoll(String maxMessagesPerPoll)
```
    Gets the maximum number of messages as a limit to poll at each polling. Is default unlimited, but use 0 or negative number to disable it as unlimited. The option will be converted to a <code>int</code> type. Group: consumer
    
    Parameters:
    
    maxMessagesPerPoll - the value to set
    
    Returns:
    
    the dsl builder
  - operation
```
default HBaseEndpointBuilderFactory.HBaseEndpointConsumerBuilder operation(String operation)
```
    The HBase operation to perform. The option is a: <code>java.lang.String</code> type. Group: consumer
    
    Parameters:
    
    operation - the value to set
    
    Returns:
    
    the dsl builder
  - remove
```
default HBaseEndpointBuilderFactory.HBaseEndpointConsumerBuilder remove(boolean remove)
```
    If the option is true, Camel HBase Consumer will remove the rows which it processes. The option is a: <code>boolean</code> type. Default: true Group: consumer
    
    Parameters:
    
    remove - the value to set
    
    Returns:
    
    the dsl builder
  - remove
```
default HBaseEndpointBuilderFactory.HBaseEndpointConsumerBuilder remove(String remove)
```
    If the option is true, Camel HBase Consumer will remove the rows which it processes. The option will be converted to a <code>boolean</code> type. Default: true Group: consumer
    
    Parameters:
    
    remove - the value to set
    
    Returns:
    
    the dsl builder
  - removeHandler
```
default HBaseEndpointBuilderFactory.HBaseEndpointConsumerBuilder removeHandler(Object removeHandler)
```
    To use a custom HBaseRemoveHandler that is executed when a row is to be removed. The option is a: <code>org.apache.camel.component.hbase.HBaseRemoveHandler</code> type. Group: consumer
    
    Parameters:
    
    removeHandler - the value to set
    
    Returns:
    
    the dsl builder
  - removeHandler
```
default HBaseEndpointBuilderFactory.HBaseEndpointConsumerBuilder removeHandler(String removeHandler)
```
    To use a custom HBaseRemoveHandler that is executed when a row is to be removed. The option will be converted to a <code>org.apache.camel.component.hbase.HBaseRemoveHandler</code> type. Group: consumer
    
    Parameters:
    
    removeHandler - the value to set
    
    Returns:
    
    the dsl builder

Interface HBaseEndpointBuilderFactory.HBaseEndpointConsumerBuilder

Method Summary

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

Methods inherited from interface org.apache.camel.EndpointConsumerResolver

Method Detail

advanced

cellMappingStrategyFactory

cellMappingStrategyFactory

filters

filters

mappingStrategyClassName

mappingStrategyName

rowMapping

rowMapping

rowModel

rowModel

userGroupInformation

userGroupInformation

bridgeErrorHandler

bridgeErrorHandler

maxMessagesPerPoll

maxMessagesPerPoll

operation

remove

remove

removeHandler

removeHandler