io.cdap.cdap.etl.api

Interface StageConfigurer

@Beta
public interface StageConfigurer

This stores the input schema that is passed to this stage from other stages in the pipeline and the output schema that could be sent to the next stages from this stage.

Method Summary

Modifier and Type	Method and Description
default FailureCollector	getFailureCollector() Returns a failure collector for the stage.
io.cdap.cdap.api.data.schema.Schema	getInputSchema() get the input schema for this stage, or null if its unknown
void	setErrorSchema(io.cdap.cdap.api.data.schema.Schema errorSchema) set the error schema for this stage, or null if its unknown.
void	setOutputSchema(io.cdap.cdap.api.data.schema.Schema outputSchema) set the output schema for this stage, or null if its unknown

Method Detail

getInputSchema

@Nullable
io.cdap.cdap.api.data.schema.Schema getInputSchema()

get the input schema for this stage, or null if its unknown

Returns:

input schema

setOutputSchema

void setOutputSchema(@Nullable
                     io.cdap.cdap.api.data.schema.Schema outputSchema)

set the output schema for this stage, or null if its unknown

Parameters:

outputSchema - output schema for this stage

setErrorSchema

void setErrorSchema(@Nullable
                    io.cdap.cdap.api.data.schema.Schema errorSchema)

set the error schema for this stage, or null if its unknown. If no error schema is set, it will default to the input schema for the stage. Note that since source plugins do not have an input schema, it will default to null for sources.

Parameters:

errorSchema - error schema for this stage

getFailureCollector

default FailureCollector getFailureCollector()

Returns a failure collector for the stage.

Returns:

a failure collector

Throws:

UnsupportedOperationException - if the implementation does not override this method