JobEntrySFTPPUT (PDI Engine 8.3.0.0-0.2.3 API)

java.lang.Object
- org.pentaho.di.job.entry.JobEntryBase
- - org.pentaho.di.job.entries.sftpput.JobEntrySFTPPUT

所有已实现的接口:

Cloneable, org.pentaho.di.core.AttributesInterface, org.pentaho.di.core.CheckResultSourceInterface, org.pentaho.di.core.ExtensionDataInterface, org.pentaho.di.core.logging.LoggingObjectInterface, org.pentaho.di.core.variables.VariableSpace, JobEntryInterface, ResourceHolderInterface
```
public class JobEntrySFTPPUT
extends JobEntryBase
implements Cloneable, JobEntryInterface
```
This defines an SFTP put job entry.

从以下版本开始:

05-11-2003

作者:

Matt

字段概要

字段
限定符和类型	字段和说明
`static int`	`AFTER_FTPSPUT_DELETE`
`static int`	`AFTER_FTPSPUT_MOVE`
`static int`	`AFTER_FTPSPUT_NOTHING`
`static String[]`	`afterFTPSCode`
`static String[]`	`afterFTPSDesc`

从类继承的字段 org.pentaho.di.job.entry.JobEntryBase
attributesMap, containerObjectId, entryStepSetVariablesMap, extensionDataMap, log, metaStore, parentJob, parentJobMeta, rep, variables

构造器概要

构造器
构造器和说明

JobEntrySFTPPUT()

JobEntrySFTPPUT(String n)

构造器
构造器和说明
`JobEntrySFTPPUT()`
`JobEntrySFTPPUT(String n)`

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`void`	`check(List<org.pentaho.di.core.CheckResultInterface> remarks, JobMeta jobMeta, org.pentaho.di.core.variables.VariableSpace space, Repository repository, org.pentaho.metastore.api.IMetaStore metaStore)` Allows JobEntry objects to check themselves for consistency
`Object`	`clone()` This method is called when a job entry is duplicated in Spoon.
`boolean`	`evaluates()` This method must return true if the job entry supports the true/false outgoing hops.
`org.pentaho.di.core.Result`	`execute(org.pentaho.di.core.Result previousResult, int nr)` Execute the job entry.
`int`	`getAfterFTPS()`
`static int`	`getAfterSFTPPutByCode(String tt)`
`static int`	`getAfterSFTPPutByDesc(String tt)`
`static String`	`getAfterSFTPPutCode(int i)`
`static String`	`getAfterSFTPPutDesc(int i)`
`String`	`getCompression()`
`String`	`getDestinationFolder()`
`String`	`getKeyFilename()`
`String`	`getKeyPassPhrase()`
`String`	`getLocalDirectory()`
`String`	`getPassword()`
`String`	`getProxyHost()`
`String`	`getProxyPassword()`
`String`	`getProxyPort()`
`String`	`getProxyType()`
`String`	`getProxyUsername()`
`List<ResourceReference>`	`getResourceDependencies(JobMeta jobMeta)` Gets a list of all the resource dependencies that the step is depending on.
`String`	`getScpDirectory()`
`String`	`getServerName()`
`String`	`getServerPort()`
`String`	`getUserName()`
`String`	`getWildcard()`
`String`	`getXML()` This method is called by PDI whenever a job entry needs to serialize its settings to XML.
`boolean`	`isAddFilenameResut()`
`boolean`	`isCopyPrevious()`
`boolean`	`isCopyPreviousFiles()`
`boolean`	`isCreateDestinationFolder()`
`boolean`	`isCreateRemoteFolder()`
`boolean`	`isSuccessWhenNoFile()`
`boolean`	`isUseKeyFile()`
`void`	`loadRep(Repository rep, org.pentaho.metastore.api.IMetaStore metaStore, org.pentaho.di.repository.ObjectId id_jobentry, List<org.pentaho.di.core.database.DatabaseMeta> databases, List<SlaveServer> slaveServers)` This method is called by PDI whenever a job entry needs to read its configuration from a PDI repository.
`void`	`loadXML(Node entrynode, List<org.pentaho.di.core.database.DatabaseMeta> databases, List<SlaveServer> slaveServers, Repository rep, org.pentaho.metastore.api.IMetaStore metaStore)` This method is called by PDI whenever a job entry needs to read its settings from XML.
`void`	`saveRep(Repository rep, org.pentaho.metastore.api.IMetaStore metaStore, org.pentaho.di.repository.ObjectId id_job)` This method is called by PDI whenever a job entry needs to save its settings to a PDI repository.
`void`	`setAddFilenameResut(boolean addFilenameResut)`
`void`	`setAfterFTPS(int value)`
`void`	`setCompression(String compression)`
`void`	`setCopyPrevious(boolean copyprevious)`
`void`	`setCopyPreviousFiles(boolean copypreviousfiles)`
`void`	`setCreateDestinationFolder(boolean createDestinationFolder)`
`void`	`setCreateRemoteFolder(boolean value)`
`void`	`setDestinationFolder(String destinationfolderin)`
`void`	`setKeyFilename(String value)`
`void`	`setKeyPassPhrase(String value)`
`void`	`setLocalDirectory(String localDirectory)`
`void`	`setPassword(String password)`
`void`	`setProxyHost(String value)`
`void`	`setProxyPassword(String value)`
`void`	`setProxyPort(String value)`
`void`	`setProxyType(String value)`
`void`	`setProxyUsername(String value)`
`void`	`setScpDirectory(String directory)`
`void`	`setServerName(String serverName)`
`void`	`setServerPort(String serverPort)`
`void`	`setSuccessWhenNoFile(boolean successWhenNoFile)`
`void`	`setUseKeyFile(boolean value)`
`void`	`setUserName(String userName)`
`void`	`setWildcard(String wildcard)`

