Package org.apache.flink.api.common.cache

Class DistributedCache

java.lang.Object

org.apache.flink.api.common.cache.DistributedCache

@Public
public class DistributedCache
extends Object

DistributedCache provides static methods to write the registered cache files into job configuration or decode them from job configuration. It also provides user access to the file locally.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DistributedCache.DistributedCacheEntry	Meta info about an entry in DistributedCache.

Constructor Summary

Constructors

Constructor	Description
DistributedCache(Map<String,Future<Path>> cacheCopyTasks)

Method Summary

Modifier and Type	Method	Description
File	getFile(String name)
static List<Tuple2<String,DistributedCache.DistributedCacheEntry>>	parseCachedFilesFromString(List<String> files)	Parses a list of distributed cache entries encoded in a string.
static List<String>	parseStringFromCachedFiles(List<Tuple2<String,DistributedCache.DistributedCacheEntry>> files)
static Set<Map.Entry<String,DistributedCache.DistributedCacheEntry>>	readFileInfoFromConfig(Configuration conf)
static void	writeFileInfoToConfig(String name, DistributedCache.DistributedCacheEntry e, Configuration conf)

Methods inherited from class java.lang.Object

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

Constructor Detail

DistributedCache

public DistributedCache(Map<String,Future<Path>> cacheCopyTasks)

Method Detail

getFile

public File getFile(String name)

writeFileInfoToConfig

public static void writeFileInfoToConfig(String name,
                                         DistributedCache.DistributedCacheEntry e,
                                         Configuration conf)

readFileInfoFromConfig

public static Set<Map.Entry<String,DistributedCache.DistributedCacheEntry>> readFileInfoFromConfig(Configuration conf)

parseCachedFilesFromString

public static List<Tuple2<String,DistributedCache.DistributedCacheEntry>> parseCachedFilesFromString(List<String> files)

Parses a list of distributed cache entries encoded in a string. Can be used to parse a config option described by PipelineOptions.CACHED_FILES.

See PipelineOptions.CACHED_FILES for the format.

Parameters:

files - List of string encoded distributed cache entries.

parseStringFromCachedFiles

@Internal
public static List<String> parseStringFromCachedFiles(List<Tuple2<String,DistributedCache.DistributedCacheEntry>> files)