Class FolderRenameParams
-
- All Implemented Interfaces:
-
io.imagekit.core.Params
public final class FolderRenameParams implements Params
This API allows you to rename an existing folder. The folder and all its nested assets and sub-folders will remain unchanged, but their paths will be updated to reflect the new folder name.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classFolderRenameParams.BuilderA builder for FolderRenameParams.
public final classFolderRenameParams.Body
-
Method Summary
Modifier and Type Method Description final StringfolderPath()The full path to the folder you want to rename. final StringnewFolderName()The new name for the folder. final Optional<Boolean>purgeCache()Option to purge cache for the old nested files and their versions' URLs. final JsonField<String>_folderPath()Returns the raw JSON value of folderPath. final JsonField<String>_newFolderName()Returns the raw JSON value of newFolderName. final JsonField<Boolean>_purgeCache()Returns the raw JSON value of purgeCache. final Map<String, JsonValue>_additionalBodyProperties()final Headers_additionalHeaders()Additional headers to send with the request. final QueryParams_additionalQueryParams()Additional query param to send with the request. final FolderRenameParams.BuildertoBuilder()final FolderRenameParams.Body_body()Headers_headers()The full set of headers in the parameters, including both fixed and additional headers. QueryParams_queryParams()The full set of query params in the parameters, including both fixed and additional query params. Booleanequals(Object other)IntegerhashCode()StringtoString()final static FolderRenameParams.Builderbuilder()Returns a mutable builder for constructing an instance of FolderRenameParams. -
-
Method Detail
-
folderPath
final String folderPath()
The full path to the folder you want to rename.
-
newFolderName
final String newFolderName()
The new name for the folder.
All characters except alphabets and numbers (inclusive of unicode letters, marks, and numerals in other languages) and
-will be replaced by an underscore i.e._.
-
purgeCache
final Optional<Boolean> purgeCache()
Option to purge cache for the old nested files and their versions' URLs.
When set to true, it will internally issue a purge cache request on CDN to remove the cached content of the old nested files and their versions. There will only be one purge request for all the nested files, which will be counted against your monthly purge quota.
Note: A purge cache request will be issued against
https://ik.imagekit.io/old/folder/path*(with a wildcard at the end). This will remove all nested files, their versions' URLs, and any transformations made using query parameters on these files or their versions. However, the cache for file transformations made using path parameters will persist. You can purge them using the purge API. For more details, refer to the purge API documentation.Default value -
false
-
_folderPath
final JsonField<String> _folderPath()
Returns the raw JSON value of folderPath.
Unlike folderPath, this method doesn't throw if the JSON field has an unexpected type.
-
_newFolderName
final JsonField<String> _newFolderName()
Returns the raw JSON value of newFolderName.
Unlike newFolderName, this method doesn't throw if the JSON field has an unexpected type.
-
_purgeCache
final JsonField<Boolean> _purgeCache()
Returns the raw JSON value of purgeCache.
Unlike purgeCache, this method doesn't throw if the JSON field has an unexpected type.
-
_additionalBodyProperties
final Map<String, JsonValue> _additionalBodyProperties()
-
_additionalHeaders
final Headers _additionalHeaders()
Additional headers to send with the request.
-
_additionalQueryParams
final QueryParams _additionalQueryParams()
Additional query param to send with the request.
-
toBuilder
final FolderRenameParams.Builder toBuilder()
-
_body
final FolderRenameParams.Body _body()
-
_headers
Headers _headers()
The full set of headers in the parameters, including both fixed and additional headers.
-
_queryParams
QueryParams _queryParams()
The full set of query params in the parameters, including both fixed and additional query params.
-
builder
final static FolderRenameParams.Builder builder()
Returns a mutable builder for constructing an instance of FolderRenameParams.
The following fields are required:
.folderPath() .newFolderName()
-
-
-
-