从类继承的方法 org.pentaho.di.job.entry.JobEntryBase
check, clear, copyVariablesFrom, environmentSubstitute, environmentSubstitute, equals, exportResources, exportResources, fieldSubstitute, getAttribute, getAttributes, getAttributesMap, getBooleanValueOfVariable, getContainerObjectId, getDescription, getDialogClassName, getEntryStepSetVariable, getEntryStepSetVariablesMap, getExtensionDataMap, getFilename, getHolderType, getLogChannel, getLogChannelId, getLogLevel, getMetaStore, getName, getObjectCopy, getObjectId, getObjectName, getObjectRevision, getObjectType, getParent, getParentJob, getParentJobMeta, getParentVariableSpace, getPluginId, getRealFilename, getReferencedObjectDescriptions, getRegistrationDate, getRepository, getRepositoryDirectory, getSQLStatements, getSQLStatements, getSQLStatements, getTypeDesc, getTypeId, getUsedDatabaseConnections, getVariable, getVariable, getVariables, hasChanged, hashCode, hasRepositoryReferences, initializeVariablesFrom, injectVariables, isBasic, isDebug, isDetailed, isDummy, isEvaluation, isForcingSeparateLogging, isFTP, isGatheringMetrics, isHTTP, isJob, isMail, isReferencedObjectEnabled, isRowlevel, isSFTP, isShell, isSpecial, isStart, isTransformation, isUnconditional, listVariables, loadReferencedObject, loadReferencedObject, loadRep, loadXML, loadXML, logBasic, logBasic, logDebug, logDebug, logDetailed, logDetailed, logError, logError, logError, logMinimal, logMinimal, logRowlevel, logRowlevel, lookupRepositoryReferences, parseRepositoryObjects, resetErrorsBeforeExecution, saveRep, setAttribute, setAttributes, setAttributesMap, setChanged, setChanged, setContainerObjectId, setDescription, setEntryStepSetVariable, setForcingSeparateLogging, setGatheringMetrics, setID, setLogLevel, setMetaStore, setName, setObjectId, setParentJob, setParentJobMeta, setParentVariableSpace, setPluginId, setRepository, setTypeId, setVariable, shareVariablesWith, toString

从类继承的方法 java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- 字段详细资料
  - afterFTPSDesc
```
public static final String[] afterFTPSDesc
```
  - afterFTPSCode
```
public static final String[] afterFTPSCode
```
  - AFTER_FTPSPUT_NOTHING
```
public static final int AFTER_FTPSPUT_NOTHING
```
    另请参阅:
    
    常量字段值
  - AFTER_FTPSPUT_DELETE
```
public static final int AFTER_FTPSPUT_DELETE
```
    另请参阅:
    
    常量字段值
  - AFTER_FTPSPUT_MOVE
```
public static final int AFTER_FTPSPUT_MOVE
```
    另请参阅:
    
    常量字段值
- 构造器详细资料
  - JobEntrySFTPPUT
```
public JobEntrySFTPPUT(String n)
```
  - JobEntrySFTPPUT
```
public JobEntrySFTPPUT()
```
- 方法详细资料
  - clone
