alluxio.client.lineage

Class AlluxioLineage

java.lang.Object

alluxio.client.lineage.AbstractLineageClient

alluxio.client.lineage.AlluxioLineage

@PublicApi
 @ThreadSafe
public final class AlluxioLineage
extends AbstractLineageClient

A LineageClient implementation. This class does not access the master client directly but goes through the implementations provided in AbstractLineageClient.

Field Summary

Fields inherited from class alluxio.client.lineage.AbstractLineageClient

mContext

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AlluxioLineage(LineageContext context) Internal constructor that constructs a new instance with a LineageContext.

Method Summary

Modifier and Type	Method and Description
long	createLineage(List<AlluxioURI> inputFiles, List<AlluxioURI> outputFiles, Job job) Convenience method for AbstractLineageClient.createLineage(List, List, Job, CreateLineageOptions) with default options.
boolean	deleteLineage(long lineageId) Convenience method for AbstractLineageClient.deleteLineage(long, DeleteLineageOptions) with default options.
static AlluxioLineage	get()
static AlluxioLineage	get(LineageContext context)
List<LineageInfo>	getLineageInfoList() Convenience method for AbstractLineageClient.getLineageInfoList(GetLineageInfoListOptions) with default options.

Methods inherited from class alluxio.client.lineage.AbstractLineageClient

createLineage, deleteLineage, getLineageInfoList

Methods inherited from class java.lang.Object

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

Constructor Detail

AlluxioLineage

protected AlluxioLineage(LineageContext context)

Internal constructor that constructs a new instance with a LineageContext.

Parameters:

context - lineage context

Method Detail

get

public static AlluxioLineage get()

Returns:

the current lineage for Alluxio

get

public static AlluxioLineage get(LineageContext context)

Parameters:

context - lineage context

Returns:

the current lineage for Alluxio

createLineage

public long createLineage(List<AlluxioURI> inputFiles,
                          List<AlluxioURI> outputFiles,
                          Job job)
                   throws FileDoesNotExistException,
                          AlluxioException,
                          IOException

Convenience method for AbstractLineageClient.createLineage(List, List, Job, CreateLineageOptions) with default options.

Parameters:

inputFiles - the files that the job depends on

outputFiles - the files that the job outputs

job - the job that takes the listed input file and computes the output file

Returns:

the lineage id

Throws:

FileDoesNotExistException - an input file does not exist in Alluxio storage, nor is added as an output file of an existing lineage

AlluxioException

IOException

deleteLineage

public boolean deleteLineage(long lineageId)
                      throws IOException,
                             LineageDoesNotExistException,
                             LineageDeletionException,
                             AlluxioException

Convenience method for AbstractLineageClient.deleteLineage(long, DeleteLineageOptions) with default options.

Parameters:

lineageId - the id of the lineage

Returns:

true if the lineage deletion is successful, false otherwise

Throws:

LineageDoesNotExistException - if the lineage does not exist

LineageDeletionException - if the deletion is cascade but the lineage has children

IOException

AlluxioException

getLineageInfoList

public List<LineageInfo> getLineageInfoList()
                                     throws IOException

Convenience method for AbstractLineageClient.getLineageInfoList(GetLineageInfoListOptions) with default options.

Returns:

the information about lineages

Throws:

IOException