Connectors of ballerina.net.ftp package
connector ClientConnector ()
Parameters:
Parameter Name | Data Type | Description |
---|
action copy()
Copies a file from a given location to another
Parameters:
Parameter Name | Data Type | Description |
---|---|---|
destination | files:File | Location where the File/Directory should be pasted |
action createFile()
Create a file or folder
Parameters:
Parameter Name | Data Type | Description |
---|---|---|
isDir | boolean | Specify whether it is a file or a folder |
action delete()
Deletes a file from a given location
Parameters:
Parameter Name | Data Type | Description |
---|
action exists()
Checks the existence of a file
Parameters:
Parameter Name | Data Type | Description |
---|
Return Parameters:
Return Variable | Data Type | Description |
---|---|---|
boolean | The availability of the file |
action move()
Moves a file from a given location to another
Parameters:
Parameter Name | Data Type | Description |
---|---|---|
destination | files:File | Location where the File/Directory should be moved to |
action read()
Retrieves blob value of a file
Parameters:
Parameter Name | Data Type | Description |
---|
Return Parameters:
Return Variable | Data Type | Description |
---|---|---|
blob | data: The blob containing files read |
action write()
Writes a file using the given blob
Parameters:
Parameter Name | Data Type | Description |
---|---|---|
file | files:File | Path of the file |
Annotations of ballerina.net.ftp package
annotation configuration
Attributes:
Attribute Name | Data Type | Description |
---|---|---|
dirURI | string | |
fileNamePattern | string | |
pollingInterval | string | |
cronExpression | string | |
ackTimeOut | string | |
perPollFileCount | string | |
fileSortAttribute | string | |
fileSortAscending | string | |
actionAfterProcess | string | |
actionAfterFailure | string | |
moveAfterProcess | string | |
moveAfterFailure | string | |
moveTimestampFormat | string | |
createMoveDir | string | |
parallel | string | |
threadPoolSize | string | |
sftpIdentities | string | |
sftpIdentityPassPhrase | string | |
sftpUserDirIsRoot | string |