PathDeleteIfExistsResponse interface

  • Reference
Package:
@azure/storage-file-datalake

Contains response data for the deleteIfExists operation.

Extends
PathDeleteResponse

Properties

succeeded

Indicate whether the directory/file is successfully deleted. Is false if the directory/file doesn't exist in the first place.

Inherited Properties

continuation

When deleting a directory, the number of paths that are deleted with each invocation is limited. If the number of paths to be deleted exceeds this limit, a continuation token is returned in this response header. When a continuation token is returned in the response, it must be specified in a subsequent invocation of the delete operation to continue deleting the directory.
date

A UTC date/time value generated by the service that indicates the time at which the response was initiated.
deletionId

Returned only for hierarchical namespace space enabled accounts when soft delete is enabled. A unique identifier for the entity that can be used to restore it. See the Undelete REST API for more information.
errorCode

Error Code
requestId

A server-generated UUID recorded in the analytics logs for troubleshooting and correlation.
version

The version of the REST protocol used to process the request.

Property Details

succeeded

Indicate whether the directory/file is successfully deleted. Is false if the directory/file doesn't exist in the first place.

succeeded: boolean

Property Value

boolean

Inherited Property Details

continuation

When deleting a directory, the number of paths that are deleted with each invocation is limited. If the number of paths to be deleted exceeds this limit, a continuation token is returned in this response header. When a continuation token is returned in the response, it must be specified in a subsequent invocation of the delete operation to continue deleting the directory.

continuation?: string

Property Value

string

Inherited From PathDeleteResponse.continuation

date

A UTC date/time value generated by the service that indicates the time at which the response was initiated.

date?: Date

Property Value

Date

Inherited From PathDeleteResponse.date

deletionId

Returned only for hierarchical namespace space enabled accounts when soft delete is enabled. A unique identifier for the entity that can be used to restore it. See the Undelete REST API for more information.

deletionId?: string

Property Value

string

Inherited From PathDeleteResponse.deletionId

errorCode

Error Code

errorCode?: string

Property Value

string

Inherited From PathDeleteResponse.errorCode

requestId

A server-generated UUID recorded in the analytics logs for troubleshooting and correlation.

requestId?: string

Property Value

string

Inherited From PathDeleteResponse.requestId

version

The version of the REST protocol used to process the request.

version?: string

Property Value

string

Inherited From PathDeleteResponse.version