```
public Object clone()
```
    从类复制的说明: JobEntryBase
    
    This method is called when a job entry is duplicated in Spoon. It needs to return a deep copy of this job entry object. It is essential that the implementing class creates proper deep copies if the job entry configuration is stored in modifiable objects, such as lists or custom helper objects.
    
    指定者:
    
    clone 在接口中 JobEntryInterface
    
    覆盖:
    
    clone 在类中 JobEntryBase
    
    返回:
    
    a clone of the object
  - getXML
```
public String getXML()
```
    从类复制的说明: JobEntryBase
    
    This method is called by PDI whenever a job entry needs to serialize its settings to XML. It is called when saving a job in Spoon. The method returns an XML string, containing the serialized settings. The string contains a series of XML tags, typically one tag per setting. The helper class org.pentaho.di.core.xml.XMLHandler is typically used to construct the XML string.
    
    指定者:
    
    getXML 在接口中 JobEntryInterface
    
    覆盖:
    
    getXML 在类中 JobEntryBase
    
    返回:
    
    the xml representation of the job entry
  - getAfterSFTPPutCode
```
public static String getAfterSFTPPutCode(int i)
```
  - loadXML
```
public void loadXML(Node entrynode,
                    List<org.pentaho.di.core.database.DatabaseMeta> databases,
                    List<SlaveServer> slaveServers,
                    Repository rep,
                    org.pentaho.metastore.api.IMetaStore metaStore)
             throws org.pentaho.di.core.exception.KettleXMLException
```
    从接口复制的说明: JobEntryInterface
    
    This method is called by PDI whenever a job entry needs to read its settings from XML. The XML node containing the job entry's settings is passed in as an argument. Again, the helper class org.pentaho.di.core.xml.XMLHandler is typically used to conveniently read the settings from the XML node.
    
    指定者:
    
    loadXML 在接口中 JobEntryInterface
    
    覆盖:
    
    loadXML 在类中 JobEntryBase
    
    参数:
    
    entrynode - the top-level XML node
    
    databases - the list of databases
    
    slaveServers - the list of slave servers
    
    rep - the repository object
    
    metaStore - The metaStore to optionally load from.
    
    抛出:
    
    org.pentaho.di.core.exception.KettleXMLException - if any errors occur during the loading of the XML
  - getAfterSFTPPutByCode
```
public static int getAfterSFTPPutByCode(String tt)
```
  - getAfterSFTPPutDesc
```
public static String getAfterSFTPPutDesc(int i)
```
  - getAfterSFTPPutByDesc
```
public static int getAfterSFTPPutByDesc(String tt)
```
  - loadRep
```
public void loadRep(Repository rep,
                    org.pentaho.metastore.api.IMetaStore metaStore,
                    org.pentaho.di.repository.ObjectId id_jobentry,
                    List<org.pentaho.di.core.database.DatabaseMeta> databases,
                    List<SlaveServer> slaveServers)
             throws org.pentaho.di.core.exception.KettleException
```
    从接口复制的说明: JobEntryInterface
    
    This method is called by PDI whenever a job entry needs to read its configuration from a PDI repository. The job entry id given in the arguments should be used as the identifier when using the repository's serialization methods.
    
    指定者:
    
    loadRep 在接口中 JobEntryInterface
    
    覆盖:
    
    loadRep 在类中 JobEntryBase
    
    参数:
    
    rep - the repository object
    
    metaStore - the MetaStore to use
    
    id_jobentry - the id of the job entry
    
    databases - the list of databases
    
    slaveServers - the list of slave servers
    
    抛出:
    
    org.pentaho.di.core.exception.KettleException - if any errors occur during the load
  - saveRep
```
public void saveRep(Repository rep,
                    org.pentaho.metastore.api.IMetaStore metaStore,
                    org.pentaho.di.repository.ObjectId id_job)
             throws org.pentaho.di.core.exception.KettleException
```
    从接口复制的说明: JobEntryInterface
    
    This method is called by PDI whenever a job entry needs to save its settings to a PDI repository. The repository object passed in as the first argument provides a convenient set of methods for serializing job entry settings. When calling repository serialization methods, job id and job entry id are required. The job id is passed in to saveRep() as an argument, and the job entry id can be obtained by a call to getObjectId() inherited from the base class.
    
    指定者:
    
    saveRep 在接口中 JobEntryInterface
    
    覆盖:
    
    saveRep 在类中 JobEntryBase
    
    参数:
    
    rep - the repository
    
    metaStore - the MetaStore to use
    
    id_job - the id_job
    
    抛出:
    
    org.pentaho.di.core.exception.KettleException - if any errors occur during the save
  - setCreateDestinationFolder
