Class FolderRenameParams.Body.Builder
-
- All Implemented Interfaces:
public final class FolderRenameParams.Body.BuilderA builder for Body.
-
-
Method Summary
-
-
Method Detail
-
folderPath
final FolderRenameParams.Body.Builder folderPath(String folderPath)
The full path to the folder you want to rename.
-
folderPath
final FolderRenameParams.Body.Builder folderPath(JsonField<String> folderPath)
Sets Builder.folderPath to an arbitrary JSON value.
You should usually call Builder.folderPath with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
-
newFolderName
final FolderRenameParams.Body.Builder newFolderName(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._.
-
newFolderName
final FolderRenameParams.Body.Builder newFolderName(JsonField<String> newFolderName)
Sets Builder.newFolderName to an arbitrary JSON value.
You should usually call Builder.newFolderName with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
-
purgeCache
final FolderRenameParams.Body.Builder purgeCache(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
-
purgeCache
final FolderRenameParams.Body.Builder purgeCache(JsonField<Boolean> purgeCache)
Sets Builder.purgeCache to an arbitrary JSON value.
You should usually call Builder.purgeCache with a well-typed Boolean value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
-
additionalProperties
final FolderRenameParams.Body.Builder additionalProperties(Map<String, JsonValue> additionalProperties)
-
putAdditionalProperty
final FolderRenameParams.Body.Builder putAdditionalProperty(String key, JsonValue value)
-
putAllAdditionalProperties
final FolderRenameParams.Body.Builder putAllAdditionalProperties(Map<String, JsonValue> additionalProperties)
-
removeAdditionalProperty
final FolderRenameParams.Body.Builder removeAdditionalProperty(String key)
-
removeAllAdditionalProperties
final FolderRenameParams.Body.Builder removeAllAdditionalProperties(Set<String> keys)
-
build
final FolderRenameParams.Body build()
Returns an immutable instance of Body.
Further updates to this Builder will not mutate the returned instance.
The following fields are required:
.folderPath() .newFolderName()
-
-
-
-