Class Params

    • Method Detail

      • getUuid

        public String getUuid()
        Specified by:
        getUuid in interface IParams
        uuid uniquely identifies an execution request
      • setUuid

        public void setUuid​(String uuid)
      • getRepoName

        public String getRepoName()
        Specified by:
        getRepoName in interface IParams
        repoName Enterprise or database repository name, if you are using one
      • setRepoName

        public void setRepoName​(String repoName)
      • getBlockRepoConns

        public String getBlockRepoConns()
        Specified by:
        getBlockRepoConns in interface IParams
        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.
      • setBlockRepoConns

        public void setBlockRepoConns​(String blockRepoConns)
      • getRepoUsername

        public String getRepoUsername()
        Specified by:
        getRepoUsername in interface IParams
        repoUsername Repository username
      • setRepoUsername

        public void setRepoUsername​(String repoUsername)
      • getTrustRepoUser

        public String getTrustRepoUser()
        Specified by:
        getTrustRepoUser in interface IParams
        trustRepoUser Trust the repository username passed along ( i.e. no password required )
      • setTrustRepoUser

        public void setTrustRepoUser​(String trustRepoUser)
      • getRepoPassword

        public String getRepoPassword()
        Specified by:
        getRepoPassword in interface IParams
        repoPassword Repository password
      • setRepoPassword

        public void setRepoPassword​(String repoPassword)
      • getInputDir

        public String getInputDir()
        Specified by:
        getInputDir in interface IParams
        inputDir The directory that contains the file, including the leading slash
      • setInputDir

        public void setInputDir​(String inputDir)
      • getLocalFile

        public String getLocalFile()
        Specified by:
        getLocalFile in interface IParams
        localFile If you are calling a local file, this is the filename, including the path if it is not in the local directory
      • setLocalFile

        public void setLocalFile​(String localFile)
      • getLocalJarFile

        public String getLocalJarFile()
        Specified by:
        getLocalJarFile in interface IParams
        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
      • setLocalJarFile

        public void setLocalJarFile​(String localJarFile)
      • getInputFile

        public String getInputFile()
        Specified by:
        getInputFile in interface IParams
        inputFile The name of the file to launch
      • setInputFile

        public void setInputFile​(String inputFile)
      • getListRepoFiles

        public String getListRepoFiles()
        Specified by:
        getListRepoFiles in interface IParams
        listRepoFiles Lists the transformations in the specified repository directory
      • setListRepoFiles

        public void setListRepoFiles​(String listRepoFiles)
      • getListRepoDirs

        public String getListRepoDirs()
        Specified by:
        getListRepoDirs in interface IParams
        listDirs Lists the directories in the specified repository
      • setListRepoDirs

        public void setListRepoDirs​(String listRepoDirs)
      • getExportRepo

        public String getExportRepo()
        Specified by:
        getExportRepo in interface IParams
        exportRepo Exports all repository objects to one XML file
      • setExportRepo

        public void setExportRepo​(String exportRepo)
      • getLocalInitialDir

        public String getLocalInitialDir()
        Specified by:
        getLocalInitialDir in interface IParams
        localInitialDir if local filename starts with scheme like zip:, then you can pass along the initial dir to it
      • setLocalInitialDir

        public void setLocalInitialDir​(String localInitialDir)
      • getListRepos

        public String getListRepos()
        Specified by:
        getListRepos in interface IParams
        listRepos Lists the available repositories
      • setListRepos

        public void setListRepos​(String listRepos)
      • getSafeMode

        public String getSafeMode()
        Specified by:
        getSafeMode in interface IParams
        safeMode Runs in safe mode, which enables extra checking
      • setSafeMode

        public void setSafeMode​(String safeMode)
      • getMetrics

        public String getMetrics()
        Specified by:
        getMetrics in interface IParams
        metrics Enables kettle metric gathering
      • setMetrics

        public void setMetrics​(String metrics)
      • getListFileParams

        public String getListFileParams()
        Specified by:
        getListFileParams in interface IParams
        listFileParams List information about the defined named parameters in the specified file.
      • setListFileParams

        public void setListFileParams​(String listFileParams)
      • getLogLevel

        public String getLogLevel()
        Specified by:
        getLogLevel in interface IParams
        logLevel The logging level (Basic, Detailed, Debug, Rowlevel, Error, Nothing)
      • setLogLevel

        public void setLogLevel​(String logLevel)
      • getMaxLogLines

        public String getMaxLogLines()
        Specified by:
        getMaxLogLines in interface IParams
        maxLogLines The maximum number of log lines that are kept internally by PDI. Set to 0 to keep all rows (default)
      • setMaxLogLines

        public void setMaxLogLines​(String maxLogLines)
      • getMaxLogTimeout

        public String getMaxLogTimeout()
        Specified by:
        getMaxLogTimeout in interface IParams
        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)
      • setMaxLogTimeout

        public void setMaxLogTimeout​(String maxLogTimeout)
      • getLogFile

        public String getLogFile()
        Specified by:
        getLogFile in interface IParams
        logFile A local filename to write log output to
      • setLogFile

        public void setLogFile​(String logFile)
      • getOldLogFile

        public String getOldLogFile()
        Specified by:
        getOldLogFile in interface IParams
        oldLogFile if the old style of logging name is filled in, and the new one is not, overwrite the new by the old
      • setOldLogFile

        public void setOldLogFile​(String oldLogFile)
      • getVersion

        public String getVersion()
        Specified by:
        getVersion in interface IParams
        version Shows the version, revision, and build date
      • setVersion

        public void setVersion​(String version)
      • getResultSetStepName

        public String getResultSetStepName()
        Specified by:
        getResultSetStepName in interface IParams
        the step name from which we want the result set
      • setResultSetStepName

        public void setResultSetStepName​(String resultSetStepName)
      • getResultSetCopyNumber

        public String getResultSetCopyNumber()
        Specified by:
        getResultSetCopyNumber in interface IParams
        the step copy number from which we want the result set
      • setResultSetCopyNumber

        public void setResultSetCopyNumber​(String resultSetCopyNumber)
      • getBase64Zip

        public String getBase64Zip()
        Specified by:
        getBase64Zip in interface IParams
        the BASE64 representation of the zipped ETL work item
      • setBase64Zip

        public void setBase64Zip​(String base64Zip)
      • getNamedParams

        public org.pentaho.di.core.parameters.NamedParams getNamedParams()
        Specified by:
        getNamedParams in interface IParams
        namedParams parameters to be passed into the executing file
      • setNamedParams

        public void setNamedParams​(org.pentaho.di.core.parameters.NamedParams params)
      • getParams

        public Map<String,​String> getParams()
        Specified by:
        getParams in interface IParams
        params parameters to be passed into the executing file
      • getCustomNamedParams

        public org.pentaho.di.core.parameters.NamedParams getCustomNamedParams()
        Specified by:
        getCustomNamedParams in interface IParams
        namedParams custom parameters to be passed into the executing file
      • setCustomNamedParams

        public void setCustomNamedParams​(org.pentaho.di.core.parameters.NamedParams customNamedParams)
      • getCustomParams

        public Map<String,​String> getCustomParams()
        Specified by:
        getCustomParams in interface IParams
        customParams parameters to be passed into the executing file