org.apache.camel.builder.endpoint.dsl

Interface HBaseEndpointBuilderFactory.HBaseEndpointProducerBuilder

All Superinterfaces:

org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver

All Known Subinterfaces:

HBaseEndpointBuilderFactory.HBaseEndpointBuilder

Enclosing interface:

HBaseEndpointBuilderFactory

public static interface HBaseEndpointBuilderFactory.HBaseEndpointProducerBuilder
extends org.apache.camel.builder.EndpointProducerBuilder

Builder for endpoint producers for the HBase component.

Method Summary

Modifier and Type	Method and Description
default HBaseEndpointBuilderFactory.AdvancedHBaseEndpointProducerBuilder	advanced()
default HBaseEndpointBuilderFactory.HBaseEndpointProducerBuilder	cellMappingStrategyFactory(Object cellMappingStrategyFactory) To use a custom CellMappingStrategyFactory that is responsible for mapping cells.
default HBaseEndpointBuilderFactory.HBaseEndpointProducerBuilder	cellMappingStrategyFactory(String cellMappingStrategyFactory) To use a custom CellMappingStrategyFactory that is responsible for mapping cells.
default HBaseEndpointBuilderFactory.HBaseEndpointProducerBuilder	filters(List<Object> filters) A list of filters to use.
default HBaseEndpointBuilderFactory.HBaseEndpointProducerBuilder	filters(String filters) A list of filters to use.
default HBaseEndpointBuilderFactory.HBaseEndpointProducerBuilder	lazyStartProducer(boolean lazyStartProducer) Whether the producer should be started lazy (on the first message).
default HBaseEndpointBuilderFactory.HBaseEndpointProducerBuilder	lazyStartProducer(String lazyStartProducer) Whether the producer should be started lazy (on the first message).
default HBaseEndpointBuilderFactory.HBaseEndpointProducerBuilder	mappingStrategyClassName(String mappingStrategyClassName) The class name of a custom mapping strategy implementation.
default HBaseEndpointBuilderFactory.HBaseEndpointProducerBuilder	mappingStrategyName(String mappingStrategyName) The strategy to use for mapping Camel messages to HBase columns.
default HBaseEndpointBuilderFactory.HBaseEndpointProducerBuilder	maxResults(int maxResults) The maximum number of rows to scan.
default HBaseEndpointBuilderFactory.HBaseEndpointProducerBuilder	maxResults(String maxResults) The maximum number of rows to scan.
default HBaseEndpointBuilderFactory.HBaseEndpointProducerBuilder	rowMapping(Map values) To map the key/values from the Map to a HBaseRow.
default HBaseEndpointBuilderFactory.HBaseEndpointProducerBuilder	rowMapping(String key, Object value) To map the key/values from the Map to a HBaseRow.
default HBaseEndpointBuilderFactory.HBaseEndpointProducerBuilder	rowModel(Object rowModel) An instance of org.apache.camel.component.hbase.model.HBaseRow which describes how each row should be modeled.
default HBaseEndpointBuilderFactory.HBaseEndpointProducerBuilder	rowModel(String rowModel) An instance of org.apache.camel.component.hbase.model.HBaseRow which describes how each row should be modeled.
default HBaseEndpointBuilderFactory.HBaseEndpointProducerBuilder	userGroupInformation(Object userGroupInformation) Defines privileges to communicate with HBase such as using kerberos.
default HBaseEndpointBuilderFactory.HBaseEndpointProducerBuilder	userGroupInformation(String userGroupInformation) Defines privileges to communicate with HBase such as using kerberos.

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

doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, getUri

Methods inherited from interface org.apache.camel.EndpointProducerResolver

resolve, resolve

Method Detail

advanced

default HBaseEndpointBuilderFactory.AdvancedHBaseEndpointProducerBuilder advanced()

cellMappingStrategyFactory

default HBaseEndpointBuilderFactory.HBaseEndpointProducerBuilder 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.HBaseEndpointProducerBuilder 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.HBaseEndpointProducerBuilder filters(List<Object> filters)

A list of filters to use. The option is a: <code>java.util.List&lt;org.apache.hadoop.hbase.filter.Filter&gt;</code> type. Group: common

Parameters:

filters - the value to set

Returns:

the dsl builder

filters

default HBaseEndpointBuilderFactory.HBaseEndpointProducerBuilder filters(String filters)

A list of filters to use. The option will be converted to a <code>java.util.List&lt;org.apache.hadoop.hbase.filter.Filter&gt;</code> type. Group: common

Parameters:

filters - the value to set

Returns:

the dsl builder

mappingStrategyClassName

default HBaseEndpointBuilderFactory.HBaseEndpointProducerBuilder 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.HBaseEndpointProducerBuilder 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.HBaseEndpointProducerBuilder 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&lt;java.lang.String, java.lang.Object&gt;</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.HBaseEndpointProducerBuilder 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&lt;java.lang.String, java.lang.Object&gt;</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.HBaseEndpointProducerBuilder 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.HBaseEndpointProducerBuilder 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.HBaseEndpointProducerBuilder 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.HBaseEndpointProducerBuilder 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

lazyStartProducer

default HBaseEndpointBuilderFactory.HBaseEndpointProducerBuilder lazyStartProducer(boolean lazyStartProducer)

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. The option is a: <code>boolean</code> type. Default: false Group: producer

Parameters:

lazyStartProducer - the value to set

Returns:

the dsl builder

lazyStartProducer

default HBaseEndpointBuilderFactory.HBaseEndpointProducerBuilder lazyStartProducer(String lazyStartProducer)

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. The option will be converted to a <code>boolean</code> type. Default: false Group: producer

Parameters:

lazyStartProducer - the value to set

Returns:

the dsl builder

maxResults

default HBaseEndpointBuilderFactory.HBaseEndpointProducerBuilder maxResults(int maxResults)

The maximum number of rows to scan. The option is a: <code>int</code> type. Default: 100 Group: producer

Parameters:

maxResults - the value to set

Returns:

the dsl builder

maxResults

default HBaseEndpointBuilderFactory.HBaseEndpointProducerBuilder maxResults(String maxResults)

The maximum number of rows to scan. The option will be converted to a <code>int</code> type. Default: 100 Group: producer

Parameters:

maxResults - the value to set

Returns:

the dsl builder