Package org.pentaho.di.base

Interface IParams

All Superinterfaces:
Serializable
All Known Implementing Classes:
Params
public interface IParams extends Serializable

  • Method Details

    • getUuid

      String getUuid()
      Returns:
      uuid uniquely identifies an execution request

    • getRepoName

      String getRepoName()
      Returns:
      repoName Enterprise or database repository name, if you are using one

    • getBlockRepoConns

      String getBlockRepoConns()
      Returns:
      blockRepoConns Prevents from logging into a repository. If you have set the KETTLE_REPOSITORY, KETTLE_USER, and KETTLE_PASSWORD environment variables, then this option will enable you to prevent from logging into the specified repository, assuming you would like to execute a local KTR file instead.

    • getRepoUsername

      String getRepoUsername()
      Returns:
      repoUsername Repository username

    • getTrustRepoUser

      String getTrustRepoUser()
      Returns:
      trustRepoUser Trust the repository username passed along ( i.e. no password required )

    • getRepoPassword

      String getRepoPassword()
      Returns:
      repoPassword Repository password

    • getInputDir

      String getInputDir()
      Returns:
      inputDir The directory that contains the file, including the leading slash

    • getLocalFile

      String getLocalFile()
      Returns:
      localFile If you are calling a local file, this is the filename, including the path if it is not in the local directory

    • getLocalJarFile

      String getLocalJarFile()
      Returns:
      localJarFile If you are calling a file within a local jar file, this is the filename, including the path if it is not in the local directory

    • getInputFile

      String getInputFile()
      Returns:
      inputFile The name of the file to launch

    • getListRepoFiles

      String getListRepoFiles()
      Returns:
      listRepoFiles Lists the transformations in the specified repository directory

    • getListRepoDirs

      String getListRepoDirs()
      Returns:
      listDirs Lists the directories in the specified repository

    • getExportRepo

      String getExportRepo()
      Returns:
      exportRepo Exports all repository objects to one XML file

    • getLocalInitialDir

      String getLocalInitialDir()
      Returns:
      localInitialDir if local filename starts with scheme like zip:, then you can pass along the initial dir to it

    • getListRepos

      String getListRepos()
      Returns:
      listRepos Lists the available repositories

    • getSafeMode

      String getSafeMode()
      Returns:
      safeMode Runs in safe mode, which enables extra checking

    • getMetrics

      String getMetrics()
      Returns:
      metrics Enables kettle metric gathering

    • getListFileParams

      String getListFileParams()
      Returns:
      listFileParams List information about the defined named parameters in the specified file.

    • getLogLevel

      String getLogLevel()
      Returns:
      logLevel The logging level (Basic, Detailed, Debug, Rowlevel, Error, Nothing)

    • getMaxLogLines

      String getMaxLogLines()
      Returns:
      maxLogLines The maximum number of log lines that are kept internally by PDI. Set to 0 to keep all rows (default)

    • getMaxLogTimeout

      String getMaxLogTimeout()
      Returns:
      maxLogTimeout The maximum age (in minutes) of a log line while being kept internally by PDI. Set to 0 to keep all rows indefinitely (default)

    • getLogFile

      String getLogFile()
      Returns:
      logFile A local filename to write log output to

    • getOldLogFile

      String getOldLogFile()
      Returns:
      oldLogFile if the old style of logging name is filled in, and the new one is not, overwrite the new by the old

    • getVersion

      String getVersion()
      Returns:
      version Shows the version, revision, and build date

    • getResultSetStepName

      String getResultSetStepName()
      Returns:
      the step name from which we want the result set

    • getResultSetCopyNumber

      String getResultSetCopyNumber()
      Returns:
      the step copy number from which we want the result set

    • getBase64Zip

      String getBase64Zip()
      Returns:
      the BASE64 representation of the zipped ETL work item

    • getParams

      Map<String,String> getParams()
      Returns:
      params parameters to be passed into the executing file

    • getNamedParams

      org.pentaho.di.core.parameters.NamedParams getNamedParams()
      Returns:
      namedParams parameters to be passed into the executing file

    • getCustomParams

      Map<String,String> getCustomParams()
      Returns:
      customParams parameters to be passed into the executing file

    • getCustomNamedParams

      org.pentaho.di.core.parameters.NamedParams getCustomNamedParams()
      Returns:
      namedParams custom parameters to be passed into the executing file