Org.Apache.REEF.IMRU.API.IMRUJobDefinitionBuilder Class Reference

Use this class to create an IMRU Job Definition. More...

Public Member Functions
	IMRUJobDefinitionBuilder ()
	Constructor More...
IMRUJobDefinitionBuilder	SetJobName (string name)
	Set the name of the job. More...
IMRUJobDefinitionBuilder	SetMapTaskStateConfiguration (IConfiguration mapTaskStateConfiguration)
	Sets configuration of map task state More...
IMRUJobDefinitionBuilder	SetUpdateTaskStateConfiguration (IConfiguration updateTaskStateConfiguration)
	Sets configuration of update task state More...
IMRUJobDefinitionBuilder	SetMapFunctionConfiguration (IConfiguration mapFunctionConfiguration)
	Sets configuration of map function More...
IMRUJobDefinitionBuilder	SetMapInputCodecConfiguration (IConfiguration mapInputCodecConfiguration)
	Sets configuration of codec for TMapInput More...
IMRUJobDefinitionBuilder	SetUpdateFunctionCodecsConfiguration (IConfiguration updateFunctionCodecsConfiguration)
	Sets configuration of codecs needed by Update function More...
IMRUJobDefinitionBuilder	SetReduceFunctionConfiguration (IConfiguration reduceFunctionConfiguration)
	Sets configuration of reduce function More...
IMRUJobDefinitionBuilder	SetUpdateFunctionConfiguration (IConfiguration updateFunctionConfiguration)
	Sets configuration of update function More...
IMRUJobDefinitionBuilder	SetMapOutputPipelineDataConverterConfiguration (IConfiguration mapOutputPipelineDataConverterConfiguration)
	Sets configuration of PipelineDataConverter for Map output More...
IMRUJobDefinitionBuilder	SetMapInputPipelineDataConverterConfiguration (IConfiguration mapInputPipelineDataConverterConfiguration)
	Sets configuration of PipelineDataConverter for Map Input More...
IMRUJobDefinitionBuilder	SetPartitionedDatasetConfiguration (IConfiguration partitionedDatasetConfiguration)
	Sets configuration of partitioned dataset More...
IMRUJobDefinitionBuilder	SetNumberOfMappers (int numberOfMappers)
	Sets Number of mappers More...
IMRUJobDefinitionBuilder	SetMapperMemory (int memory)
	Sets mapper memory More...
IMRUJobDefinitionBuilder	SetUpdateTaskMemory (int memory)
	Set update task memory More...
IMRUJobDefinitionBuilder	SetMapTaskCores (int cores)
	Sets cores for map tasks More...
IMRUJobDefinitionBuilder	SetUpdateTaskCores (int cores)
	Set update task cores More...
IMRUJobDefinitionBuilder	SetMaxRetryNumberInRecovery (int maxRetryNumberInRecovery)
	Set max number of retries done if first run of IMRU job failed. More...
IMRUJobDefinitionBuilder	SetPerMapConfigurations (IConfiguration perMapperConfig)
	Sets Per Map Configuration More...
IMRUJobDefinitionBuilder	SetResultHandlerConfiguration (IConfiguration resultHandlerConfig)
	Sets Result handler Configuration More...
IMRUJobDefinitionBuilder	InvokeGarbageCollectorAfterIteration (bool invokeGC)
	Whether to invoke Garbage Collector after each IMRU iteration More...
IMRUJobDefinitionBuilder	SetJobCancellationConfiguration (IConfiguration cancelSignalConfiguration)
	Sets configuration for cancellation signal detection. More...
IMRUJobDefinition	Build ()
	Instantiate the IMRUJobDefinition. More...

Detailed Description

Use this class to create an IMRU Job Definition.

See also

IMRUJobDefinition

Constructor & Destructor Documentation

IMRUJobDefinitionBuilder()

Org.Apache.REEF.IMRU.API.IMRUJobDefinitionBuilder.IMRUJobDefinitionBuilder ( )

inline

Constructor

Member Function Documentation

Build()

