com.hazelcast.jet.pipeline.file

Class FileSourceBuilder<T>

java.lang.Object

com.hazelcast.jet.pipeline.file.FileSourceBuilder<T>

Type Parameters:

T - the type of items a source using this file format will emit

public class FileSourceBuilder<T>
extends Object

A unified builder object for various kinds of file sources.

To create an instance, use FileSources.files(String).

Since:

Jet 4.4

Method Summary

Modifier and Type	Method and Description
BatchSource<T>	build() Builds a BatchSource based on the current state of the builder.
ProcessorMetaSupplier	buildMetaSupplier() Builds a ProcessorMetaSupplier based on the current state of the builder.
<T_NEW> FileSourceBuilder<T_NEW>	format(FileFormat<T_NEW> fileFormat) Set the file format for the source.
FileSourceBuilder<T>	glob(String glob) Sets a glob pattern to filter the files in the specified directory.
FileSourceBuilder<T>	ignoreFileNotFound(boolean ignoreFileNotFound) Set to true to ignore no matching files in the directory specified by path.
FileSourceBuilder<T>	option(String key, String value) Specifies an arbitrary option for the underlying source.
FileSourceBuilder<T>	sharedFileSystem(boolean sharedFileSystem) If sharedFileSystem is true, Jet will assume all members see the same files.
FileSourceBuilder<T>	useHadoopForLocalFiles(boolean useHadoop) Specifies that Jet should use Apache Hadoop for files from the local filesystem.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

glob

public FileSourceBuilder<T> glob(@Nonnull
                                 String glob)

Sets a glob pattern to filter the files in the specified directory. The default value is '*', matching all files in the directory.

Parameters:

glob - glob pattern,

format

@Nonnull
public <T_NEW> FileSourceBuilder<T_NEW> format(@Nonnull
                                                        FileFormat<T_NEW> fileFormat)

Set the file format for the source. See FileFormat for available formats and factory methods.

It's not possible to implement a custom format.

useHadoopForLocalFiles

@Nonnull
public FileSourceBuilder<T> useHadoopForLocalFiles(boolean useHadoop)

Specifies that Jet should use Apache Hadoop for files from the local filesystem. Otherwise, local files are read by Jet directly. One advantage of Hadoop is that it can provide better parallelization when the number of files is smaller than the total parallelism of the pipeline source.

Default value is false.

Parameters:

useHadoop - if Hadoop should be use for reading local filesystem

sharedFileSystem

@Nonnull
public FileSourceBuilder<T> sharedFileSystem(boolean sharedFileSystem)

If sharedFileSystem is true, Jet will assume all members see the same files. They will split the work so that each member will read a part of the files. If sharedFileSystem is false, each member will read all files in the directory, assuming that other members see different files.

This option applies only for the local filesystem when Hadoop is not used and when the directory doesn't contain a prefix for a remote file system. Distributed filesystems are always assumed to be shared.

If you start all the members on a single machine (such as for development), set this property to true. If you have multiple machines with multiple members each and the directory is not a shared storage, it's not possible to configure the file reader correctly - use only one member per machine.

Default value is false.

ignoreFileNotFound

@Nonnull
public FileSourceBuilder<T> ignoreFileNotFound(boolean ignoreFileNotFound)

Set to true to ignore no matching files in the directory specified by path.

When there is no file matching the glob specified by glob(String) (or the default glob) Jet throws an exception by default. This might be problematic in some cases, where the directory is empty. To override this behaviour set this to true.

If set to true and there are no files in the directory the source will produce 0 items.

Default value is false.

Parameters:

ignoreFileNotFound - true if no files in the specified directory should be accepted

option

@Nonnull
public FileSourceBuilder<T> option(String key,
                                            String value)

Specifies an arbitrary option for the underlying source. If you are looking for a missing option, check out the FileFormat class you're using, it offers parsing-related options.

build

@Nonnull
public BatchSource<T> build()

Builds a BatchSource based on the current state of the builder.

buildMetaSupplier

@Nonnull
public ProcessorMetaSupplier buildMetaSupplier()

Builds a ProcessorMetaSupplier based on the current state of the builder. Use for integration with the Core API.

This method is a part of Core API and has lower backward-compatibility guarantees (we can change it in minor version).