Rename and Move Operations on an Object
To rename and to move an object, we will be using the same renameObject() SDK method.
Rename an Object
Using the renameObject() SDK method you can rename objects present in a bucket.
Info: To use this SDK method, you need intialize it with Admin scope. You can learn more about this requirement from this section
Note: The following characters including space are not supported when you create a path or an object: double quote, both angular brackets, hashtag, backward slash and pipe symbol.
Parameters Used
| Parameter Name | Data Type | Definition |
|---|---|---|
| key | String | The original name of the object that you need to rename |
| destination | String | The new name that you rename the object with |
Sample Code Snippet
Package Imports
copy
import org.json.simple.JSONObject;copy
JSONObject res = bucket.renameObject("sam/out/sample.txt", "sam/out/update_sample.txt");
System.out.println(res);Note: You cannot rename objects in a bucket that has Versioning enabled.
Move an Object
Using the renameObject() SDK method, we can move the object from one path to another within a bucket.
Info: To use this SDK method, you need intialize it with Admin scope. You can learn more about this requirement from this section
Parameters Used
| Parameter Name | Data Type | Definition |
|---|---|---|
| key | String | The complete name and path of the object that you are required to move. |
| destination | String | The complete name and new path of the object. |
Note:
-
You need to provide the complete object name, along with the path for both key and destination values.
-
For example, if you have file named “kitten.png” in the path pictures/puppy, and you need to move the file to pictures/kitten path, then:
key value will be ‘pictures/puppy/kitten.png’
destination value will be ‘pictures/kitten/kitten.png’
Sample Code Snippet
Package Imports
copy
import org.json.simple.JSONObject;copy
JSONObject res = bucket.renameObject("sam/out/sample.txt", "output/sample.txt");
System.out.println(res);Note: You cannot perform move operations in a bucket that has Versioning enabled.
Last Updated 2025-09-23 19:47:43 +0530 IST
Yes
No
Thank you for your feedback!
Send your feedback to us
Skip
Submit