IMRUJobDefinition Org.Apache.REEF.IMRU.API.IMRUJobDefinitionBuilder.Build ( )

inline

Instantiate the IMRUJobDefinition.

Returns

The IMRUJobDefintion configured.

Exceptions

NullReferenceException

If any of the required parameters is not set.

InvokeGarbageCollectorAfterIteration()

IMRUJobDefinitionBuilder Org.Apache.REEF.IMRU.API.IMRUJobDefinitionBuilder.InvokeGarbageCollectorAfterIteration ( bool  invokeGC )

inline

Whether to invoke Garbage Collector after each IMRU iteration

Parameters

invokeGC

variable telling whether to invoke or not

Returns

The modified definition builder

SetJobCancellationConfiguration()

IMRUJobDefinitionBuilder Org.Apache.REEF.IMRU.API.IMRUJobDefinitionBuilder.SetJobCancellationConfiguration ( IConfiguration  cancelSignalConfiguration )

inline

Sets configuration for cancellation signal detection.

Parameters

cancelSignalConfiguration

Returns

SetJobName()

IMRUJobDefinitionBuilder Org.Apache.REEF.IMRU.API.IMRUJobDefinitionBuilder.SetJobName ( string  name )

inline

Set the name of the job.

Parameters

name	the name of the job

Returns

this

SetMapFunctionConfiguration()

IMRUJobDefinitionBuilder Org.Apache.REEF.IMRU.API.IMRUJobDefinitionBuilder.SetMapFunctionConfiguration ( IConfiguration  mapFunctionConfiguration )

inline

Sets configuration of map function

Parameters

mapFunctionConfiguration

Configuration

Returns

this

SetMapInputCodecConfiguration()

IMRUJobDefinitionBuilder Org.Apache.REEF.IMRU.API.IMRUJobDefinitionBuilder.SetMapInputCodecConfiguration ( IConfiguration  mapInputCodecConfiguration )

inline

Sets configuration of codec for TMapInput

Parameters

mapInputCodecConfiguration

Configuration

Returns

this

SetMapInputPipelineDataConverterConfiguration()

IMRUJobDefinitionBuilder Org.Apache.REEF.IMRU.API.IMRUJobDefinitionBuilder.SetMapInputPipelineDataConverterConfiguration ( IConfiguration  mapInputPipelineDataConverterConfiguration )

inline

Sets configuration of PipelineDataConverter for Map Input

Parameters

mapInputPipelineDataConverterConfiguration

Configuration

Returns

this

SetMapOutputPipelineDataConverterConfiguration()

IMRUJobDefinitionBuilder Org.Apache.REEF.IMRU.API.IMRUJobDefinitionBuilder.SetMapOutputPipelineDataConverterConfiguration ( IConfiguration  mapOutputPipelineDataConverterConfiguration )

inline

Sets configuration of PipelineDataConverter for Map output

Parameters

mapOutputPipelineDataConverterConfiguration

Configuration

Returns

this

SetMapperMemory()

IMRUJobDefinitionBuilder Org.Apache.REEF.IMRU.API.IMRUJobDefinitionBuilder.SetMapperMemory ( int  memory )

inline

Sets mapper memory

Parameters

memory

memory in MB

Returns

SetMapTaskCores()

IMRUJobDefinitionBuilder Org.Apache.REEF.IMRU.API.IMRUJobDefinitionBuilder.SetMapTaskCores ( int  cores )

inline

Sets cores for map tasks

Parameters

cores

number of cores

Returns

SetMapTaskStateConfiguration()

IMRUJobDefinitionBuilder Org.Apache.REEF.IMRU.API.IMRUJobDefinitionBuilder.SetMapTaskStateConfiguration ( IConfiguration  mapTaskStateConfiguration )

inline

Sets configuration of map task state

Parameters

mapTaskStateConfiguration

Configuration for map task state

Returns

this

SetMaxRetryNumberInRecovery()

IMRUJobDefinitionBuilder Org.Apache.REEF.IMRU.API.IMRUJobDefinitionBuilder.SetMaxRetryNumberInRecovery ( int  maxRetryNumberInRecovery )

