Params (PDI Engine 9.1.0.0-317 API)

java.lang.Object
- org.pentaho.di.base.Params

All Implemented Interfaces:

Serializable, IParams
```
public class Params
extends Object
implements IParams
```
See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Params.Builder

Nested Classes
Modifier and Type	Class and Description
`static class`	`Params.Builder`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getBase64Zip()`
`String`	`getBlockRepoConns()`
`NamedParams`	`getCustomNamedParams()`
`Map<String,String>`	`getCustomParams()`
`String`	`getExportRepo()`
`String`	`getInputDir()`
`String`	`getInputFile()`
`String`	`getListFileParams()`
`String`	`getListRepoDirs()`
`String`	`getListRepoFiles()`
`String`	`getListRepos()`
`String`	`getLocalFile()`
`String`	`getLocalInitialDir()`
`String`	`getLocalJarFile()`
`String`	`getLogFile()`
`String`	`getLogLevel()`
`String`	`getMaxLogLines()`
`String`	`getMaxLogTimeout()`
`String`	`getMetrics()`
`NamedParams`	`getNamedParams()`
`String`	`getOldLogFile()`
`Map<String,String>`	`getParams()`
`String`	`getRepoName()`
`String`	`getRepoPassword()`
`String`	`getRepoUsername()`
`String`	`getResultSetCopyNumber()`
`String`	`getResultSetStepName()`
`String`	`getSafeMode()`
`String`	`getTrustRepoUser()`
`String`	`getUuid()`
`String`	`getVersion()`
`void`	`setBase64Zip(String base64Zip)`
`void`	`setBlockRepoConns(String blockRepoConns)`
`void`	`setCustomNamedParams(NamedParams customNamedParams)`
`void`	`setExportRepo(String exportRepo)`
`void`	`setInputDir(String inputDir)`
`void`	`setInputFile(String inputFile)`
`void`	`setListFileParams(String listFileParams)`
`void`	`setListRepoDirs(String listRepoDirs)`
`void`	`setListRepoFiles(String listRepoFiles)`
`void`	`setListRepos(String listRepos)`
`void`	`setLocalFile(String localFile)`
`void`	`setLocalInitialDir(String localInitialDir)`
`void`	`setLocalJarFile(String localJarFile)`
`void`	`setLogFile(String logFile)`
`void`	`setLogLevel(String logLevel)`
`void`	`setMaxLogLines(String maxLogLines)`
`void`	`setMaxLogTimeout(String maxLogTimeout)`
`void`	`setMetrics(String metrics)`
`void`	`setNamedParams(NamedParams params)`
`void`	`setOldLogFile(String oldLogFile)`
`void`	`setRepoName(String repoName)`
`void`	`setRepoPassword(String repoPassword)`
`void`	`setRepoUsername(String repoUsername)`
`void`	`setResultSetCopyNumber(String resultSetCopyNumber)`
`void`	`setResultSetStepName(String resultSetStepName)`
`void`	`setSafeMode(String safeMode)`
`void`	`setTrustRepoUser(String trustRepoUser)`
`void`	`setUuid(String uuid)`
`void`	`setVersion(String version)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - getUuid
```
public String getUuid()
```
    Specified by:
    
    getUuid in interface IParams
    
    Returns:
    
    uuid uniquely identifies an execution request
  - setUuid
```
public void setUuid(String uuid)
```
  - getRepoName
```
public String getRepoName()
```
    Specified by:
    
    getRepoName in interface IParams
    
    Returns:
    
    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
    
    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.
  - setBlockRepoConns
```
public void setBlockRepoConns(String blockRepoConns)
```
  - getRepoUsername
```
public String getRepoUsername()
```
    Specified by:
    
    getRepoUsername in interface IParams
    
    Returns:
    
    repoUsername Repository username
  - setRepoUsername
```
public void setRepoUsername(String repoUsername)
```
  - getTrustRepoUser
```
public String getTrustRepoUser()
```
    Specified by:
    
    getTrustRepoUser in interface IParams
    
    Returns:
    
    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
    
    Returns:
    
    repoPassword Repository password
  - setRepoPassword
```
public void setRepoPassword(String repoPassword)
```
  - getInputDir
```
public String getInputDir()
```
    Specified by:
    
    getInputDir in interface IParams
    
    Returns:
    
    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
    
    Returns:
    
    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
    
    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
  - setLocalJarFile
