OrderedGroupedKVInputConfig.SpecificBuilder (tez-runtime-library 0.7.1 API)

java.lang.Object
- org.apache.tez.runtime.library.conf.OrderedGroupedKVInputConfig.SpecificBuilder<E>

All Implemented Interfaces:: org.apache.tez.runtime.library.conf.OrderedGroupedKVInputConfig.SpecificConfigBuilder<OrderedGroupedKVInputConfig.SpecificBuilder>

Enclosing class:: OrderedGroupedKVInputConfig

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

Method Summary

Methods
Modifier and Type	Method and Description
`E`	`done()`
`OrderedGroupedKVInputConfig.SpecificBuilder<E>`	`setAdditionalConfiguration(Map<String,String> confMap)` Used to set additional configuration parameters which are not set via API methods.
`OrderedGroupedKVInputConfig.SpecificBuilder<E>`	`setAdditionalConfiguration(String key, String value)` Used to set additional configuration parameters which are not set via API methods.
`OrderedGroupedKVInputConfig.SpecificBuilder<E>`	`setCombiner(String combinerClassName)` Configure the combiner class
`OrderedGroupedKVInputConfig.SpecificBuilder<E>`	`setCombiner(String combinerClassName, Map<String,String> combinerConf)` Configure the combiner class and it's associated configuration (specified as key-value pairs).
`OrderedGroupedKVInputConfig.SpecificBuilder<E>`	`setFromConfiguration(org.apache.hadoop.conf.Configuration conf)` Used to build out a configuration from an existing Hadoop `Configuration`.
`OrderedGroupedKVInputConfig.SpecificBuilder<E>`	`setMaxSingleMemorySegmentFraction(float maxSingleSegmentFraction)` Sets a size limit on the maximum segment size to be shuffled to disk.
`OrderedGroupedKVInputConfig.SpecificBuilder<E>`	`setMemToMemMerger(boolean enable)` Enable the memory to memory merger
`OrderedGroupedKVInputConfig.SpecificBuilder<E>`	`setMergeFraction(float mergeFraction)` Configure the point at which in memory segments will be merged.
`OrderedGroupedKVInputConfig.SpecificBuilder<E>`	`setPostMergeBufferFraction(float postMergeBufferFraction)` Sets the buffer fraction, as a fraction of container size, to be used after the fetch and merge are complete.
`OrderedGroupedKVInputConfig.SpecificBuilder<E>`	`setShuffleBufferFraction(float shuffleBufferFraction)` Sets the buffer fraction, as a fraction of container size, to be used while fetching remote data.
`OrderedGroupedKVInputConfig.SpecificBuilder<E>`	`useLegacyInput()` Specifies whether the legacy version of this input should be used.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - useLegacyInput
```
public OrderedGroupedKVInputConfig.SpecificBuilder<E> useLegacyInput()
```
    Description copied from interface: org.apache.tez.runtime.library.conf.OrderedGroupedKVInputConfig.SpecificConfigBuilder
    
    Specifies whether the legacy version of this input should be used.
    
    Specified by:
    
    useLegacyInput in interface org.apache.tez.runtime.library.conf.OrderedGroupedKVInputConfig.SpecificConfigBuilder<OrderedGroupedKVInputConfig.SpecificBuilder>
    
    Returns:
    instance of the current builder
  - setShuffleBufferFraction
```
public OrderedGroupedKVInputConfig.SpecificBuilder<E> setShuffleBufferFraction(float shuffleBufferFraction)
```
    Description copied from interface: org.apache.tez.runtime.library.conf.OrderedGroupedKVInputConfig.SpecificConfigBuilder
    
    Sets the buffer fraction, as a fraction of container size, to be used while fetching remote data.
    
    Specified by:
    
    setShuffleBufferFraction in interface org.apache.tez.runtime.library.conf.OrderedGroupedKVInputConfig.SpecificConfigBuilder<OrderedGroupedKVInputConfig.SpecificBuilder>
    
    Parameters:
    shuffleBufferFraction - fraction of container size
    
    Returns:
    instance of the current builder
  - setPostMergeBufferFraction
