Skip navigation links

com.oracle.dac.thirdparty.executor.arguments
Class DACTaskDefinition

java.lang.Object
com.oracle.dac.thirdparty.executor.arguments.DACTaskDefinition

public class DACTaskDefinition

extends java.lang.Object

DACTaskDefinition object contains properties of a DAC task that must be used to create DACExecutorJob properly.

Since:

DAC 11.1.1.5.0

Constructor Summary

DACTaskDefinition()
Constructs DACTaskDefinition object.

Method Summary

void	addExecutionContextParameter(java.lang.String name, java.lang.String value) Adds or modifies name-value pair for a CONTEXT.
void	addSourceTable(DACSourceTable table) Adds a source table to the task.
void	addTargetTable(DACTargetTable table) Adds a target table to the task.
java.sql.Timestamp	getActualEtlStartTime() Returns actual ETL start time.
java.lang.String	getCommandName() Returns command name to be executed.
java.sql.Timestamp	getCurrentEtlStartTime() Returns current ETL start time.
java.util.Map<java.lang.String,java.lang.String>	getExecutionContextParameters() Returns a map of names and values of execution plan connectivity parameters with type CONTEXT.
int	getExecutionParameterCopyNumber() Returns the execution parameter copy number.
java.lang.String	getFolderName() Returns DAC task's physical folder name.
java.lang.String	getFullCommandName() Returns command name for full load.
java.lang.String	getIncrementalCommandName() Returns command name for incremental load.
java.lang.String	getInstanceName() Returns instance name.
long	getInstanceNumber() Returns instance number.
java.sql.Timestamp	getLastSourceRefreshDate() Returns refresh date for the source.
java.sql.Timestamp	getLastTargetRefreshDate() Returns refresh date for the target.
long	getPruneMinutes() Returns prune minutes for the task's source (defined in execution plan parameters).
java.lang.String	getSourceDatasourceName() Returns physical data source name for DAC task's source.
java.lang.String	getSourceMode() Returns DAC task source mode (FULL or INCREMENTAL).
java.util.Map<java.lang.String,DACSourceTable>	getSourceTables() Returns a map of source tables.
java.lang.String	getTargetDatasourceName() Returns physical data source name for DAC task's target.
java.lang.String	getTargetMode() Returns DAC task target mode (FULL or INCREMENTAL).
java.util.Map<java.lang.String,DACTargetTable>	getTargetTables() Returns a map of target tables.
java.lang.String	getTaskName() Returns DAC task name.
void	setActualEtlStartTime(java.sql.Timestamp actualEtlStartTime) Sets actual ETL start time.
void	setCommandName(java.lang.String commandName) Sets command name.
void	setCurrentEtlStartTime(java.sql.Timestamp currentEtlStartTime) Sets current ETL start time.
void	setExecutionParameterCopyNumber(int executionParameterCopyNumber) Sets the execution parameter copy number.
void	setFolderName(java.lang.String folderName) Sets DAC task's physical folder name.
void	setFullCommandName(java.lang.String fullCommandName) Sets command name for full load.
void	setIncrementalCommandName(java.lang.String incrementalCommandName) Sets command name for incremental load.
void	setInstanceName(java.lang.String instanceName) Sets instance name.
void	setInstanceNumber(long instanceNumber) Sets instance number.
void	setLastSourceRefreshDate(java.sql.Timestamp lastSourceRefreshDate) Sets refresh date for the source.
void	setLastTargetRefreshDate(java.sql.Timestamp lastTargetRefreshDate) Sets refresh date for the target.
void	setPruneMinutes(long pruneMinutes) Sets prune minutes for the task's source (defined in execution plan parameters).
void	setSourceDatasourceName(java.lang.String sourceDatasourceName) Sets physical data source name for DAC task's source.
void	setSourceMode(java.lang.String sourceMode) Sets DAC task source mode (FULL or INCREMENTAL).
void	setTargetDatasourceName(java.lang.String targetDatasourceName) Sets physical data source name for DAC task's target.
void	setTargetMode(java.lang.String targetMode) Sets DAC task target mode (FULL or INCREMENTAL).
void	setTaskName(java.lang.String taskName) Sets DAC task name.

Methods inherited from class java.lang.Object

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

Constructor Detail

DACTaskDefinition

public DACTaskDefinition()

Constructs DACTaskDefinition object.

Method Detail

getTaskName

public java.lang.String getTaskName()

Returns DAC task name. This is the logical name of a task defined in DAC repository.

Returns:

DAC task name

setTaskName

public void setTaskName(java.lang.String taskName)

Sets DAC task name.

Note: This property is set internally by DAC and the function should not be used by external executor implementations.

Parameters:

taskName - DAC task name

getCommandName

public java.lang.String getCommandName()

Returns command name to be executed. It could be used for full or incremental load depending on the context. Command name should be passed from DACExecutorJob to the external ETL engine.

Returns:

command name to be executed

setCommandName

