org.apache.camel.builder.endpoint.dsl

Interface HdfsEndpointBuilderFactory.AdvancedHdfsEndpointBuilder

All Superinterfaces:

org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver, org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver, HdfsEndpointBuilderFactory.AdvancedHdfsEndpointConsumerBuilder, HdfsEndpointBuilderFactory.AdvancedHdfsEndpointProducerBuilder

Enclosing interface:

HdfsEndpointBuilderFactory

public static interface HdfsEndpointBuilderFactory.AdvancedHdfsEndpointBuilder
extends HdfsEndpointBuilderFactory.AdvancedHdfsEndpointConsumerBuilder, HdfsEndpointBuilderFactory.AdvancedHdfsEndpointProducerBuilder

Advanced builder for endpoint for the HDFS component.

Method Summary

Modifier and Type	Method and Description
default HdfsEndpointBuilderFactory.HdfsEndpointBuilder	basic()
default HdfsEndpointBuilderFactory.AdvancedHdfsEndpointBuilder	basicPropertyBinding(boolean basicPropertyBinding) Whether the endpoint should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities.
default HdfsEndpointBuilderFactory.AdvancedHdfsEndpointBuilder	basicPropertyBinding(String basicPropertyBinding) Whether the endpoint should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities.
default HdfsEndpointBuilderFactory.AdvancedHdfsEndpointBuilder	blockSize(long blockSize) The size of the HDFS blocks.
default HdfsEndpointBuilderFactory.AdvancedHdfsEndpointBuilder	blockSize(String blockSize) The size of the HDFS blocks.
default HdfsEndpointBuilderFactory.AdvancedHdfsEndpointBuilder	bufferSize(int bufferSize) The buffer size used by HDFS.
default HdfsEndpointBuilderFactory.AdvancedHdfsEndpointBuilder	bufferSize(String bufferSize) The buffer size used by HDFS.
default HdfsEndpointBuilderFactory.AdvancedHdfsEndpointBuilder	checkIdleInterval(int checkIdleInterval) How often (time in millis) in to run the idle checker background task.
default HdfsEndpointBuilderFactory.AdvancedHdfsEndpointBuilder	checkIdleInterval(String checkIdleInterval) How often (time in millis) in to run the idle checker background task.
default HdfsEndpointBuilderFactory.AdvancedHdfsEndpointBuilder	chunkSize(int chunkSize) When reading a normal file, this is split into chunks producing a message per chunk.
default HdfsEndpointBuilderFactory.AdvancedHdfsEndpointBuilder	chunkSize(String chunkSize) When reading a normal file, this is split into chunks producing a message per chunk.
default HdfsEndpointBuilderFactory.AdvancedHdfsEndpointBuilder	compressionCodec(HdfsEndpointBuilderFactory.HdfsCompressionCodec compressionCodec) The compression codec to use.
default HdfsEndpointBuilderFactory.AdvancedHdfsEndpointBuilder	compressionCodec(String compressionCodec) The compression codec to use.
default HdfsEndpointBuilderFactory.AdvancedHdfsEndpointBuilder	compressionType(HdfsEndpointBuilderFactory.CompressionType compressionType) The compression type to use (is default not in use).
default HdfsEndpointBuilderFactory.AdvancedHdfsEndpointBuilder	compressionType(String compressionType) The compression type to use (is default not in use).
default HdfsEndpointBuilderFactory.AdvancedHdfsEndpointBuilder	openedSuffix(String openedSuffix) When a file is opened for reading/writing the file is renamed with this suffix to avoid to read it during the writing phase.
default HdfsEndpointBuilderFactory.AdvancedHdfsEndpointBuilder	readSuffix(String readSuffix) Once the file has been read is renamed with this suffix to avoid to read it again.
default HdfsEndpointBuilderFactory.AdvancedHdfsEndpointBuilder	replication(short replication) The HDFS replication factor.
default HdfsEndpointBuilderFactory.AdvancedHdfsEndpointBuilder	replication(String replication) The HDFS replication factor.
default HdfsEndpointBuilderFactory.AdvancedHdfsEndpointBuilder	splitStrategy(String splitStrategy) In the current version of Hadoop opening a file in append mode is disabled since it's not very reliable.
default HdfsEndpointBuilderFactory.AdvancedHdfsEndpointBuilder	synchronous(boolean synchronous) Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported).
default HdfsEndpointBuilderFactory.AdvancedHdfsEndpointBuilder	synchronous(String synchronous) Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported).

