Check Object Availability

Using the headObject() SDK method, you can check the existence of an object in a bucket, and further check if the user has the relevant permissions to access the objects present in the bucket. The Bucket reference used in the below code snippet is the component instance.

Possible responses when using this SDK:

• If the bucket exists and if the user has the relevant permissions to access the objects in it, the response ‘true’ will be returned.

• If the bucket does not exist, or if the user does not have permission to access the objects in it, the response ‘false’ will be returned.

Parameters Used

Check Object Availability Without VersionID

The following SDK method will provide you with the topVersion (latest version) of the object in the bucket.

    

        
copy
        

            

        
    
    

         // Check if an object is available
const checkObjectAvailability = await bucket.headObject("key")
    

Check Object Availability With VersionID

The following SDK method will check the availability of a specific version of the object. the required version will be reffered by its unique versionId.

    

        
copy
        

            

        
    
    

         // Check if certain version of an object is Available

const options = {
	versionId: 'djkfhdiufy762',
	throwErr: false
};
const checkObjectAvailability = await bucket.headObject("key", options)
    

Example Response

    

        
copy
        

            

        
    
    

         {
 	"status": 200,
 	"content": true | false,
 	"message": "OK"
}