public void setCommandName(java.lang.String commandName)

Sets command name. It could be used for full or incremental load depending on the context. Command name should be passed from DACExecutorJob to the external ETL engine.

Note: This property is set internally by DAC and the function should not be used by external executor implementations.

Parameters:

commandName - command name to be executed

getInstanceName

public java.lang.String getInstanceName()

Returns instance name. Instance names are used when running the same command multiple times within ETL. See DAC looping feature for more details.

Returns:

suggested instance name

setInstanceName

public void setInstanceName(java.lang.String instanceName)

Sets instance name. Instance names are used when running the same command multiple times within ETL. See DAC looping feature for more details.

Note: This property is set internally by DAC and the function should not be used by external executor implementations.

Parameters:

instanceName - suggested instance name

getInstanceNumber

public long getInstanceNumber()

Returns instance number. Task can be executed multiple times during ETL in DAC with each instance assigned the number from 1 and up. See DAC looping feature for more details.

Returns:

instance number

setInstanceNumber

public void setInstanceNumber(long instanceNumber)

Sets instance number. Task can be executed multiple times during ETL in DAC with each instance assigned the number from 1 and up. See DAC looping feature for more details.

Note: This property is set internally by DAC and the function should not be used by external executor implementations.

Parameters:

instanceNumber - instance number

getLastSourceRefreshDate

public java.sql.Timestamp getLastSourceRefreshDate()

Returns refresh date for the source. It is the earliest of the source and target table refresh dates.

Returns:

refresh date for the source

setLastSourceRefreshDate

public void setLastSourceRefreshDate(java.sql.Timestamp lastSourceRefreshDate)

Sets refresh date for the source. It is the earliest of the source and target table refresh dates.

Note: This property is set internally by DAC and the function should not be used by external executor implementations.

Parameters:

lastSourceRefreshDate - refresh date for the source

getLastTargetRefreshDate

public java.sql.Timestamp getLastTargetRefreshDate()

Returns refresh date for the target. It is the earliest of the target table refresh dates.

Returns:

refresh date for the target

setLastTargetRefreshDate

public void setLastTargetRefreshDate(java.sql.Timestamp lastTargetRefreshDate)

Sets refresh date for the target. It is the earliest of the target table refresh dates.

Note: This property is set internally by DAC and the function should not be used by external executor implementations.

Parameters:

lastTargetRefreshDate - refresh date for the target

getFolderName

public java.lang.String getFolderName()

Returns DAC task's physical folder name.

Returns:

DAC task's physical folder name

setFolderName

public void setFolderName(java.lang.String folderName)

Sets DAC task's physical folder name.

Note: This property is set internally by DAC and the function should not be used by external executor implementations.

Parameters:

folderName - DAC task's physical folder name

getSourceDatasourceName

public java.lang.String getSourceDatasourceName()

Returns physical data source name for DAC task's source.

Returns:

physical data source name for DAC task's source

setSourceDatasourceName

public void setSourceDatasourceName(java.lang.String sourceDatasourceName)

Sets physical data source name for DAC task's source.

Note: This property is set internally by DAC and the function should not be used by external executor implementations.

Parameters:

sourceDatasourceName - physical data source name for DAC task's source

getTargetDatasourceName

public java.lang.String getTargetDatasourceName()

Returns physical data source name for DAC task's target.

Returns:

physical data source name for DAC task's target

setTargetDatasourceName

public void setTargetDatasourceName(java.lang.String targetDatasourceName)

Sets physical data source name for DAC task's target.

Note: This property is set internally by DAC and the function should not be used by external executor implementations.

Parameters:

targetDatasourceName - physical data source name for DAC task's target

getPruneMinutes

public long getPruneMinutes()

Returns prune minutes for the task's source (defined in execution plan parameters).

Returns:

prune minutes

setPruneMinutes

public void setPruneMinutes(long pruneMinutes)

Sets prune minutes for the task's source (defined in execution plan parameters).

Note: This property is set internally by DAC and the function should not be used by external executor implementations.

Parameters:

pruneMinutes - prune minutes

getSourceMode

public java.lang.String getSourceMode()

Returns DAC task source mode (FULL or INCREMENTAL).

Returns:

source mode

setSourceMode

public void setSourceMode(java.lang.String sourceMode)

Sets DAC task source mode (FULL or INCREMENTAL).

Note: This property is set internally by DAC and the function should not be used by external executor implementations.

Parameters:

sourceMode - source mode

getTargetMode

public java.lang.String getTargetMode()

Returns DAC task target mode (FULL or INCREMENTAL).

Returns:

target mode

setTargetMode

public void setTargetMode(java.lang.String targetMode)

Sets DAC task target mode (FULL or INCREMENTAL).

Note: This property is set internally by DAC and the function should not be used by external executor implementations.

Parameters:

targetMode - target mode

getCurrentEtlStartTime

public java.sql.Timestamp getCurrentEtlStartTime()

