Ballerina API Documentation

Connectors of ballerina.net.ftp package

connector ClientConnector ()

Parameters:

Parameter NameData TypeDescription

Actions:

action copy()

Copies a file from a given location to another

Parameters:

Parameter NameData TypeDescription
cClientConnectorFTP connector
sourcefiles:Filec: FTP connector
destinationfiles:FileLocation where the File/Directory should be pasted

action createFile()

Create a file or folder

Parameters:

Parameter NameData TypeDescription
cClientConnectorFTP connector
filefiles:FilePath of the file
typestringSpecification whether file or folder

action delete()

Deletes a file from a given location

Parameters:

Parameter NameData TypeDescription
cClientConnectorFTP connector
targetfiles:FileFile/Directory that should be deleted

action exists()

Checks the existence of a file

Parameters:

Parameter NameData TypeDescription
cClientConnectorFTP connector
filefiles:FileFile struct containing path information

Return Parameters:

Return VariableData TypeDescription
booleanThe availability of the file

action move()

Moves a file from a given location to another

Parameters:

Parameter NameData TypeDescription
cClientConnectorFTP connector
targetfiles:FileFile/Directory that should be moved
destinationfiles:FileLocation where the File/Directory should be moved to

action read()

Retrieves blob value of a file

Parameters:

Parameter NameData TypeDescription
cClientConnectorFTP connector
filefiles:FileThe file to be read

Return Parameters:

Return VariableData TypeDescription
blobdata: The blob containing files read

action write()

Writes a file using the given blob

Parameters:

Parameter NameData TypeDescription
cClientConnectorFTP connector
contentblobc: FTP connector
filefiles:FilePath of the file


Annotations of ballerina.net.ftp package

annotation config

Attributes:

Attribute NameData TypeDescription
dirURIstring
fileNamePatternstring
pollingIntervalstring
cronExpressionstring
ackTimeOutstring
perPollFileCountstring
fileSortAttributestring
fileSortAscendingstring
actionAfterProcessstring
actionAfterFailurestring
moveAfterProcessstring
moveAfterFailurestring
moveTimestampFormatstring
createMoveDirstring
parallelstring
threadPoolSizestring
sftpIdentitiesstring
sftpIdentityPassPhrasestring
sftpUserDirIsRootstring


Menu

  • Connectors
    • ClientConnector ()
      • copy(ClientConnector c, files:File source, files:File destination)
      • createFile(ClientConnector c, files:File file, string type)
      • delete(ClientConnector c, files:File target)
      • exists(ClientConnector c, files:File file)
      • move(ClientConnector c, files:File target, files:File destination)
      • read(ClientConnector c, files:File file)
      • write(ClientConnector c, blob content, files:File file)
  • Annotations
    • config

Copyright 2017 Ballerina API Documentation