inline

Set max number of retries done if first run of IMRU job failed.

Parameters

maxRetryNumberInRecovery

Max number of retries

Returns

SetNumberOfMappers()

IMRUJobDefinitionBuilder Org.Apache.REEF.IMRU.API.IMRUJobDefinitionBuilder.SetNumberOfMappers ( int  numberOfMappers )

inline

Sets Number of mappers

Parameters

numberOfMappers

Number of mappers

Returns

this

TODO: This is duplicate in a sense that it can be determined TODO: automatically from IPartitionedDataset. However, right now TODO: GroupComm. instantiated in IMRUDriver needs this parameter TODO: in constructor. This will be removed once we remove it from GroupComm.

SetPartitionedDatasetConfiguration()

IMRUJobDefinitionBuilder Org.Apache.REEF.IMRU.API.IMRUJobDefinitionBuilder.SetPartitionedDatasetConfiguration ( IConfiguration  partitionedDatasetConfiguration )

inline

Sets configuration of partitioned dataset

Parameters

partitionedDatasetConfiguration

Configuration

Returns

this

SetPerMapConfigurations()

IMRUJobDefinitionBuilder Org.Apache.REEF.IMRU.API.IMRUJobDefinitionBuilder.SetPerMapConfigurations ( IConfiguration  perMapperConfig )

inline

Sets Per Map Configuration

Parameters

perMapperConfig

Mapper configs

Returns

SetReduceFunctionConfiguration()

IMRUJobDefinitionBuilder Org.Apache.REEF.IMRU.API.IMRUJobDefinitionBuilder.SetReduceFunctionConfiguration ( IConfiguration  reduceFunctionConfiguration )

inline

Sets configuration of reduce function

Parameters

reduceFunctionConfiguration

Configuration

Returns

this

SetResultHandlerConfiguration()

IMRUJobDefinitionBuilder Org.Apache.REEF.IMRU.API.IMRUJobDefinitionBuilder.SetResultHandlerConfiguration ( IConfiguration  resultHandlerConfig )

inline

Sets Result handler Configuration

Parameters

resultHandlerConfig

Result handler config

Returns

SetUpdateFunctionCodecsConfiguration()

IMRUJobDefinitionBuilder Org.Apache.REEF.IMRU.API.IMRUJobDefinitionBuilder.SetUpdateFunctionCodecsConfiguration ( IConfiguration  updateFunctionCodecsConfiguration )

inline

Sets configuration of codecs needed by Update function

Parameters

updateFunctionCodecsConfiguration

Configuration

Returns

this

SetUpdateFunctionConfiguration()

IMRUJobDefinitionBuilder Org.Apache.REEF.IMRU.API.IMRUJobDefinitionBuilder.SetUpdateFunctionConfiguration ( IConfiguration  updateFunctionConfiguration )

inline

Sets configuration of update function

Parameters

updateFunctionConfiguration

Configuration

Returns

this

SetUpdateTaskCores()

IMRUJobDefinitionBuilder Org.Apache.REEF.IMRU.API.IMRUJobDefinitionBuilder.SetUpdateTaskCores ( int  cores )

inline

Set update task cores

Parameters

cores

number of cores

Returns

SetUpdateTaskMemory()

IMRUJobDefinitionBuilder Org.Apache.REEF.IMRU.API.IMRUJobDefinitionBuilder.SetUpdateTaskMemory ( int  memory )

inline

Set update task memory

Parameters

memory

memory in MB

Returns

SetUpdateTaskStateConfiguration()

IMRUJobDefinitionBuilder Org.Apache.REEF.IMRU.API.IMRUJobDefinitionBuilder.SetUpdateTaskStateConfiguration ( IConfiguration  updateTaskStateConfiguration )

inline

Sets configuration of update task state

Parameters

updateTaskStateConfiguration

Configuration for update task state

Returns

this

---

The documentation for this class was generated from the following file:

• lang/cs/Org.Apache.REEF.IMRU/API/IMRUJobDefinitionBuilder.cs