org.apache.tez.runtime.library.conf

Class OrderedPartitionedKVOutputConfig.SpecificBuilder<E extends org.apache.tez.runtime.library.conf.HadoopKeyValuesBasedBaseEdgeConfig.Builder>

java.lang.Object

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

All Implemented Interfaces:

org.apache.tez.runtime.library.conf.OrderedPartitionedKVOutputConfig.SpecificConfigBuilder<OrderedPartitionedKVOutputConfig.SpecificBuilder>

Enclosing class:

OrderedPartitionedKVOutputConfig

@InterfaceAudience.Public
@InterfaceStability.Evolving
public static class OrderedPartitionedKVOutputConfig.SpecificBuilder<E extends org.apache.tez.runtime.library.conf.HadoopKeyValuesBasedBaseEdgeConfig.Builder>
extends Object
implements org.apache.tez.runtime.library.conf.OrderedPartitionedKVOutputConfig.SpecificConfigBuilder<OrderedPartitionedKVOutputConfig.SpecificBuilder>

Method Summary

Methods

Modifier and Type	Method and Description
E	done()
OrderedPartitionedKVOutputConfig.SpecificBuilder<E>	setAdditionalConfiguration(Map<String,String> confMap) Used to set additional configuration parameters which are not set via API methods.
OrderedPartitionedKVOutputConfig.SpecificBuilder<E>	setAdditionalConfiguration(String key, String value) Used to set additional configuration parameters which are not set via API methods.
OrderedPartitionedKVOutputConfig.SpecificBuilder<E>	setCombiner(String combinerClassName) Configure the combiner class
OrderedPartitionedKVOutputConfig.SpecificBuilder<E>	setCombiner(String combinerClassName, Map<String,String> combinerConf) Configure the combiner class and it's associated configuration (specified as key-value pairs).
OrderedPartitionedKVOutputConfig.SpecificBuilder<E>	setFromConfiguration(org.apache.hadoop.conf.Configuration conf) Used to build out a configuration from an existing Hadoop Configuration.
OrderedPartitionedKVOutputConfig.SpecificBuilder<E>	setSortBufferSize(int sortBufferSize) Set the buffer size to use when sort the output
OrderedPartitionedKVOutputConfig.SpecificBuilder	setSorter(org.apache.tez.runtime.library.conf.OrderedPartitionedKVOutputConfig.SorterImpl sorterImpl) Configure which sorter implementation to be used
OrderedPartitionedKVOutputConfig.SpecificBuilder<E>	setSorterNumThreads(int numThreads) Configure the number of threads to be used by the sorter

Methods inherited from class java.lang.Object

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

Method Detail

setSortBufferSize

public OrderedPartitionedKVOutputConfig.SpecificBuilder<E> setSortBufferSize(int sortBufferSize)

Description copied from interface: org.apache.tez.runtime.library.conf.OrderedPartitionedKVOutputConfig.SpecificConfigBuilder

Set the buffer size to use when sort the output

Specified by:

setSortBufferSize in interface org.apache.tez.runtime.library.conf.OrderedPartitionedKVOutputConfig.SpecificConfigBuilder<OrderedPartitionedKVOutputConfig.SpecificBuilder>

Parameters:

sortBufferSize - the size of the buffer in MB

Returns:

instance of the current builder

setCombiner

public OrderedPartitionedKVOutputConfig.SpecificBuilder<E> setCombiner(String combinerClassName)

Description copied from interface: org.apache.tez.runtime.library.conf.OrderedPartitionedKVOutputConfig.SpecificConfigBuilder

Configure the combiner class

Specified by:

setCombiner in interface org.apache.tez.runtime.library.conf.OrderedPartitionedKVOutputConfig.SpecificConfigBuilder<OrderedPartitionedKVOutputConfig.SpecificBuilder>

Parameters:

combinerClassName - the combiner class name

Returns:

instance of the current builder

setCombiner

public OrderedPartitionedKVOutputConfig.SpecificBuilder<E> setCombiner(String combinerClassName,
                                                              Map<String,String> combinerConf)

Description copied from interface: org.apache.tez.runtime.library.conf.OrderedPartitionedKVOutputConfig.SpecificConfigBuilder

Configure the combiner class and it's associated configuration (specified as key-value pairs). This method should only be used if the combiner requires some specific configuration. OrderedPartitionedKVOutputConfig.SpecificConfigBuilder.setCombiner(String) is the preferred method for setting a combiner.

Specified by:

setCombiner in interface org.apache.tez.runtime.library.conf.OrderedPartitionedKVOutputConfig.SpecificConfigBuilder<OrderedPartitionedKVOutputConfig.SpecificBuilder>

Parameters:

combinerClassName - the combiner class name

combinerConf - the combiner configuration. This can be null, and otherwise is a Map of key-value pairs. The keys should be limited to the ones required by the combiner.

Returns:

instance of the current builder

setSorterNumThreads

public OrderedPartitionedKVOutputConfig.SpecificBuilder<E> setSorterNumThreads(int numThreads)

Description copied from interface: org.apache.tez.runtime.library.conf.OrderedPartitionedKVOutputConfig.SpecificConfigBuilder

Configure the number of threads to be used by the sorter

Specified by:

setSorterNumThreads in interface org.apache.tez.runtime.library.conf.OrderedPartitionedKVOutputConfig.SpecificConfigBuilder<OrderedPartitionedKVOutputConfig.SpecificBuilder>

Parameters:

numThreads - the number of threads

Returns:

instance of the current builder

setSorter

public OrderedPartitionedKVOutputConfig.SpecificBuilder setSorter(org.apache.tez.runtime.library.conf.OrderedPartitionedKVOutputConfig.SorterImpl sorterImpl)

Description copied from interface: org.apache.tez.runtime.library.conf.OrderedPartitionedKVOutputConfig.SpecificConfigBuilder

Configure which sorter implementation to be used

Specified by:

setSorter in interface org.apache.tez.runtime.library.conf.OrderedPartitionedKVOutputConfig.SpecificConfigBuilder<OrderedPartitionedKVOutputConfig.SpecificBuilder>

Parameters:

sorterImpl - Use an in-built sorter implementations.

Returns:

instance of the current builder

setAdditionalConfiguration

public OrderedPartitionedKVOutputConfig.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 OrderedPartitionedKVOutputConfig.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 OrderedPartitionedKVOutputConfig.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()