Delete File/Folder

Operation Name

Delete File/Folder

Function Overview

Delete files/folders on Google Cloud Storage.

Data Model

The data model of this component is XML type.

Properties

For details on 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 a new global resource. [Edit list]: Allows you to edit the global resource settings on the "Edit resource list" screen.
Bucket name	Required	Available	Select or enter the bucket.
Folder path	Required	Available	Select or enter the folder path on Google Cloud Storage.	Specify a folder path as an absolute path on Google Cloud Storage. Specify slash (/) at the beginning and the end. Consecutive slashes (//) cannot be included.
File/folder name	Required	Available	Select or enter the file/folder on Google Cloud Storage.	Wild cards (asterisk (*) and question mark (?)) can be used.

Property Action

Item name	Description	Remarks
Update the list of bucket names	Get buckets in the specified destination, and set them in [Bucket name].	If [Destination] is edited, or a bucket has been edited on Google Cloud Storage, you can apply the changes by using this property action. Disabled when [Destination] is not specified.
Update the list of folder paths	Get folder paths in the specified bucket, and set them in [Folder path].	If [Bucket name] is edited, or a folder path has been edited on Google Cloud Storage, you can apply the changes by using this property action. Disabled when [Destination] or [Bucket name] is not specified.
Update the list of file/folder names	Obtain file/folder name in the specified folder path, and set it to [File/folder name].	If [Folder path] is edited, or file/folder name has been edited on Google Cloud Storage, you can apply the changes by using this property action. Disabled when [Destination], [Bucket name], or [Folder path] is not specified.

Data Processing Method

Item name	Required/Optional	Use of variables	Description	Remarks
Data processing method	Required	Not Available	Select the data processing method. [Apply script settings]: (default) Apply mass data processing settings of script property to adapter. [Do not perform mass data processing]: Mass data processing is not performed. [Perform mass data processing]: Mass data processing is performed.

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 applied in the specifications.

Schema

Input Schema

None

Output Schema

<?xml version="1.0"?>
<bucket name="" status="" >
  <file errorcode="" name="" remotepath="" status="" statuscode="" type="" />
</bucket>

Element name	Attribute name	Description	Remarks
bucket	-	Appears in each bucket which is gotten.
	name	Outputs name of the bucket acquired.
	status	Outputs the status of the gotten bucket. Exist: Status that bucket exists. ErrorBucketNotFound: The specified [Bucket name] does not exist on Google Cloud Storage. The specified bucket name may be incorrect. Error: Status that bucket could not be obtained due to the occurred error.
file	-	Appears in each deleted file/folder.
	errorcode	When an error occurs on Google Cloud Storage, output the API error code specified on Google Cloud Storage.	If no error has occurred on Google Cloud Storage, the value is a blank. For more details about API error code defined on Google Cloud Storage, refer to the following Web site: https://cloud.google.com/storage/docs/json_api/v1/status-codes
	name	Output the name of the deleted file/folder as it appears on Google Cloud Storage.	When status is "RemoteFileNotFound", the value is a blank.
	remotepath	Output the file path of the deleted file/folder as it appears on Google Cloud Storage.
	status	Outputs the status of the deleted file/folder. Deleted: The file/folder was deleted. RemoteFileNotFound: The status that the specified file/folder does not exist in the specified folder path in [Folder path]. Error: The status that the file/folder was not be deleted because an error occurred.
	statuscode	When an error occurs on Google Cloud Storage, output the API status code specified on Google Cloud Storage.	If no error has occurred on Google Cloud Storage, the value is a blank. For more details about the API status codes defined on Google Cloud Storage, refer to the following Web site: https://cloud.google.com/storage/docs/json_api/v1/status-codes
	type	Output the type of deleted files/folders. File: File Folder: Folder

Loading Schema in Mapper

Schema is loaded automatically.

For details, refer to "Edit Schema".

Mass Data Processing

Mass data processing is supported.

PSP Usage

PSP cannot be used.

Available Component Variables

Component variable name	Description	Remarks
count	Stores the number of target files/folders.	The default value is null.
message_category	When an error occurs, the category of the message code corresponding to the error that occurred is stored.	The default value is null.
message_code	When an error occurs, the code of the message code corresponding to the error that occurred is stored.	The default value is null.
message_level	When an error occurs, the severity of the message code corresponding to the error that occurred is stored.	The default value is null.
error_type	When an error occurs, the type of an occurred error is stored.	The default value is null. Error type is in the following format: Example: "java.io.FileNotFoundException" The contents to be stored may vary depending on the version of DataSpider Servista.
error_message	When an error occurs, the message of the error that occurred is stored.	The default value is null. The contents to be stored may vary depending on the version of DataSpider Servista.
error_trace	When an error occurs, the trace information of the error that occurred is stored.	The default value is null. The contents to be stored may vary depending on the version and client applications of DataSpider Servista.

Specification Limits

For more details on specification limits common to each operation, refer to "Google Cloud Storage Adapter Limitations".

Major Exceptions

Exception Name	Cause	Solution
ResourceNotFoundException Resource definition is not found. Name:[]	[Destination] is not specified.	Specify [Destination].
ResourceNotFoundException Resource definition is not found. Name:[<Name of global resources>]	Resource definition selected in [Destination] is not found.	Check the global resource specified in [Destination].
InvalidPropertyConfigurationException An incorrect folder path is specified.	The format of the [Folder path] is invalid.	Specify slash (/) at the beginning and the end, and specify a folder path that does not contain two slashes (//).
InvalidPropertyConfigurationException An incorrect file/folder name is specified.	The format of [File/folder name] is invalid.	Specify a slash (/) at the end for a folder, and do not include a slash (/) for a file.
InvalidCredentialException A service account authentication key is incorrect.	[Service account authentication key] in [Destination] is incorrect.	Confirm [Service account authentication key] in [Destination].
CloudStorageServiceException Failed in the operation for Google Cloud Storage.	Failed in the operation for Google Cloud Storage.	Identify the cause of the error from the status code and error code by referring to the error message list page of Google Cloud Storage (https://cloud.google.com/storage/docs/xml-api/reference-status#standardcodes), and then resolve the problem.

Notes

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

At the time of execution, when errors other than connection-related (errors not described in "Main Exceptions") occur, "Error" is set to the status attribute of file element of error occurred file/folder, output it as the result data and continue with the subsequent operation.