org.apache.camel.builder.endpoint.dsl

Interface HdfsEndpointBuilderFactory.HdfsEndpointBuilder

All Superinterfaces:

org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver, org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver, HdfsEndpointBuilderFactory.HdfsEndpointConsumerBuilder, HdfsEndpointBuilderFactory.HdfsEndpointProducerBuilder

Enclosing interface:

HdfsEndpointBuilderFactory

public static interface HdfsEndpointBuilderFactory.HdfsEndpointBuilder
extends HdfsEndpointBuilderFactory.HdfsEndpointConsumerBuilder, HdfsEndpointBuilderFactory.HdfsEndpointProducerBuilder

Builder for endpoint for the HDFS component.

Method Summary

Modifier and Type	Method and Description
default HdfsEndpointBuilderFactory.AdvancedHdfsEndpointBuilder	advanced()
default HdfsEndpointBuilderFactory.HdfsEndpointBuilder	connectOnStartup(boolean connectOnStartup) Whether to connect to the HDFS file system on starting the producer/consumer.
default HdfsEndpointBuilderFactory.HdfsEndpointBuilder	connectOnStartup(String connectOnStartup) Whether to connect to the HDFS file system on starting the producer/consumer.
default HdfsEndpointBuilderFactory.HdfsEndpointBuilder	fileSystemType(HdfsEndpointBuilderFactory.HdfsFileSystemType fileSystemType) Set to LOCAL to not use HDFS but local java.io.File instead.
default HdfsEndpointBuilderFactory.HdfsEndpointBuilder	fileSystemType(String fileSystemType) Set to LOCAL to not use HDFS but local java.io.File instead.
default HdfsEndpointBuilderFactory.HdfsEndpointBuilder	fileType(HdfsEndpointBuilderFactory.HdfsFileType fileType) The file type to use.
default HdfsEndpointBuilderFactory.HdfsEndpointBuilder	fileType(String fileType) The file type to use.
default HdfsEndpointBuilderFactory.HdfsEndpointBuilder	kerberosConfigFileLocation(String kerberosConfigFileLocation) The location of the kerb5.conf file (https://web.mit.edu/kerberos/krb5-1.12/doc/admin/conf_files/krb5_conf.html).
default HdfsEndpointBuilderFactory.HdfsEndpointBuilder	kerberosKeytabLocation(String kerberosKeytabLocation) The location of the keytab file used to authenticate with the kerberos nodes (contains pairs of kerberos principals and encrypted keys (which are derived from the Kerberos password)).
default HdfsEndpointBuilderFactory.HdfsEndpointBuilder	kerberosUsername(String kerberosUsername) The username used to authenticate with the kerberos nodes.
default HdfsEndpointBuilderFactory.HdfsEndpointBuilder	keyType(HdfsEndpointBuilderFactory.WritableType keyType) The type for the key in case of sequence or map files.
default HdfsEndpointBuilderFactory.HdfsEndpointBuilder	keyType(String keyType) The type for the key in case of sequence or map files.
default HdfsEndpointBuilderFactory.HdfsEndpointBuilder	namedNodes(String namedNodes) A comma separated list of named nodes (e.g.
default HdfsEndpointBuilderFactory.HdfsEndpointBuilder	owner(String owner) The file owner must match this owner for the consumer to pickup the file.
default HdfsEndpointBuilderFactory.HdfsEndpointBuilder	valueType(HdfsEndpointBuilderFactory.WritableType valueType) The type for the key in case of sequence or map files.
default HdfsEndpointBuilderFactory.HdfsEndpointBuilder	valueType(String valueType) The type for the key in case of sequence or map files.

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

backoffErrorThreshold, backoffErrorThreshold, backoffIdleThreshold, backoffIdleThreshold, backoffMultiplier, backoffMultiplier, bridgeErrorHandler, bridgeErrorHandler, delay, delay, greedy, greedy, initialDelay, initialDelay, maxMessagesPerPoll, maxMessagesPerPoll, pattern, repeatCount, repeatCount, runLoggingLevel, runLoggingLevel, scheduledExecutorService, scheduledExecutorService, scheduler, scheduler, schedulerProperties, schedulerProperties, sendEmptyMessageWhenIdle, sendEmptyMessageWhenIdle, startScheduler, startScheduler, streamDownload, streamDownload, timeUnit, timeUnit, useFixedDelay, useFixedDelay

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

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

append, append, lazyStartProducer, lazyStartProducer, overwrite, overwrite

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

advanced

default HdfsEndpointBuilderFactory.AdvancedHdfsEndpointBuilder advanced()

Specified by:

advanced in interface HdfsEndpointBuilderFactory.HdfsEndpointConsumerBuilder

Specified by:

advanced in interface HdfsEndpointBuilderFactory.HdfsEndpointProducerBuilder

connectOnStartup

default HdfsEndpointBuilderFactory.HdfsEndpointBuilder connectOnStartup(boolean connectOnStartup)

Whether to connect to the HDFS file system on starting the producer/consumer. If false then the connection is created on-demand. Notice that HDFS may take up till 15 minutes to establish a connection, as it has hardcoded 45 x 20 sec redelivery. By setting this option to false allows your application to startup, and not block for up till 15 minutes. The option is a: <code>boolean</code> type. Default: true Group: common

Specified by:

connectOnStartup in interface HdfsEndpointBuilderFactory.HdfsEndpointConsumerBuilder

Specified by:

connectOnStartup in interface HdfsEndpointBuilderFactory.HdfsEndpointProducerBuilder

Parameters:

connectOnStartup - the value to set

Returns:

the dsl builder

connectOnStartup

default HdfsEndpointBuilderFactory.HdfsEndpointBuilder connectOnStartup(String connectOnStartup)

Whether to connect to the HDFS file system on starting the producer/consumer. If false then the connection is created on-demand. Notice that HDFS may take up till 15 minutes to establish a connection, as it has hardcoded 45 x 20 sec redelivery. By setting this option to false allows your application to startup, and not block for up till 15 minutes. The option will be converted to a <code>boolean</code> type. Default: true Group: common

Specified by:

connectOnStartup in interface HdfsEndpointBuilderFactory.HdfsEndpointConsumerBuilder

Specified by:

connectOnStartup in interface HdfsEndpointBuilderFactory.HdfsEndpointProducerBuilder

Parameters:

connectOnStartup - the value to set

Returns:

the dsl builder

fileSystemType

default HdfsEndpointBuilderFactory.HdfsEndpointBuilder fileSystemType(HdfsEndpointBuilderFactory.HdfsFileSystemType fileSystemType)

Set to LOCAL to not use HDFS but local java.io.File instead. The option is a: <code>org.apache.camel.component.hdfs.HdfsFileSystemType</code> type. Default: HDFS Group: common

Specified by:

fileSystemType in interface HdfsEndpointBuilderFactory.HdfsEndpointConsumerBuilder

Specified by:

fileSystemType in interface HdfsEndpointBuilderFactory.HdfsEndpointProducerBuilder

Parameters:

fileSystemType - the value to set

Returns:

the dsl builder

fileSystemType

default HdfsEndpointBuilderFactory.HdfsEndpointBuilder fileSystemType(String fileSystemType)

Set to LOCAL to not use HDFS but local java.io.File instead. The option will be converted to a <code>org.apache.camel.component.hdfs.HdfsFileSystemType</code> type. Default: HDFS Group: common

Specified by:

fileSystemType in interface HdfsEndpointBuilderFactory.HdfsEndpointConsumerBuilder

Specified by:

fileSystemType in interface HdfsEndpointBuilderFactory.HdfsEndpointProducerBuilder

Parameters:

fileSystemType - the value to set

Returns:

the dsl builder

fileType

default HdfsEndpointBuilderFactory.HdfsEndpointBuilder fileType(HdfsEndpointBuilderFactory.HdfsFileType fileType)

The file type to use. For more details see Hadoop HDFS documentation about the various files types. The option is a: <code>org.apache.camel.component.hdfs.HdfsFileType</code> type. Default: NORMAL_FILE Group: common

Specified by:

fileType in interface HdfsEndpointBuilderFactory.HdfsEndpointConsumerBuilder

Specified by:

fileType in interface HdfsEndpointBuilderFactory.HdfsEndpointProducerBuilder

Parameters:

fileType - the value to set

Returns:

the dsl builder

fileType

default HdfsEndpointBuilderFactory.HdfsEndpointBuilder fileType(String fileType)

The file type to use. For more details see Hadoop HDFS documentation about the various files types. The option will be converted to a <code>org.apache.camel.component.hdfs.HdfsFileType</code> type. Default: NORMAL_FILE Group: common

Specified by:

fileType in interface HdfsEndpointBuilderFactory.HdfsEndpointConsumerBuilder

Specified by:

fileType in interface HdfsEndpointBuilderFactory.HdfsEndpointProducerBuilder

Parameters:

fileType - the value to set

Returns:

the dsl builder

keyType

default HdfsEndpointBuilderFactory.HdfsEndpointBuilder keyType(HdfsEndpointBuilderFactory.WritableType keyType)

The type for the key in case of sequence or map files. The option is a: <code>org.apache.camel.component.hdfs.WritableType</code> type. Default: NULL Group: common

Specified by:

keyType in interface HdfsEndpointBuilderFactory.HdfsEndpointConsumerBuilder

Specified by:

keyType in interface HdfsEndpointBuilderFactory.HdfsEndpointProducerBuilder

Parameters:

keyType - the value to set

Returns:

the dsl builder

keyType

default HdfsEndpointBuilderFactory.HdfsEndpointBuilder keyType(String keyType)

The type for the key in case of sequence or map files. The option will be converted to a <code>org.apache.camel.component.hdfs.WritableType</code> type. Default: NULL Group: common

Specified by:

keyType in interface HdfsEndpointBuilderFactory.HdfsEndpointConsumerBuilder

Specified by:

keyType in interface HdfsEndpointBuilderFactory.HdfsEndpointProducerBuilder

Parameters:

keyType - the value to set

Returns:

the dsl builder

namedNodes

default HdfsEndpointBuilderFactory.HdfsEndpointBuilder namedNodes(String namedNodes)

A comma separated list of named nodes (e.g. srv11.example.com:8020,srv12.example.com:8020). The option is a: <code>java.lang.String</code> type. Group: common

Specified by:

namedNodes in interface HdfsEndpointBuilderFactory.HdfsEndpointConsumerBuilder

Specified by:

namedNodes in interface HdfsEndpointBuilderFactory.HdfsEndpointProducerBuilder

Parameters:

namedNodes - the value to set

Returns:

the dsl builder

owner

default HdfsEndpointBuilderFactory.HdfsEndpointBuilder owner(String owner)

The file owner must match this owner for the consumer to pickup the file. Otherwise the file is skipped. The option is a: <code>java.lang.String</code> type. Group: common

Specified by:

owner in interface HdfsEndpointBuilderFactory.HdfsEndpointConsumerBuilder

Specified by:

owner in interface HdfsEndpointBuilderFactory.HdfsEndpointProducerBuilder

Parameters:

owner - the value to set

Returns:

the dsl builder

valueType

default HdfsEndpointBuilderFactory.HdfsEndpointBuilder valueType(HdfsEndpointBuilderFactory.WritableType valueType)

The type for the key in case of sequence or map files. The option is a: <code>org.apache.camel.component.hdfs.WritableType</code> type. Default: BYTES Group: common

Specified by:

valueType in interface HdfsEndpointBuilderFactory.HdfsEndpointConsumerBuilder

Specified by:

valueType in interface HdfsEndpointBuilderFactory.HdfsEndpointProducerBuilder

Parameters:

valueType - the value to set

Returns:

the dsl builder

valueType

default HdfsEndpointBuilderFactory.HdfsEndpointBuilder valueType(String valueType)

The type for the key in case of sequence or map files. The option will be converted to a <code>org.apache.camel.component.hdfs.WritableType</code> type. Default: BYTES Group: common

Specified by:

valueType in interface HdfsEndpointBuilderFactory.HdfsEndpointConsumerBuilder

Specified by:

valueType in interface HdfsEndpointBuilderFactory.HdfsEndpointProducerBuilder

Parameters:

valueType - the value to set

Returns:

the dsl builder

kerberosConfigFileLocation

default HdfsEndpointBuilderFactory.HdfsEndpointBuilder kerberosConfigFileLocation(String kerberosConfigFileLocation)

The location of the kerb5.conf file (https://web.mit.edu/kerberos/krb5-1.12/doc/admin/conf_files/krb5_conf.html). The option is a: <code>java.lang.String</code> type. Group: security

Specified by:

kerberosConfigFileLocation in interface HdfsEndpointBuilderFactory.HdfsEndpointConsumerBuilder

Specified by:

kerberosConfigFileLocation in interface HdfsEndpointBuilderFactory.HdfsEndpointProducerBuilder

Parameters:

kerberosConfigFileLocation - the value to set

Returns:

the dsl builder

kerberosKeytabLocation

default HdfsEndpointBuilderFactory.HdfsEndpointBuilder kerberosKeytabLocation(String kerberosKeytabLocation)

The location of the keytab file used to authenticate with the kerberos nodes (contains pairs of kerberos principals and encrypted keys (which are derived from the Kerberos password)). The option is a: <code>java.lang.String</code> type. Group: security

Specified by:

kerberosKeytabLocation in interface HdfsEndpointBuilderFactory.HdfsEndpointConsumerBuilder

Specified by:

kerberosKeytabLocation in interface HdfsEndpointBuilderFactory.HdfsEndpointProducerBuilder

Parameters:

kerberosKeytabLocation - the value to set

Returns:

the dsl builder

kerberosUsername

default HdfsEndpointBuilderFactory.HdfsEndpointBuilder kerberosUsername(String kerberosUsername)

The username used to authenticate with the kerberos nodes. The option is a: <code>java.lang.String</code> type. Group: security

Specified by:

kerberosUsername in interface HdfsEndpointBuilderFactory.HdfsEndpointConsumerBuilder

Specified by:

kerberosUsername in interface HdfsEndpointBuilderFactory.HdfsEndpointProducerBuilder

Parameters:

kerberosUsername - the value to set

Returns:

the dsl builder