org.apache.tez.runtime.library.conf

Class UnorderedKVInputConfig.SpecificBuilder<E extends HadoopKeyValuesBasedBaseEdgeConfig.Builder>

java.lang.Object

org.apache.tez.runtime.library.conf.UnorderedKVInputConfig.SpecificBuilder<E>

All Implemented Interfaces:

UnorderedKVInputConfig.SpecificConfigBuilder<UnorderedKVInputConfig.SpecificBuilder>

Enclosing class:

UnorderedKVInputConfig

@InterfaceAudience.Public
@InterfaceStability.Evolving
public static class UnorderedKVInputConfig.SpecificBuilder<E extends HadoopKeyValuesBasedBaseEdgeConfig.Builder>
extends Object
implements UnorderedKVInputConfig.SpecificConfigBuilder<UnorderedKVInputConfig.SpecificBuilder>

Method Summary

Methods

Modifier and Type	Method and Description
E	done()
UnorderedKVInputConfig.SpecificBuilder<E>	setAdditionalConfiguration(Map<String,String> confMap) Used to set additional configuration parameters which are not set via API methods.
UnorderedKVInputConfig.SpecificBuilder<E>	setAdditionalConfiguration(String key, String value) Used to set additional configuration parameters which are not set via API methods.
UnorderedKVInputConfig.SpecificBuilder<E>	setFromConfiguration(org.apache.hadoop.conf.Configuration conf) Used to build out a configuration from an existing Hadoop Configuration.
UnorderedKVInputConfig.SpecificBuilder<E>	setMaxSingleMemorySegmentFraction(float maxSingleSegmentFraction) Sets a size limit on the maximum segment size to be shuffled to disk.
UnorderedKVInputConfig.SpecificBuilder<E>	setMergeFraction(float mergeFraction) Configure the point at which in memory segments will be merged and written out to a single large disk segment.
UnorderedKVInputConfig.SpecificBuilder<E>	setShuffleBufferFraction(float shuffleBufferFraction) Sets the buffer fraction, as a fraction of container size, to be used while fetching remote data.

Methods inherited from class java.lang.Object

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

Method Detail

setShuffleBufferFraction

public UnorderedKVInputConfig.SpecificBuilder<E> setShuffleBufferFraction(float shuffleBufferFraction)

Description copied from interface: UnorderedKVInputConfig.SpecificConfigBuilder

Sets the buffer fraction, as a fraction of container size, to be used while fetching remote data.

Specified by:

setShuffleBufferFraction in interface UnorderedKVInputConfig.SpecificConfigBuilder<UnorderedKVInputConfig.SpecificBuilder>

Parameters:

shuffleBufferFraction - fraction of container size

Returns:

instance of the current builder

setMaxSingleMemorySegmentFraction

public UnorderedKVInputConfig.SpecificBuilder<E> setMaxSingleMemorySegmentFraction(float maxSingleSegmentFraction)

Description copied from interface: UnorderedKVInputConfig.SpecificConfigBuilder

Sets a size limit on the maximum segment size to be shuffled to disk. This is a fraction of the shuffle buffer.

Specified by:

setMaxSingleMemorySegmentFraction in interface UnorderedKVInputConfig.SpecificConfigBuilder<UnorderedKVInputConfig.SpecificBuilder>

Parameters:

maxSingleSegmentFraction - fraction of memory determined by ShuffleBufferFraction

Returns:

instance of the current builder

setMergeFraction

public UnorderedKVInputConfig.SpecificBuilder<E> setMergeFraction(float mergeFraction)

Description copied from interface: UnorderedKVInputConfig.SpecificConfigBuilder

Configure the point at which in memory segments will be merged and written out to a single large disk segment. This is specified as a fraction of the shuffle buffer.

Has no affect at the moment.

Specified by:

setMergeFraction in interface UnorderedKVInputConfig.SpecificConfigBuilder<UnorderedKVInputConfig.SpecificBuilder>

Parameters:

mergeFraction - fraction of memory determined by ShuffleBufferFraction, which when filled, will trigger a merge

Returns:

instance of the current builder

setAdditionalConfiguration

public UnorderedKVInputConfig.SpecificBuilder<E> setAdditionalConfiguration(String key,
                                                                   String value)

Used to set additional configuration parameters which are not set via API methods. This is primarily meant for rarely used configuration options such as IFile read-ahead, configuring the number of parallel files to merge etc.

Parameters:

key - the key to set

value - the corresponding value

Returns:

this object for further chained method calls

setAdditionalConfiguration

public UnorderedKVInputConfig.SpecificBuilder<E> setAdditionalConfiguration(Map<String,String> confMap)

Used to set additional configuration parameters which are not set via API methods. This is primarily meant for rarely used configuration options such as IFile read-ahead, configuring the number of parallel files to merge etc.

Additionally keys set via this method are made available to the combiner.

Parameters:

confMap - map of configuration key-value pairs

Returns:

this object for further chained method calls

setFromConfiguration

public UnorderedKVInputConfig.SpecificBuilder<E> setFromConfiguration(org.apache.hadoop.conf.Configuration conf)

Used to build out a configuration from an existing Hadoop Configuration. This is a private API is present only for compatibility and ease of use for existing systems which rely heavily on Configuration.

Returns:

this object for further chained method calls

done

public E done()