org.apache.flink.api.java.operators

Class DataSink<T>

java.lang.Object

org.apache.flink.api.java.operators.DataSink<T>

public class DataSink<T>
extends Object

Constructor Summary

Constructors

Constructor and Description
DataSink(DataSet<T> data, OutputFormat<T> format, TypeInformation<T> type)

Method Summary

Methods

Modifier and Type	Method and Description
DataSet<T>	getDataSet()
OutputFormat<T>	getFormat()
int	getParallelism() Returns the parallelism of this data sink.
Configuration	getParameters()
TypeInformation<T>	getType()
DataSink<T>	name(String name)
DataSink<T>	setParallelism(int parallelism) Sets the parallelism for this data sink.
DataSink<T>	sortLocalOutput(int field, Order order) Sorts each local partition of a Tuple data set on the specified field in the specified Order before it is emitted by the output format. Note: Only tuple data sets can be sorted using integer field indices. The tuple data set can be sorted on multiple fields in different orders by chaining sortLocalOutput(int, Order) calls.
DataSink<T>	sortLocalOutput(String fieldExpression, Order order) Sorts each local partition of a data set on the field(s) specified by the field expression in the specified Order before it is emitted by the output format. Note: Non-composite types can only be sorted on the full element which is specified by a wildcard expression ("*" or "_"). Data sets of composite types (Tuple or Pojo) can be sorted on multiple fields in different orders by chaining sortLocalOutput(String, Order) calls.
String	toString()
protected GenericDataSinkBase<T>	translateToDataFlow(Operator<T> input)
DataSink<T>	withParameters(Configuration parameters) Pass a configuration to the OutputFormat

Methods inherited from class java.lang.Object

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

Constructor Detail

DataSink

public DataSink(DataSet<T> data,
        OutputFormat<T> format,
        TypeInformation<T> type)

Method Detail

getFormat

public OutputFormat<T> getFormat()

getType

public TypeInformation<T> getType()

getDataSet

public DataSet<T> getDataSet()

withParameters

public DataSink<T> withParameters(Configuration parameters)

Pass a configuration to the OutputFormat

Parameters:

parameters - Configuration parameters

sortLocalOutput

public DataSink<T> sortLocalOutput(int field,
                          Order order)

Sorts each local partition of a Tuple data set on the specified field in the specified Order before it is emitted by the output format.
Note: Only tuple data sets can be sorted using integer field indices.
The tuple data set can be sorted on multiple fields in different orders by chaining sortLocalOutput(int, Order) calls.

Parameters:

field - The Tuple field on which the data set is locally sorted.

order - The Order in which the specified Tuple field is locally sorted.

Returns:

This data sink operator with specified output order.

See Also:

Tuple, Order

sortLocalOutput

public DataSink<T> sortLocalOutput(String fieldExpression,
                          Order order)

Sorts each local partition of a data set on the field(s) specified by the field expression in the specified Order before it is emitted by the output format.
Note: Non-composite types can only be sorted on the full element which is specified by a wildcard expression ("*" or "_").
Data sets of composite types (Tuple or Pojo) can be sorted on multiple fields in different orders by chaining sortLocalOutput(String, Order) calls.

Parameters:

fieldExpression - The field expression for the field(s) on which the data set is locally sorted.

order - The Order in which the specified field(s) are locally sorted.

Returns:

This data sink operator with specified output order.

See Also:

Order

getParameters

public Configuration getParameters()

Returns:

Configuration for the OutputFormat.

name

public DataSink<T> name(String name)

translateToDataFlow

protected GenericDataSinkBase<T> translateToDataFlow(Operator<T> input)

toString

public String toString()

Overrides:

toString in class Object

getParallelism

public int getParallelism()

Returns the parallelism of this data sink.

Returns:

The parallelism of this data sink.

setParallelism

public DataSink<T> setParallelism(int parallelism)

Sets the parallelism for this data sink. The degree must be 1 or more.

Parameters:

parallelism - The parallelism for this data sink.

Returns:

This data sink with set parallelism.