Versions Compared

Old Version 44

changes.mady.by.user Lakshmi Manda

Saved on

compared with

New Version 45

changes.mady.by.user Kalpana Malladi

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

In this article

...

You can use this Snap to delete a file in the SLDB, S3, FTP, SFTP, FTPS, WASB, WASBS, GS, and SMB protocols.

Multiexcerpt include macro
nameMigrating from Binary to Amazon S3
templateData[]
pageFile Reader
addpanelfalse

...

Snap Type

The File Delete Snap is a WRITE-type Snap.

...

Field Name

Field Type

Description


Label*

Default Value: File Delete
Example: File Delete

String

Specify a unique name for the Snap.

File*

Default value: [None] 
Example: 

SLDB:

sldb:///usr/john/json_files/accounts.json

VPC:

  • s3:///snaplogic-bucket@bucket.vpce-0e340d8d5b0eae90a-k9wbom46-us-west-2a.s3.us-west2.vpce.amazonaws.com

String/Expression

Specify the URL for the file to be deleted. It might start with a file protocol. The supported file protocols are SLDB, S3, FTP, SFTP, FTPS, WASB, WASBS, GS, and SMB protocols.

This Snap supports S3 Virtual Private Cloud (VPC) endpoint.

Note

When deleting a directory, ensure to empty its contents first (delete the files within the directory and then the directory folder itself). 

Ensure the file name or the file path does not contain '?' character because it is not fully supported and when present, the Snap might fail.

Multiexcerpt include macro
nameAcceptable File Paths
pageFile Writer

Multiexcerpt include macro
nameLint Warning
pageFile Writer

File delete action

Default value: ERROR if file not found
Example: IGNORE if file not found

Dropdown list

Specify the action that the Snap must take when the target file is not found during a file delete attempt. Select from the following options:

  • ERROR if file not found: The Snap writes an error to the error view.

  • IGNORE if file not found: The Snap writes the status 200 OK to the output view. 

Validate deletion

Default value: Deselected 

Checkbox

Select this check box to enable the Snap to check if the deleted file still exists.


Number of retries


Default value: 0
Example: 3

Integer/Expression

Specify the maximum number of retry attempts in case of a network failure.

Info

If the value is larger than 0, the Snap first downloads the target file into a temporary local file. If any error occurs during the download, the Snap waits for the time specified in the Retry interval and attempts to download the file again from the beginning. When the download is successful, the Snap streams the data from the temporary file to the downstream Pipeline. All temporary local files are deleted when they are no longer needed.

Ensure that the local drive has sufficient free disk space to store the temporary local file.

Minimum value: 0

Retry interval (seconds)

Default value: 1
Example: 3

Integer/Expression

Specify the minimum number of seconds for which the Snap must wait before attempting recovery from a network failure.

Minimum value: 1


Advanced properties

Use this field set to define additional advanced properties. 

  • Properties

    • SAS URI

Dropdown list

Multiexcerpt include macro
nameSASURI_Description_NoAccountSAS
pageDirectory Browser

Note

If the SAS URI value is provided in the Snap settings, then the settings provided in the account (if any account is attached) are ignored.

Values

String/Expression

Specify the value for SAS URI.

Snap Execution


Default Value: Execute only
Example: Validate & Execute

Dropdown list

Multiexcerpt include macro
nameExecution_Detail_Write
pageSOAP Execute

...