```
public void setLocalJarFile(String localJarFile)
```
  - getInputFile
```
public String getInputFile()
```
    Specified by:
    
    getInputFile in interface IParams
    
    Returns:
    
    inputFile The name of the file to launch
  - setInputFile
```
public void setInputFile(String inputFile)
```
  - getListRepoFiles
```
public String getListRepoFiles()
```
    Specified by:
    
    getListRepoFiles in interface IParams
    
    Returns:
    
    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
    
    Returns:
    
    listDirs Lists the directories in the specified repository
  - setListRepoDirs
```
public void setListRepoDirs(String listRepoDirs)
```
  - getExportRepo
```
public String getExportRepo()
```
    Specified by:
    
    getExportRepo in interface IParams
    
    Returns:
    
    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
    
    Returns:
    
    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
    
    Returns:
    
    listRepos Lists the available repositories
  - setListRepos
```
public void setListRepos(String listRepos)
```
  - getSafeMode
```
public String getSafeMode()
```
    Specified by:
    
    getSafeMode in interface IParams
    
    Returns:
    
    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
    
    Returns:
    
    metrics Enables kettle metric gathering
  - setMetrics
```
public void setMetrics(String metrics)
```
  - getListFileParams
```
public String getListFileParams()
```
    Specified by:
    
    getListFileParams in interface IParams
    
    Returns:
    
    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
    
    Returns:
    
    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
    
    Returns:
    
    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
    
    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)
  - setMaxLogTimeout
```
public void setMaxLogTimeout(String maxLogTimeout)
```
  - getLogFile
```
public String getLogFile()
```
    Specified by:
    
    getLogFile in interface IParams
    
    Returns:
    
    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
    
    Returns:
    
    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
    
    Returns:
    
    version Shows the version, revision, and build date
  - setVersion
```
public void setVersion(String version)
```
  - getResultSetStepName
```
public String getResultSetStepName()
```
    Specified by:
    
    getResultSetStepName in interface IParams
    
    Returns:
    
    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
    
    Returns:
    
    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
    
    Returns:
    
    the BASE64 representation of the zipped ETL work item
  - setBase64Zip
```
public void setBase64Zip(String base64Zip)
```
  - getNamedParams
```
public NamedParams getNamedParams()
```
    Specified by:
    
    getNamedParams in interface IParams
    
    Returns:
    
    namedParams parameters to be passed into the executing file
  - setNamedParams
```
public void setNamedParams(NamedParams params)
```
  - getParams
```
public Map<String,String> getParams()
```
    Specified by:
    
    getParams in interface IParams
    
    Returns:
    
    params parameters to be passed into the executing file
  - getCustomNamedParams
```
public NamedParams getCustomNamedParams()
```
    Specified by:
    
    getCustomNamedParams in interface IParams
    
    Returns:
    
    namedParams custom parameters to be passed into the executing file
  - setCustomNamedParams
```
public void setCustomNamedParams(NamedParams customNamedParams)
```
  - getCustomParams
```
public Map<String,String> getCustomParams()
```
    Specified by:
    
    getCustomParams in interface IParams
    
    Returns:
    
    customParams parameters to be passed into the executing file

Class Params

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getUuid

setUuid

getRepoName

setRepoName

getBlockRepoConns

setBlockRepoConns

getRepoUsername

setRepoUsername

getTrustRepoUser

setTrustRepoUser

getRepoPassword

setRepoPassword

getInputDir

setInputDir

getLocalFile

setLocalFile

getLocalJarFile

setLocalJarFile

getInputFile

setInputFile

getListRepoFiles

setListRepoFiles

getListRepoDirs

setListRepoDirs

getExportRepo

setExportRepo

getLocalInitialDir

setLocalInitialDir

getListRepos

setListRepos

getSafeMode

setSafeMode

getMetrics

setMetrics

getListFileParams

setListFileParams

getLogLevel

setLogLevel

getMaxLogLines

setMaxLogLines

getMaxLogTimeout

setMaxLogTimeout

getLogFile

setLogFile

getOldLogFile

setOldLogFile

getVersion

setVersion

getResultSetStepName

setResultSetStepName

getResultSetCopyNumber

setResultSetCopyNumber

getBase64Zip

setBase64Zip

getNamedParams

setNamedParams

getParams

getCustomNamedParams

setCustomNamedParams

getCustomParams