Operation: RenameFile

With the RenameFile operation, you rename a file.

For more information on other operations of the Microsoft Azure Data Lake Gen 1 Storage Connector, see Microsoft Azure Data Lake Gen 1 Storage Connector.

Note:

If the target file already exists (that is, a file with the same name), the source file is renamed only if the overwrite parameter is set to true.

Parameters

`Adapter`	Main class of the adapter (do not change!) Possible values: de.softproject.integration.adapter.microsoft.azure.datalake.MicrosoftAzureDataLakeStoreConnector: Main Class (Standard)
`authEndpoint`	This parameter is required. OAuth 2.0 Token Endpoint (v1) Possible values: String with a valid endpoint, e.g.: `https://login.microsoftonline.com/<DirectoryID>/oauth2/token`
`clientID`	This parameter is required. Client ID of the Azure Active Directory application Possible values: Any string with the client ID, e.g.: `10925xxx-1111-4444-bd3d-82165c0d3841`
`clientSecret`	This parameter is required. Secret client key of the Azure Active Directory application Possible values: String containing the secret client key.
`accountName`	This parameter is required. Fully qualified Data Lake Storage Account Name (FQDN) Possible values: String containing the FQDN, e.g.: `<your_account_name>.azuredatalakestore.net`
`fileName`	This parameter is required. File name Possible values: String with the file name, e.g. : `inputFile.txt` or `root/subfolder/inputFile.txt` Note: The string can contain the full file path (`root/subfolder/inputFile.txt`), as well as the file name (`fileNameinputFile.txt`) and folder name (`folderPathroot/subfolder`).
`folderPath`	Folder path. Can start and end with a slash. Possible values: `/`: Root folder Any valid path, e.g. `root/subfolder/.../lastFolder`
`overwrite`	Specifies whether to overwrite existing files. Possible values: `true`: Overwrite existing file (specified in `fileName`) with new content `false`: For the `UploadFile` operation, the adapter returns an error if the file already exists. For the `RenameFile` operation, the adapter outputs the `1` status, but does not rename the source file.
	This parameter is required. New path name of the file to be renamed. Possible values: Path name, e.g.:

Status values

`1`	The adapter operation was executed successfully
`-1`	The operation failed due to a technical error.

Input

This operation does not require specific input XML.

Output

If the RenameFile operation was executed successfully (status 1), the adapter renames the desired file as specified.

If the operation was unsuccessful, i.e. in the event of an error (status -1⁣), the adapter returns an XML document with the error description, e.g.: