org.apache.tez.runtime.api

Interface OutputFrameworkInterface

All Known Subinterfaces:

LogicalOutputFrameworkInterface

All Known Implementing Classes:

AbstractLogicalOutput

@InterfaceAudience.Public
public interface OutputFrameworkInterface

Represents the Tez framework part of an Output.

This interface has methods which are used by the Tez framework to control the Output.

During initialization, Outputs must specify an initial memory requirement via OutputContext.requestInitialMemory

Users are expected to derive from AbstractLogicalOutput

Method Summary

Methods

Modifier and Type	Method and Description
List<Event>	close() Closes the Output
void	handleEvents(List<Event> outputEvents) Handles user and system generated Events, which typically carry information such as a downstream vertex being ready to consume input.
List<Event>	initialize() Initializes the Output

Method Detail

initialize

List<Event> initialize()
                       throws Exception

Initializes the Output

Returns:

list of events that were generated during initialization

Throws:

Exception - if an error occurs

handleEvents

void handleEvents(List<Event> outputEvents)

Handles user and system generated Events, which typically carry information such as a downstream vertex being ready to consume input.

Parameters:

outputEvents - the list of Events

close

List<Event> close()
                  throws Exception

Closes the Output

Returns:

list of events that were generated during close

Throws:

Exception - if an error occurs