```
public void setCreateDestinationFolder(boolean createDestinationFolder)
```
    参数:
    
    createDestinationFolder - The create destination folder flag to set.
  - isCreateDestinationFolder
```
public boolean isCreateDestinationFolder()
```
    返回:
    
    Returns the create destination folder flag
  - setSuccessWhenNoFile
```
public void setSuccessWhenNoFile(boolean successWhenNoFile)
```
    参数:
    
    successWhenNoFile - The successWhenNoFile flag to set.
  - isSuccessWhenNoFile
```
public boolean isSuccessWhenNoFile()
```
    返回:
    
    Returns the create successWhenNoFile folder flag
  - setDestinationFolder
```
public void setDestinationFolder(String destinationfolderin)
```
  - getDestinationFolder
```
public String getDestinationFolder()
```
  - getAfterFTPS
```
public int getAfterFTPS()
```
    返回:
    
    Returns the afterFTPS.
  - setAfterFTPS
```
public void setAfterFTPS(int value)
```
    参数:
    
    value - The afterFTPS to set.
  - getScpDirectory
```
public String getScpDirectory()
```
    返回:
    
    Returns the directory.
  - setScpDirectory
```
public void setScpDirectory(String directory)
```
    参数:
    
    directory - The directory to set.
  - getPassword
```
public String getPassword()
```
    返回:
    
    Returns the password.
  - setPassword
```
public void setPassword(String password)
```
    参数:
    
    password - The password to set.
  - getServerName
```
public String getServerName()
```
    返回:
    
    Returns the serverName.
  - setServerName
```
public void setServerName(String serverName)
```
    参数:
    
    serverName - The serverName to set.
  - getUserName
```
public String getUserName()
```
    返回:
    
    Returns the userName.
  - setUserName
```
public void setUserName(String userName)
```
    参数:
    
    userName - The userName to set.
  - getWildcard
```
public String getWildcard()
```
    返回:
    
    Returns the wildcard.
  - setWildcard
```
public void setWildcard(String wildcard)
```
    参数:
    
    wildcard - The wildcard to set.
  - getLocalDirectory
```
public String getLocalDirectory()
```
    返回:
    
    Returns the localdirectory.
  - setLocalDirectory
```
public void setLocalDirectory(String localDirectory)
```
    参数:
    
    localDirectory - The localDirectory to set.
  - isCopyPrevious
```
public boolean isCopyPrevious()
```
  - setCopyPrevious
```
public void setCopyPrevious(boolean copyprevious)
```
  - isCopyPreviousFiles
```
public boolean isCopyPreviousFiles()
```
  - setCopyPreviousFiles
```
public void setCopyPreviousFiles(boolean copypreviousfiles)
```
  - isAddFilenameResut
```
public boolean isAddFilenameResut()
```
  - isUseKeyFile
```
public boolean isUseKeyFile()
```
  - setUseKeyFile
```
public void setUseKeyFile(boolean value)
```
  - getKeyFilename
```
public String getKeyFilename()
```
  - setKeyFilename
```
public void setKeyFilename(String value)
```
  - getKeyPassPhrase
```
public String getKeyPassPhrase()
```
  - setKeyPassPhrase
```
public void setKeyPassPhrase(String value)
```
  - setAddFilenameResut
```
public void setAddFilenameResut(boolean addFilenameResut)
```
  - getCompression
```
public String getCompression()
```
    返回:
    
    Returns the compression.
  - setCompression
```
public void setCompression(String compression)
```
    参数:
    
    compression - The compression to set.
  - getServerPort
```
public String getServerPort()
```
  - setServerPort
```
public void setServerPort(String serverPort)
```
  - getProxyType
```
public String getProxyType()
```
  - setProxyType
```
public void setProxyType(String value)
```
  - getProxyHost
```
public String getProxyHost()
```
  - setProxyHost
```
public void setProxyHost(String value)
```
  - getProxyPort
```
public String getProxyPort()
```
  - setProxyPort
```
public void setProxyPort(String value)
```
  - getProxyUsername
```
public String getProxyUsername()
```
  - setProxyUsername
```
public void setProxyUsername(String value)
```
  - getProxyPassword
```
public String getProxyPassword()
```
  - setProxyPassword
```
public void setProxyPassword(String value)
```
  - isCreateRemoteFolder
