io.cdap.cdap.api.data.batch

Class Output

java.lang.Object

io.cdap.cdap.api.data.batch.Output

Direct Known Subclasses:

Output.DatasetOutput, Output.OutputFormatProviderOutput

public abstract class Output
extends Object

Defines output of a program, such as MapReduce.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Output.DatasetOutput An implementation of Output, which defines a Dataset as an output.
static class	Output.OutputFormatProviderOutput An implementation of Output, which defines an OutputFormatProvider as an output.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Output(String name)

Method Summary

Modifier and Type	Method and Description
Output	alias(String alias) Sets an alias to be used as the output name.
Output	fromNamespace(String namespace) Sets the namespace of the output.
String	getAlias()
String	getName()
String	getNamespace()
static Output	of(String outputName, OutputFormatProvider outputFormatProvider) Returns an Output defined by an OutputFormatProvider.
static Output	ofDataset(String datasetName) Returns an Output defined by a dataset.
static Output	ofDataset(String datasetName, Map<String,String> arguments) Returns an Output defined by a dataset.

Methods inherited from class java.lang.Object

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

Constructor Detail

Output

protected Output(String name)

Method Detail

getName

public String getName()

Returns:

The name of the output.

fromNamespace

public Output fromNamespace(String namespace)

Sets the namespace of the output.

Parameters:

namespace - the namespace of the output

Returns:

the Output being operated on

getNamespace

@Nullable
public String getNamespace()

Returns:

the namespace of the output.

getAlias

public String getAlias()

Returns:

an alias of the output, to be used as the output name instead of the actual name of the output (i.e. dataset name). Defaults to the actual name, in the case that no alias was set.

alias

public Output alias(String alias)

Sets an alias to be used as the output name.

Parameters:

alias - the alias to be set for this Output

Returns:

the Output being operated on

ofDataset

public static Output ofDataset(String datasetName)

Returns an Output defined by a dataset.

Parameters:

datasetName - the name of the output dataset

ofDataset

public static Output ofDataset(String datasetName,
                               Map<String,String> arguments)

Returns an Output defined by a dataset.

Parameters:

datasetName - the name of the output dataset

arguments - the arguments to use when instantiating the dataset

of

public static Output of(String outputName,
                        OutputFormatProvider outputFormatProvider)

Returns an Output defined by an OutputFormatProvider.

Parameters:

outputName - the name of the output

outputFormatProvider - an instance of an OutputFormatProvider. It can not be an instance of a DatasetOutputCommitter.