Methods inherited from interface org.apache.camel.builder.endpoint.dsl.HdfsEndpointBuilderFactory.AdvancedHdfsEndpointConsumerBuilder

exceptionHandler, exceptionHandler, exchangePattern, exchangePattern, pollStrategy, pollStrategy

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

doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, getUri

Methods inherited from interface org.apache.camel.EndpointConsumerResolver

resolve, resolve

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

doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, expr, getUri

Methods inherited from interface org.apache.camel.EndpointProducerResolver

resolve, resolve

Method Detail

basic

default HdfsEndpointBuilderFactory.HdfsEndpointBuilder basic()

Specified by:

basic in interface HdfsEndpointBuilderFactory.AdvancedHdfsEndpointConsumerBuilder

Specified by:

basic in interface HdfsEndpointBuilderFactory.AdvancedHdfsEndpointProducerBuilder

basicPropertyBinding

default HdfsEndpointBuilderFactory.AdvancedHdfsEndpointBuilder basicPropertyBinding(boolean basicPropertyBinding)

Whether the endpoint should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities. The option is a: boolean type. Default: false Group: advanced

Specified by:

basicPropertyBinding in interface HdfsEndpointBuilderFactory.AdvancedHdfsEndpointConsumerBuilder

Specified by:

basicPropertyBinding in interface HdfsEndpointBuilderFactory.AdvancedHdfsEndpointProducerBuilder

basicPropertyBinding

default HdfsEndpointBuilderFactory.AdvancedHdfsEndpointBuilder basicPropertyBinding(String basicPropertyBinding)

Whether the endpoint should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities. The option will be converted to a boolean type. Default: false Group: advanced

Specified by:

basicPropertyBinding in interface HdfsEndpointBuilderFactory.AdvancedHdfsEndpointConsumerBuilder

Specified by:

basicPropertyBinding in interface HdfsEndpointBuilderFactory.AdvancedHdfsEndpointProducerBuilder

blockSize

default HdfsEndpointBuilderFactory.AdvancedHdfsEndpointBuilder blockSize(long blockSize)

The size of the HDFS blocks. The option is a: long type. Default: 67108864 Group: advanced

Specified by:

blockSize in interface HdfsEndpointBuilderFactory.AdvancedHdfsEndpointConsumerBuilder

Specified by:

blockSize in interface HdfsEndpointBuilderFactory.AdvancedHdfsEndpointProducerBuilder

blockSize

default HdfsEndpointBuilderFactory.AdvancedHdfsEndpointBuilder blockSize(String blockSize)

The size of the HDFS blocks. The option will be converted to a long type. Default: 67108864 Group: advanced

Specified by:

blockSize in interface HdfsEndpointBuilderFactory.AdvancedHdfsEndpointConsumerBuilder

Specified by:

blockSize in interface HdfsEndpointBuilderFactory.AdvancedHdfsEndpointProducerBuilder

bufferSize

default HdfsEndpointBuilderFactory.AdvancedHdfsEndpointBuilder bufferSize(int bufferSize)

The buffer size used by HDFS. The option is a: int type. Default: 4096 Group: advanced

Specified by:

bufferSize in interface HdfsEndpointBuilderFactory.AdvancedHdfsEndpointConsumerBuilder

Specified by:

bufferSize in interface HdfsEndpointBuilderFactory.AdvancedHdfsEndpointProducerBuilder

bufferSize

default HdfsEndpointBuilderFactory.AdvancedHdfsEndpointBuilder bufferSize(String bufferSize)

The buffer size used by HDFS. The option will be converted to a int type. Default: 4096 Group: advanced

Specified by:

bufferSize in interface HdfsEndpointBuilderFactory.AdvancedHdfsEndpointConsumerBuilder

Specified by:

bufferSize in interface HdfsEndpointBuilderFactory.AdvancedHdfsEndpointProducerBuilder

checkIdleInterval