```
public boolean isCreateRemoteFolder()
```
  - setCreateRemoteFolder
```
public void setCreateRemoteFolder(boolean value)
```
  - execute
```
public org.pentaho.di.core.Result execute(org.pentaho.di.core.Result previousResult,
                                          int nr)
                                   throws org.pentaho.di.core.exception.KettleException
```
    从接口复制的说明: JobEntryInterface
    
    Execute the job entry. The previous result and number of rows are provided to the method for the purpose of chaining job entries, transformations, etc.
    
    指定者:
    
    execute 在接口中 JobEntryInterface
    
    参数:
    
    previousResult - the previous result
    
    nr - the number of rows
    
    返回:
    
    the Result object from execution of this job entry
    
    抛出:
    
    org.pentaho.di.core.exception.KettleException - if any Kettle exceptions occur
  - evaluates
```
public boolean evaluates()
```
    从类复制的说明: JobEntryBase
    
    This method must return true if the job entry supports the true/false outgoing hops. For JobEntryBase, this method always returns false
    
    指定者:
    
    evaluates 在接口中 JobEntryInterface
    
    覆盖:
    
    evaluates 在类中 JobEntryBase
    
    返回:
    
    false
  - getResourceDependencies
```
public List<ResourceReference> getResourceDependencies(JobMeta jobMeta)
```
    从类复制的说明: JobEntryBase
    
    Gets a list of all the resource dependencies that the step is depending on. In JobEntryBase, this method returns an empty resource dependency list.
    
    指定者:
    
    getResourceDependencies 在接口中 JobEntryInterface
    
    覆盖:
    
    getResourceDependencies 在类中 JobEntryBase
    
    返回:
    
    an empty list of ResourceReferences
    
    另请参阅:
    
    ResourceReference
  - check
```
public void check(List<org.pentaho.di.core.CheckResultInterface> remarks,
                  JobMeta jobMeta,
                  org.pentaho.di.core.variables.VariableSpace space,
                  Repository repository,
                  org.pentaho.metastore.api.IMetaStore metaStore)
```
    从类复制的说明: JobEntryBase
    
    Allows JobEntry objects to check themselves for consistency
    
    指定者:
    
    check 在接口中 JobEntryInterface
    
    覆盖:
    
    check 在类中 JobEntryBase
    
    参数:
    
    remarks - List of CheckResult objects indicating consistency status
    
    jobMeta - the metadata object for the job entry
    
    space - the variable space to resolve string expressions with variables with
    
    repository - the repository to load Kettle objects from
    
    metaStore - the MetaStore to load common elements from

类 JobEntrySFTPPUT

字段概要

从类继承的字段 org.pentaho.di.job.entry.JobEntryBase

构造器概要

方法概要

从类继承的方法 org.pentaho.di.job.entry.JobEntryBase

从类继承的方法 java.lang.Object

从接口继承的方法 org.pentaho.di.job.entry.JobEntryInterface

字段详细资料

afterFTPSDesc

afterFTPSCode

AFTER_FTPSPUT_NOTHING

AFTER_FTPSPUT_DELETE

AFTER_FTPSPUT_MOVE

构造器详细资料

JobEntrySFTPPUT

JobEntrySFTPPUT

方法详细资料

clone

getXML

getAfterSFTPPutCode

loadXML

getAfterSFTPPutByCode

getAfterSFTPPutDesc

getAfterSFTPPutByDesc

loadRep

saveRep

setCreateDestinationFolder

isCreateDestinationFolder

setSuccessWhenNoFile

isSuccessWhenNoFile

setDestinationFolder

getDestinationFolder

getAfterFTPS

setAfterFTPS

getScpDirectory

setScpDirectory

getPassword

setPassword

getServerName

setServerName

getUserName

setUserName

getWildcard

setWildcard

getLocalDirectory

setLocalDirectory

isCopyPrevious

setCopyPrevious

isCopyPreviousFiles

setCopyPreviousFiles

isAddFilenameResut

isUseKeyFile

setUseKeyFile

getKeyFilename

setKeyFilename

getKeyPassPhrase

setKeyPassPhrase

setAddFilenameResut

getCompression

setCompression

getServerPort

setServerPort

getProxyType

setProxyType

getProxyHost

setProxyHost

getProxyPort

setProxyPort

getProxyUsername

setProxyUsername

getProxyPassword

setProxyPassword

isCreateRemoteFolder

setCreateRemoteFolder

execute

evaluates

getResourceDependencies

check