co.cask.cdap.etl.proto.v2

Class ETLConfig

java.lang.Object

co.cask.cdap.api.Config

co.cask.cdap.etl.proto.v2.ETLConfig

All Implemented Interfaces:

UpgradeableConfig

Direct Known Subclasses:

DataStreamsConfig, ETLBatchConfig

public class ETLConfig
extends Config
implements UpgradeableConfig

Common ETL Config.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ETLConfig.Builder<T extends ETLConfig.Builder> Builder for creating configs.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ETLConfig(Set<ETLStage> stages, Set<Connection> connections, Resources resources, Resources driverResources, Resources clientResources, boolean stageLoggingEnabled, boolean processTimingEnabled, int numOfRecordsPreview, Map<String,String> properties)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canUpgrade()
protected <T extends ETLConfig.Builder> T	convertStages(T builder, String sourceType, String sinkType) Converts the source, transforms, sinks, connections and resources from old style config into their new forms.
boolean	equals(Object o)
Resources	getClientResources()
Set<Connection>	getConnections()
String	getDescription()
Resources	getDriverResources()
int	getNumOfRecordsPreview()
Map<String,String>	getProperties()
Resources	getResources()
Set<ETLStage>	getStages()
int	hashCode()
boolean	isProcessTimingEnabled()
boolean	isStageLoggingEnabled()
String	toString()
UpgradeableConfig	upgrade(UpgradeContext upgradeContext) Return an upgraded config, which may be upgradeable itself.
void	validate() Validate correctness.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ETLConfig

protected ETLConfig(Set<ETLStage> stages,
         Set<Connection> connections,
         Resources resources,
         Resources driverResources,
         Resources clientResources,
         boolean stageLoggingEnabled,
         boolean processTimingEnabled,
         int numOfRecordsPreview,
         Map<String,String> properties)

Method Detail

getDescription

@Nullable
public String getDescription()

getStages

public Set<ETLStage> getStages()

getConnections

public Set<Connection> getConnections()

getResources

public Resources getResources()

getDriverResources

public Resources getDriverResources()

getClientResources

public Resources getClientResources()

getNumOfRecordsPreview

public int getNumOfRecordsPreview()

isStageLoggingEnabled

public boolean isStageLoggingEnabled()

isProcessTimingEnabled

public boolean isProcessTimingEnabled()

getProperties

public Map<String,String> getProperties()

validate

public void validate()

Validate correctness. Since this object is created through deserialization, some fields that should not be null may be null. Only validates field correctness, not logical correctness.

Throws:

IllegalArgumentException - if the object is invalid

convertStages

protected <T extends ETLConfig.Builder> T convertStages(T builder,
                                            String sourceType,
                                            String sinkType)

Converts the source, transforms, sinks, connections and resources from old style config into their new forms.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

canUpgrade

public boolean canUpgrade()

Specified by:

canUpgrade in interface UpgradeableConfig

Returns:

whether or not this config can be updated

upgrade

public UpgradeableConfig upgrade(UpgradeContext upgradeContext)

Description copied from interface: UpgradeableConfig

Return an upgraded config, which may be upgradeable itself. This allows v0 to upgrade to v1, which can then be upgraded to v2, and so on. In this way, as long as each config version knows how to upgrade to the next version, we will be able to upgrade from any old version to the most current version.

Specified by:

upgrade in interface UpgradeableConfig

Parameters:

upgradeContext - context for upgrading

Returns:

the upgraded config

toString

public String toString()

Overrides:

toString in class Object