default HdfsEndpointBuilderFactory.AdvancedHdfsEndpointBuilder checkIdleInterval(int checkIdleInterval)

How often (time in millis) in to run the idle checker background task. This option is only in use if the splitter strategy is IDLE. The option is a: int type. Default: 500 Group: advanced

Specified by:

checkIdleInterval in interface HdfsEndpointBuilderFactory.AdvancedHdfsEndpointConsumerBuilder

Specified by:

checkIdleInterval in interface HdfsEndpointBuilderFactory.AdvancedHdfsEndpointProducerBuilder

checkIdleInterval

default HdfsEndpointBuilderFactory.AdvancedHdfsEndpointBuilder checkIdleInterval(String checkIdleInterval)

How often (time in millis) in to run the idle checker background task. This option is only in use if the splitter strategy is IDLE. The option will be converted to a int type. Default: 500 Group: advanced

Specified by:

checkIdleInterval in interface HdfsEndpointBuilderFactory.AdvancedHdfsEndpointConsumerBuilder

Specified by:

checkIdleInterval in interface HdfsEndpointBuilderFactory.AdvancedHdfsEndpointProducerBuilder

chunkSize

default HdfsEndpointBuilderFactory.AdvancedHdfsEndpointBuilder chunkSize(int chunkSize)

When reading a normal file, this is split into chunks producing a message per chunk. The option is a: int type. Default: 4096 Group: advanced

Specified by:

chunkSize in interface HdfsEndpointBuilderFactory.AdvancedHdfsEndpointConsumerBuilder

Specified by:

chunkSize in interface HdfsEndpointBuilderFactory.AdvancedHdfsEndpointProducerBuilder

chunkSize

default HdfsEndpointBuilderFactory.AdvancedHdfsEndpointBuilder chunkSize(String chunkSize)

When reading a normal file, this is split into chunks producing a message per chunk. The option will be converted to a int type. Default: 4096 Group: advanced

Specified by:

chunkSize in interface HdfsEndpointBuilderFactory.AdvancedHdfsEndpointConsumerBuilder

Specified by:

chunkSize in interface HdfsEndpointBuilderFactory.AdvancedHdfsEndpointProducerBuilder

compressionCodec

default HdfsEndpointBuilderFactory.AdvancedHdfsEndpointBuilder compressionCodec(HdfsEndpointBuilderFactory.HdfsCompressionCodec compressionCodec)

The compression codec to use. The option is a: org.apache.camel.component.hdfs.HdfsCompressionCodec type. Default: DEFAULT Group: advanced

Specified by:

compressionCodec in interface HdfsEndpointBuilderFactory.AdvancedHdfsEndpointConsumerBuilder

Specified by:

compressionCodec in interface HdfsEndpointBuilderFactory.AdvancedHdfsEndpointProducerBuilder

compressionCodec

default HdfsEndpointBuilderFactory.AdvancedHdfsEndpointBuilder compressionCodec(String compressionCodec)

The compression codec to use. The option will be converted to a org.apache.camel.component.hdfs.HdfsCompressionCodec type. Default: DEFAULT Group: advanced

Specified by:

compressionCodec in interface HdfsEndpointBuilderFactory.AdvancedHdfsEndpointConsumerBuilder

Specified by:

compressionCodec in interface HdfsEndpointBuilderFactory.AdvancedHdfsEndpointProducerBuilder

compressionType

default HdfsEndpointBuilderFactory.AdvancedHdfsEndpointBuilder compressionType(HdfsEndpointBuilderFactory.CompressionType compressionType)

The compression type to use (is default not in use). The option is a: org.apache.hadoop.io.SequenceFile$CompressionType type. Default: NONE Group: advanced

Specified by:

compressionType in interface HdfsEndpointBuilderFactory.AdvancedHdfsEndpointConsumerBuilder

Specified by:

compressionType in interface HdfsEndpointBuilderFactory.AdvancedHdfsEndpointProducerBuilder

compressionType

default HdfsEndpointBuilderFactory.AdvancedHdfsEndpointBuilder compressionType(String compressionType)

The compression type to use (is default not in use). The option will be converted to a org.apache.hadoop.io.SequenceFile$CompressionType type. Default: NONE Group: advanced

Specified by:

compressionType in interface HdfsEndpointBuilderFactory.AdvancedHdfsEndpointConsumerBuilder

Specified by:

compressionType in interface HdfsEndpointBuilderFactory.AdvancedHdfsEndpointProducerBuilder

openedSuffix

default HdfsEndpointBuilderFactory.AdvancedHdfsEndpointBuilder openedSuffix(String openedSuffix)

When a file is opened for reading/writing the file is renamed with this suffix to avoid to read it during the writing phase. The option is a: java.lang.String type. Default: opened Group: advanced

Specified by:

openedSuffix in interface HdfsEndpointBuilderFactory.AdvancedHdfsEndpointConsumerBuilder

Specified by:

openedSuffix in interface HdfsEndpointBuilderFactory.AdvancedHdfsEndpointProducerBuilder

readSuffix

default HdfsEndpointBuilderFactory.AdvancedHdfsEndpointBuilder readSuffix(String readSuffix)

Once the file has been read is renamed with this suffix to avoid to read it again. The option is a: java.lang.String type. Default: read Group: advanced

Specified by:

readSuffix in interface HdfsEndpointBuilderFactory.AdvancedHdfsEndpointConsumerBuilder

Specified by:

readSuffix in interface HdfsEndpointBuilderFactory.AdvancedHdfsEndpointProducerBuilder

replication

default HdfsEndpointBuilderFactory.AdvancedHdfsEndpointBuilder replication(short replication)

The HDFS replication factor. The option is a: short type. Default: 3 Group: advanced

Specified by:

replication in interface HdfsEndpointBuilderFactory.AdvancedHdfsEndpointConsumerBuilder

Specified by:

replication in interface HdfsEndpointBuilderFactory.AdvancedHdfsEndpointProducerBuilder

replication

default HdfsEndpointBuilderFactory.AdvancedHdfsEndpointBuilder replication(String replication)

The HDFS replication factor. The option will be converted to a short type. Default: 3 Group: advanced

Specified by:

replication in interface HdfsEndpointBuilderFactory.AdvancedHdfsEndpointConsumerBuilder

Specified by:

replication in interface HdfsEndpointBuilderFactory.AdvancedHdfsEndpointProducerBuilder

splitStrategy

default HdfsEndpointBuilderFactory.AdvancedHdfsEndpointBuilder splitStrategy(String splitStrategy)

In the current version of Hadoop opening a file in append mode is disabled since it's not very reliable. So, for the moment, it's only possible to create new files. The Camel HDFS endpoint tries to solve this problem in this way: If the split strategy option has been defined, the hdfs path will be used as a directory and files will be created using the configured UuidGenerator. Every time a splitting condition is met, a new file is created. The splitStrategy option is defined as a string with the following syntax: splitStrategy=ST:value,ST:value,... where ST can be: BYTES a new file is created, and the old is closed when the number of written bytes is more than value MESSAGES a new file is created, and the old is closed when the number of written messages is more than value IDLE a new file is created, and the old is closed when no writing happened in the last value milliseconds. The option is a: java.lang.String type. Group: advanced

Specified by:

splitStrategy in interface HdfsEndpointBuilderFactory.AdvancedHdfsEndpointConsumerBuilder

Specified by:

splitStrategy in interface HdfsEndpointBuilderFactory.AdvancedHdfsEndpointProducerBuilder

synchronous

default HdfsEndpointBuilderFactory.AdvancedHdfsEndpointBuilder synchronous(boolean synchronous)

Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). The option is a: boolean type. Default: false Group: advanced

Specified by:

synchronous in interface HdfsEndpointBuilderFactory.AdvancedHdfsEndpointConsumerBuilder

Specified by:

synchronous in interface HdfsEndpointBuilderFactory.AdvancedHdfsEndpointProducerBuilder

synchronous

default HdfsEndpointBuilderFactory.AdvancedHdfsEndpointBuilder synchronous(String synchronous)

Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). The option will be converted to a boolean type. Default: false Group: advanced

Specified by:

synchronous in interface HdfsEndpointBuilderFactory.AdvancedHdfsEndpointConsumerBuilder

Specified by:

synchronous in interface HdfsEndpointBuilderFactory.AdvancedHdfsEndpointProducerBuilder