```
public OrderedGroupedKVInputConfig.SpecificBuilder<E> setPostMergeBufferFraction(float postMergeBufferFraction)
```
    Description copied from interface: org.apache.tez.runtime.library.conf.OrderedGroupedKVInputConfig.SpecificConfigBuilder
    
    Sets the buffer fraction, as a fraction of container size, to be used after the fetch and merge are complete. This buffer is used to cache merged data and avoids writing it out to disk.
    
    Specified by:
    
    setPostMergeBufferFraction in interface org.apache.tez.runtime.library.conf.OrderedGroupedKVInputConfig.SpecificConfigBuilder<OrderedGroupedKVInputConfig.SpecificBuilder>
    
    Parameters:
    postMergeBufferFraction - fraction of container size
    
    Returns:
    instance of the current builder
  - setMaxSingleMemorySegmentFraction
```
public OrderedGroupedKVInputConfig.SpecificBuilder<E> setMaxSingleMemorySegmentFraction(float maxSingleSegmentFraction)
```
    Description copied from interface: org.apache.tez.runtime.library.conf.OrderedGroupedKVInputConfig.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 org.apache.tez.runtime.library.conf.OrderedGroupedKVInputConfig.SpecificConfigBuilder<OrderedGroupedKVInputConfig.SpecificBuilder>
    
    Parameters:
    maxSingleSegmentFraction - fraction of memory determined by ShuffleBufferFraction
    
    Returns:
    instance of the current builder
  - setMemToMemMerger
```
public OrderedGroupedKVInputConfig.SpecificBuilder<E> setMemToMemMerger(boolean enable)
```
    Description copied from interface: org.apache.tez.runtime.library.conf.OrderedGroupedKVInputConfig.SpecificConfigBuilder
    
    Enable the memory to memory merger
    
    Specified by:
    
    setMemToMemMerger in interface org.apache.tez.runtime.library.conf.OrderedGroupedKVInputConfig.SpecificConfigBuilder<OrderedGroupedKVInputConfig.SpecificBuilder>
    
    Parameters:
    enable - whether to enable the memory to memory merger
    
    Returns:
    instance of the current builder
  - setMergeFraction
```
public OrderedGroupedKVInputConfig.SpecificBuilder<E> setMergeFraction(float mergeFraction)
```
    Description copied from interface: org.apache.tez.runtime.library.conf.OrderedGroupedKVInputConfig.SpecificConfigBuilder
    
    Configure the point at which in memory segments will be merged. This is specified as a fraction of the shuffle buffer.
    
    Specified by:
    
    setMergeFraction in interface org.apache.tez.runtime.library.conf.OrderedGroupedKVInputConfig.SpecificConfigBuilder<OrderedGroupedKVInputConfig.SpecificBuilder>
    
    Parameters:
    mergeFraction - fraction of memory determined by ShuffleBufferFraction, which when filled, will trigger a merge
    
    Returns:
    instance of the current builder
  - setCombiner
```
public OrderedGroupedKVInputConfig.SpecificBuilder<E> setCombiner(String combinerClassName)
```
    Description copied from interface: org.apache.tez.runtime.library.conf.OrderedGroupedKVInputConfig.SpecificConfigBuilder
    
    Configure the combiner class
    
    Specified by:
    
    setCombiner in interface org.apache.tez.runtime.library.conf.OrderedGroupedKVInputConfig.SpecificConfigBuilder<OrderedGroupedKVInputConfig.SpecificBuilder>
    
    Parameters:
    combinerClassName - the combiner class name
    
    Returns:
    instance of the current builder
  - setCombiner
```
public OrderedGroupedKVInputConfig.SpecificBuilder<E> setCombiner(String combinerClassName,
                                                         Map<String,String> combinerConf)
```
    Description copied from interface: org.apache.tez.runtime.library.conf.OrderedGroupedKVInputConfig.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. OrderedGroupedKVInputConfig.SpecificConfigBuilder.setCombiner(String) is the preferred method for setting a combiner.
    
    Specified by:
    
    setCombiner in interface org.apache.tez.runtime.library.conf.OrderedGroupedKVInputConfig.SpecificConfigBuilder<OrderedGroupedKVInputConfig.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
  - setAdditionalConfiguration
```
public OrderedGroupedKVInputConfig.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 OrderedGroupedKVInputConfig.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 OrderedGroupedKVInputConfig.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()
```

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

Method Summary

Methods inherited from class java.lang.Object

Method Detail

useLegacyInput

setShuffleBufferFraction

setPostMergeBufferFraction

setMaxSingleMemorySegmentFraction

setMemToMemMerger

setMergeFraction

setCombiner

setCombiner

setAdditionalConfiguration

setAdditionalConfiguration

setFromConfiguration

done