org.apache.tez.runtime.library.conf

Class OrderedPartitionedKVEdgeConfig.Builder

java.lang.Object

org.apache.tez.runtime.library.conf.HadoopKeyValuesBasedBaseEdgeConfig.Builder<OrderedPartitionedKVEdgeConfig.Builder>

org.apache.tez.runtime.library.conf.OrderedPartitionedKVEdgeConfig.Builder

Enclosing class:

OrderedPartitionedKVEdgeConfig

@InterfaceAudience.Public
@InterfaceStability.Evolving
public static class OrderedPartitionedKVEdgeConfig.Builder
extends org.apache.tez.runtime.library.conf.HadoopKeyValuesBasedBaseEdgeConfig.Builder<OrderedPartitionedKVEdgeConfig.Builder>

Method Summary

Methods

Modifier and Type	Method and Description
OrderedPartitionedKVEdgeConfig	build() Build and return an instance of the configuration
OrderedGroupedKVInputConfig.SpecificBuilder<OrderedPartitionedKVEdgeConfig.Builder>	configureInput() Configure the specific input
OrderedPartitionedKVOutputConfig.SpecificBuilder<OrderedPartitionedKVEdgeConfig.Builder>	configureOutput() Configure the specific output
OrderedPartitionedKVEdgeConfig.Builder	setAdditionalConfiguration(Map<String,String> confMap)
OrderedPartitionedKVEdgeConfig.Builder	setAdditionalConfiguration(String key, String value)
OrderedPartitionedKVEdgeConfig.Builder	setCompression(boolean enabled, String compressionCodec, Map<String,String> codecConf) Enable compression for the specific Input / Output / Edge
OrderedPartitionedKVEdgeConfig.Builder	setFromConfiguration(org.apache.hadoop.conf.Configuration conf)
OrderedPartitionedKVEdgeConfig.Builder	setKeyComparatorClass(String comparatorClassName) Set the key comparator class
OrderedPartitionedKVEdgeConfig.Builder	setKeyComparatorClass(String comparatorClassName, Map<String,String> comparatorConf) Set the key comparator class and it's associated configuration.
OrderedPartitionedKVEdgeConfig.Builder	setKeySerializationClass(String serializationClassName, String comparatorClassName, Map<String,String> serializerConf) Set serialization class and the relevant comparator to be used for sorting.
OrderedPartitionedKVEdgeConfig.Builder	setValueSerializationClass(String serializationClassName, Map<String,String> serializerConf) Set serialization class responsible for providing serializer/deserializer for values.

Methods inherited from class java.lang.Object

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

Method Detail

setKeyComparatorClass

public OrderedPartitionedKVEdgeConfig.Builder setKeyComparatorClass(String comparatorClassName)

Set the key comparator class

Parameters:

comparatorClassName - the key comparator class name

Returns:

instance of the current builder

setKeyComparatorClass

public OrderedPartitionedKVEdgeConfig.Builder setKeyComparatorClass(String comparatorClassName,
                                                           @Nullable
                                                           Map<String,String> comparatorConf)

Set the key comparator class and it's associated configuration. This method should only be used if the comparator requires some specific configuration, which is typically not the case. setKeyComparatorClass(String) is the preferred method for setting a comparator.

Parameters:

comparatorClassName - the key comparator class name

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

Returns:

instance of the current builder

setKeySerializationClass

public OrderedPartitionedKVEdgeConfig.Builder setKeySerializationClass(String serializationClassName,
                                                              String comparatorClassName,
                                                              @Nullable
                                                              Map<String,String> serializerConf)

Set serialization class and the relevant comparator to be used for sorting. Providing custom serialization class could change the way, keys needs to be compared in sorting. Providing invalid comparator here could create invalid results.

Parameters:

serializationClassName -

comparatorClassName -

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

Returns:

this object for further chained method calls

setValueSerializationClass

public OrderedPartitionedKVEdgeConfig.Builder setValueSerializationClass(String serializationClassName,
                                                                @Nullable
                                                                Map<String,String> serializerConf)

Set serialization class responsible for providing serializer/deserializer for values.

Parameters:

serializationClassName -

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

Returns:

this object for further chained method calls

setCompression

public OrderedPartitionedKVEdgeConfig.Builder setCompression(boolean enabled,
                                                    @Nullable
                                                    String compressionCodec,
                                                    @Nullable
                                                    Map<String,String> codecConf)

Description copied from class: org.apache.tez.runtime.library.conf.HadoopKeyValuesBasedBaseEdgeConfig.Builder

Enable compression for the specific Input / Output / Edge

Specified by:

setCompression in class org.apache.tez.runtime.library.conf.HadoopKeyValuesBasedBaseEdgeConfig.Builder<OrderedPartitionedKVEdgeConfig.Builder>

Parameters:

enabled - whether to enable compression or not

compressionCodec - the codec to be used if compression is enabled. null implies using the default

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

Returns:

instance of the current builder

setAdditionalConfiguration

public OrderedPartitionedKVEdgeConfig.Builder setAdditionalConfiguration(String key,
                                                                String value)

setAdditionalConfiguration

public OrderedPartitionedKVEdgeConfig.Builder setAdditionalConfiguration(Map<String,String> confMap)

setFromConfiguration

public OrderedPartitionedKVEdgeConfig.Builder setFromConfiguration(org.apache.hadoop.conf.Configuration conf)

configureOutput

public OrderedPartitionedKVOutputConfig.SpecificBuilder<OrderedPartitionedKVEdgeConfig.Builder> configureOutput()

Configure the specific output

Returns:

a builder to configure the output

configureInput

public OrderedGroupedKVInputConfig.SpecificBuilder<OrderedPartitionedKVEdgeConfig.Builder> configureInput()

Configure the specific input

Returns:

a builder to configure the input

build

public OrderedPartitionedKVEdgeConfig build()

Build and return an instance of the configuration

Returns:

an instance of the acatual configuration