org.gridgain.grid.ggfs.mapreduce

Interface GridGgfsTaskArgs<T>

public interface GridGgfsTaskArgs<T>

GGFS task arguments. When you initiate new GGFS task execution using one of GridGgfs.execute(...) methods, all passed parameters are encapsulated in a single GridGgfsTaskArgs object. Later on this object is passed to GridGgfsTask.createJob(GridGgfsPath, GridGgfsFileRange, GridGgfsTaskArgs) method.

Task arguments encapsulates the following data:

• GGFS name
• File paths passed to GridGgfs.execute() method
• GridGgfsRecordResolver for that task
• Flag indicating whether to skip non-existent file paths or throw an exception
• User-defined task argument
• Maximum file range length for that task (see GridGgfsConfiguration.getMaximumTaskRangeLength())

Method Summary

Methods

Modifier and Type	Method and Description
String	ggfsName() Gets GGFS name.
long	maxRangeLength() Optional maximum allowed range length, 0 by default.
Collection<GridGgfsPath>	paths() Gets file paths to process.
GridGgfsRecordResolver	recordResolver() Gets record resolver for the task.
boolean	skipNonExistentFiles() Flag indicating whether to fail or simply skip non-existent files.
T	userArgument() User argument provided for task execution.

Method Detail

ggfsName

String ggfsName()

Gets GGFS name.

Returns:

GGFS name.

paths

Collection<GridGgfsPath> paths()

Gets file paths to process.

Returns:

File paths to process.

recordResolver

GridGgfsRecordResolver recordResolver()

Gets record resolver for the task.

Returns:

Record resolver.

skipNonExistentFiles

boolean skipNonExistentFiles()

Flag indicating whether to fail or simply skip non-existent files.

Returns:

True if non-existent files should be skipped.

userArgument

T userArgument()

User argument provided for task execution.

Returns:

User argument.

maxRangeLength

long maxRangeLength()

Optional maximum allowed range length, 0 by default. If not specified, full range including all consecutive blocks will be used without any limitations.

Returns:

Maximum range length.