Returns current ETL start time. If there are several failure restarts, current and actual ETL start times are different. For the first attempt they are one and the same.

Returns:

start time of the current ETL run.

setCurrentEtlStartTime

public void setCurrentEtlStartTime(java.sql.Timestamp currentEtlStartTime)

Sets current ETL start time. If there are several failure restarts, current and actual ETL start times are different. For the first attempt they are one and the same.

Note: This property is set internally by DAC and the function should not be used by external executor implementations.

Parameters:

currentEtlStartTime - start time of the current ETL run

getActualEtlStartTime

public java.sql.Timestamp getActualEtlStartTime()

Returns actual ETL start time. This is the time the first attempt of the ELT started. If there are several failure restarts, current and actual ETL start times are different. For the first attempt they are one and the same..

Returns:

start time of the first attempt of the current ETL run.

setActualEtlStartTime

public void setActualEtlStartTime(java.sql.Timestamp actualEtlStartTime)

Sets actual ETL start time. This is the time the first attempt of the ETL started. If there are several failure restarts, current and actual ETL start times are different. For the first attempt they are one and the same.

Note: This property is set internally by DAC and the function should not be used by external executor implementations.

Parameters:

actualEtlStartTime - start time of the first attempt of the current ETL run

getSourceTables

public final java.util.Map<java.lang.String,DACSourceTable> getSourceTables()

Returns a map of source tables. The key is the table name and the value is the DACTable. The DACTable object's type describes if its a primary, auxiliary or lookup table.

Note: The map should not be modified, it is for informational purpose only.

Returns:

map of source tables

getTargetTables

public final java.util.Map<java.lang.String,DACTargetTable> getTargetTables()

Returns a map of target tables. The key is the table name and the value is the DACTable. The DACTable object's type describes the truncate and analyze properties.

Note: The map should not be modified, it is for informational purpose only.

Returns:

map of target tables

addSourceTable

public void addSourceTable(DACSourceTable table)

Adds a source table to the task.

Note: This property is set internally by DAC and the function should not be used by external executor implementations.

Parameters:

table - source table

addTargetTable

public void addTargetTable(DACTargetTable table)

Adds a target table to the task.

Note: This property is set internally by DAC and the function should not be used by external executor implementations.

Parameters:

table -

getExecutionParameterCopyNumber

public int getExecutionParameterCopyNumber()

Returns the execution parameter copy number. During execution plan design, a task can get multiple instances depending upon the number of copies requested by the user. This number is reflective of which one of such copy number produced the current instance.

Returns:

execution parameter copy number

setExecutionParameterCopyNumber

public void setExecutionParameterCopyNumber(int executionParameterCopyNumber)

Sets the execution parameter copy number. During execution plan design, a task can get multiple instances depending upon the number of copies requested by the user. This number is reflective of which one of such copy number produced the current instance.

Note: This property is set internally by DAC and the function should not be used by external executor implementations.

Parameters:

executionParameterCopyNumber - execution parameter copy number.

getExecutionContextParameters

public java.util.Map<java.lang.String,java.lang.String> getExecutionContextParameters()

Returns a map of names and values of execution plan connectivity parameters with type CONTEXT. A CONTEXT is used when: 1. external executor requires an additional parameter that is not present in DAC, and 2. the value can't be defined as a constant for the external executor instance. The value varies depending on execution plan, source system container or data source. A name for a CONTEXT is defined in DACExecutorDescriptor (see getExecutionContextNames()). There can be multiple names in a CONTEXT if needed. A corresponding value is set on the Execution Plan Connectivity Parameters tab after the Generate functionality is invoked. Examples of external executor CONTEXT are Project (defined in ODI work repository) and Execution Context (defined in ODI topology).

Returns:

map of external executor context name-value pairs

addExecutionContextParameter

public void addExecutionContextParameter(java.lang.String name,
                                         java.lang.String value)

Adds or modifies name-value pair for a CONTEXT. For more details see getExecutionContextParameters()

Note: This property is set internally by DAC and the function should not be used by external executor implementations.

Parameters:

name - parameter name

value - parameter value

getFullCommandName

public java.lang.String getFullCommandName()

Returns command name for full load. Only use this function if you need full load command explicitly. Use getCommandName() otherwise.

Returns:

command name for full load

setFullCommandName

public void setFullCommandName(java.lang.String fullCommandName)

Sets command name for full load.

Note: This property is set internally by DAC and the function should not be used by external executor implementations.

Parameters:

commandName - command name to be executed

getIncrementalCommandName

public java.lang.String getIncrementalCommandName()

Returns command name for incremental load. Only use this function if you need incremental load command explicitly. Use getCommandName() otherwise.

Returns:

command name for full load

setIncrementalCommandName

public void setIncrementalCommandName(java.lang.String incrementalCommandName)

Sets command name for incremental load.

Note: This property is set internally by DAC and the function should not be used by external executor implementations.

Parameters:

commandName - command name to be executed

Skip navigation links