io.cdap.cdap.api.data.batch

Class Input

java.lang.Object

io.cdap.cdap.api.data.batch.Input

Direct Known Subclasses:

Input.DatasetInput, Input.InputFormatProviderInput

public abstract class Input
extends Object

Defines input to a program, such as MapReduce.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Input.DatasetInput An implementation of Input, which defines a Dataset as an input.
static class	Input.InputFormatProviderInput An implementation of Input, which defines an InputFormatProvider as an input.

Method Summary

Modifier and Type	Method and Description
Input	alias(String alias) Sets an alias to be used as the input name.
Input	fromNamespace(String namespace) Sets the namespace of the input.
String	getAlias()
String	getName()
String	getNamespace()
static Input	of(String inputName, InputFormatProvider inputFormatProvider) Returns an Input defined by an InputFormatProvider.
static Input	ofDataset(String datasetName) Returns an Input defined by a dataset.
static Input	ofDataset(String datasetName, Iterable<? extends Split> splits) Returns an Input defined by a dataset.
static Input	ofDataset(String datasetName, Map<String,String> arguments) Returns an Input defined by a dataset.
static Input	ofDataset(String datasetName, Map<String,String> arguments, Iterable<? extends Split> splits) Returns an Input defined by a dataset.

Methods inherited from class java.lang.Object

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

Method Detail

getName

public String getName()

Returns:

The name of the input.

fromNamespace

public Input fromNamespace(String namespace)

Sets the namespace of the input.

Parameters:

namespace - the namespace of the input

Returns:

the Input being operated on

getNamespace

@Nullable
public String getNamespace()

Returns:

The namespace of the input.

getAlias

public String getAlias()

Returns:

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

alias

public Input alias(String alias)

Sets an alias to be used as the input name.

Parameters:

alias - the alias to be set for this Input

Returns:

the Input being operated on

ofDataset

public static Input ofDataset(String datasetName)

Returns an Input defined by a dataset.

Parameters:

datasetName - the name of the input dataset

ofDataset

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

Returns an Input defined by a dataset.

Parameters:

datasetName - the name of the input dataset

arguments - the arguments to use when instantiating the dataset

ofDataset

public static Input ofDataset(String datasetName,
                              @Nullable
                              Iterable<? extends Split> splits)

Returns an Input defined by a dataset.

Parameters:

datasetName - the name of the input dataset

splits - the data selection splits. If null, will use the splits defined by the dataset. If the dataset type is not BatchReadable, splits will be ignored

ofDataset

public static Input ofDataset(String datasetName,
                              Map<String,String> arguments,
                              @Nullable
                              Iterable<? extends Split> splits)

Returns an Input defined by a dataset.

Parameters:

datasetName - the name of the input dataset

arguments - the arguments to use when instantiating the dataset

splits - the data selection splits. If null, will use the splits defined by the dataset. If the dataset type is not BatchReadable, splits will be ignored

of

public static Input of(String inputName,
                       InputFormatProvider inputFormatProvider)

Returns an Input defined by an InputFormatProvider.

Parameters:

inputName - the name of the input