IPWorks S3 2020 Node.js Edition

Questions / Feedback?

ObjectsDeleted Property

Whether this object version is a delete marker.

Syntax

 s3client.getObjectsDeleted(index, [callback])

Default Value

FALSE

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for the getObjectsDeleted([callback]) method is defined as:

function(err, data){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'data' is the value returned by the method.

The callback for the setObjectsDeleted([callback]) method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

Whether this object version is a delete marker.

This property indicates whether this object version is a delete marker. Delete markers are created when an object in a versioning-enabled bucket is "deleted" (i.e., instead of actually deleting any data); refer to DeleteObject for more information.

Only applicable when ListVersions is called, or when GetObjectInfo is called while VersionId is non-empty; false in all other cases.

The size of the array is controlled by the ObjectsCount property.

This property is read-only and not available at design time.

Data Type

Boolean

 
 
Copyright (c) 2021 /n software inc. - All rights reserved.
IPWorks S3 2020 Node.js Edition - Version 20.0 [Build 7722]