Delete File/Folder

Operation Name

Delete File/Folder

Function overview

Delete file / folder on Google Drive.

Data Model

Data model of this component is XML type.

Properties

For information about using variables, refer to "variables".

Basic settings

Item name	Required/Optional	Use of Variables	Description	Remarks
Name	Required	Not available	Enter the name on the script canvas.

Required settings

Item name	Required/Optional	Use of Variables	Description	Remarks
Destination	Required	Not available	Select Global Resources. [Add]: Adds new global resource. [Edit list]: Global resource settings can be managed from "Edit Resource list".
Drive type	Required	Not Available	Select a processing drive. [My drive]: (default) Specify the target of processing as "My drive". [Shared drive]: Specify the target of processing as "Shared drive".
Shared drive name	Required	Available	Select or enter the Shared drive name.	Enabled when [Shared drive] is selected in [Drive type].
Folder path	Required	Available	Enter a Google Drive folder path.	Google Drive folder path needs to be absolute path. Constrained Characters of DataSpider File System cannot be used, except for the path separator "/".
Delete folder	Optional	Not available	Select whether to delete the folder specified in [Folder path]. [Checked]: Delete the folder specified in [Folder path] and all files/folders in the folder. [Not Checked]: (default) Do not delete the folder specified in [Folder path]. Behavior against a file/folder in the folder depends on [File/folder name] and [Recursive processing] settings.
File/folder name	Required	Available	Specify a file/folder in the folder specified in [Folder path] If a file is specified, or if a file matches with a wildcard, delete the corresponding file. If a folder is specified, or if a folder matches with a wildcard, whether to delete it or not depends on the settings of [Recursive processing].	If you check [Delete folder], then it will be disabled. Wildcards("*" and "?") are available. "/" Can not be included.
Recursive processing	Optional	Not available	For a specified folder, select whether to delete the file/folder recursively or not. [Checked]: If a folder specified in [File/folder name] contains folder, then delete it recursively. [Not Checked]: (default) Only those files found in the specified folder are retrieved.

Property Action

Item name	Description	Remarks
Refresh shared drive name list	Get the shared drive in the specified destination, and set it in [Shared drive name].	Disabled when [Destination] is not specified or [My drive] is selected in [Drive type]. If [Destination] is specified/edited, or a drive has been added/edited on Google Drive, you can apply the changes by using this property action.
Refresh list of folder paths	Get the folder path on the specified destination, and set it in [Folder path].	In the following cases, this property action is disabled: [Destination] is not specified [Shared drive name] is not specified A script variable is specified in [Shared drive name] If [Destination] or [Shared drive name] is specified/edited, or a folder has been added/edited on Google Drive, you can apply the changes by using this property action.
Refresh list of item names	Gets file/folder name in the specified folder path and set to [File/folder name].	If [Folder path] is specified/edited, or add/edit of folder is performed on Google Drive, the edition can be reflected using this property action. If variable is set to [Folder path], or [Delete folder] is checked, this action will be invalid.

Comment

Item name	Required/Optional	Use of Variables	Description	Remarks
Comment	Optional	Not available	You can write a short description of this adapter. The description will be reflected in the specifications.

Schema

Input Schema

None.

Output Schema

<?xml version="1.0"?>
<server>
  <files drivename="" drivetype="">
    <file name="" remotepath="" status="" type="" />
  </files>
</server>

Element name	Attribute name	Description	Remarks
server	-
files	-
	drivename	Outputs the obtained shared drive name.
	drivetype	Outputs the obtained drive type.
file	-	Appear in each deleted file/folder.	Lower-level files/folders in a deleted folder do not appear.
	name	Output the name of the deleted file/folder.	If status is "ErrorRemoteFolderNotFound" then the value is blank. If [Delete folder] is [Checked] then the value is blank.
	remotepath	Output the file path on Google Drive of the deleted file/folder.
	status	Output the status of the deleted file/folder. Deleted: Status that the file/folder is successfully deleted. ErrorRemoteDriveNotFound: The specified [Shared drive name] does not exist on Google Drive. ErrorRemoteFolderNotFound: The status that on Google Drive, specified [Folder path] does not exist, or file is specified. ErrorRemoteFileNotFound: The status that on Google Drive, specified file / folder does not exist in specified [Folder path]. Error: The status that because an error occurred file / folder could not be deleted.
	type	Output the classification of deleted files/folders. File: File Folder: Folder

Loading schema in Mapper

Schema is loaded automatically.

See "Edit Schema" for any details .

Mass Data Processing

Mass data processing is not supported.

Transaction

Transaction is not supported.

PSP Usage

PSP is not supported.

Available component variables

Component variable name	Description	Remarks
count	Return the number which is the total number of the deleted folder and file.	The value defaults to null. The sum of' 'folder_count' and 'file_count'.
folder_count	Return the number of deleted folders.	The value defaults to null.
file_count	Return the number of deleted files.	The value defaults to null.
message_category	Stroes the category to which corresponding message code belongs to, when an error occurs.	The value defaults to null.
message_code	Stores its corresponding message code of occurred error.	The value defaults to null.
message_level	Stores the severity of the corresponding message code of the occurred error.	The value defaults to null.
error_type	Stores the type of the occurred error.	The value defaults to null. Error is represented in the format depicted below. Example:java.io.FileNotFoundException The message may vary depending on DataSpider Servista version.
error_message	Stores the error message for the occurred error.	The value defaults to null. The message may vary depending on DataSpider Servista version.
error_trace	Stores stack trace of the occurred error.	The value defaults to null. The message may vary depending on DataSpider Servista version or the client application used.

Specification Limits

When trying to delete item by specifying [Folder path] which is owner by other users with [Delete folder] checked, the folder will not be deleted with the status attribute set to "Error" in corresponding file element.

When trying to delete item by specifying [File/Folder name] which is owner by other users, the file/folder will not be deleted with the status attribute set to "Error" in corresponding file element .

On Google Drive, you can use drives, files, or folders that have the same name, but this functionality is not supported on this adapter.

Files/Folders not located under My Drive or Shared Drive cannot be viewed.

Main exceptions

Exception name	Causes	Solution
ResourceNotFoundException Resource definition could not be found.Name: []	[Destination] is not specified.	Please specify [Destination].
ResourceNotFoundException Resource definition could not be found.Name: [<name of Global Resources>]	Resource definition selected in [Destination] is not found.	Please check the global resource specified in [Destination].
InvalidPropertyConfigurationException <Property name> is not specified.	[<Property name>] is not specified.	Specify the [<Property name>].
java.lang.UnsupportedOperationException root folder cannot be deleted.	Attempted to delete the root folder.	If the [Delete folder] is [Checked], the [Folder path] can not accept the path to the root folder.

Notes

HTTPS is used in the communication between Google Drive and this adapter.

If an error unrelated to the connection (error which is not described in "main exception") occurs during execution, set "Error" to status attribute of file element of the file / folder in which error occurs, then output as result data and continue the further process.

Move the deleted files / folders to "Trash" .

If the free space on Google Drive is running out, deleting the file/folder may not perform successfully.
In that case, please increase free space of Google Drive.