Constructor Detail

Method Detail

• body

   final FolderRenameParams.Builder body(FolderRenameParams.Body body)

  Sets the entire request body.

  This is generally only useful if you are already constructing the body separately. Otherwise, it's more convenient to use the top-level setters instead:

  • folderPath

  • newFolderName

  • purgeCache

• folderPath

   final FolderRenameParams.Builder folderPath(String folderPath)

  The full path to the folder you want to rename.

• folderPath

   final FolderRenameParams.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.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.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.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.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.

• additionalBodyProperties

   final FolderRenameParams.Builder additionalBodyProperties(Map<String, JsonValue> additionalBodyProperties)

• putAdditionalBodyProperty

   final FolderRenameParams.Builder putAdditionalBodyProperty(String key, JsonValue value)

• putAllAdditionalBodyProperties

   final FolderRenameParams.Builder putAllAdditionalBodyProperties(Map<String, JsonValue> additionalBodyProperties)

• removeAdditionalBodyProperty

   final FolderRenameParams.Builder removeAdditionalBodyProperty(String key)

• removeAllAdditionalBodyProperties

   final FolderRenameParams.Builder removeAllAdditionalBodyProperties(Set<String> keys)

• additionalHeaders

   final FolderRenameParams.Builder additionalHeaders(Headers additionalHeaders)

• additionalHeaders

   final FolderRenameParams.Builder additionalHeaders(Map<String, Iterable<String>> additionalHeaders)

• putAdditionalHeader

   final FolderRenameParams.Builder putAdditionalHeader(String name, String value)

• putAdditionalHeaders

   final FolderRenameParams.Builder putAdditionalHeaders(String name, Iterable<String> values)

• putAllAdditionalHeaders

   final FolderRenameParams.Builder putAllAdditionalHeaders(Headers additionalHeaders)

• putAllAdditionalHeaders

   final FolderRenameParams.Builder putAllAdditionalHeaders(Map<String, Iterable<String>> additionalHeaders)

• replaceAdditionalHeaders

   final FolderRenameParams.Builder replaceAdditionalHeaders(String name, String value)

• replaceAdditionalHeaders

   final FolderRenameParams.Builder replaceAdditionalHeaders(String name, Iterable<String> values)

• replaceAllAdditionalHeaders

   final FolderRenameParams.Builder replaceAllAdditionalHeaders(Headers additionalHeaders)

• replaceAllAdditionalHeaders

   final FolderRenameParams.Builder replaceAllAdditionalHeaders(Map<String, Iterable<String>> additionalHeaders)

• removeAdditionalHeaders

   final FolderRenameParams.Builder removeAdditionalHeaders(String name)

• removeAllAdditionalHeaders

   final FolderRenameParams.Builder removeAllAdditionalHeaders(Set<String> names)

• additionalQueryParams

   final FolderRenameParams.Builder additionalQueryParams(QueryParams additionalQueryParams)

• additionalQueryParams

   final FolderRenameParams.Builder additionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)

• putAdditionalQueryParam

   final FolderRenameParams.Builder putAdditionalQueryParam(String key, String value)

• putAdditionalQueryParams

   final FolderRenameParams.Builder putAdditionalQueryParams(String key, Iterable<String> values)

• putAllAdditionalQueryParams

   final FolderRenameParams.Builder putAllAdditionalQueryParams(QueryParams additionalQueryParams)

• putAllAdditionalQueryParams

   final FolderRenameParams.Builder putAllAdditionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)

• replaceAdditionalQueryParams

   final FolderRenameParams.Builder replaceAdditionalQueryParams(String key, String value)

• replaceAdditionalQueryParams

   final FolderRenameParams.Builder replaceAdditionalQueryParams(String key, Iterable<String> values)

• replaceAllAdditionalQueryParams

   final FolderRenameParams.Builder replaceAllAdditionalQueryParams(QueryParams additionalQueryParams)

• replaceAllAdditionalQueryParams

   final FolderRenameParams.Builder replaceAllAdditionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)

• removeAdditionalQueryParams

   final FolderRenameParams.Builder removeAdditionalQueryParams(String key)

• removeAllAdditionalQueryParams

   final FolderRenameParams.Builder removeAllAdditionalQueryParams(Set<String> keys)

• build

   final FolderRenameParams build()

  Returns an immutable instance of FolderRenameParams.

  Further updates to this Builder will not mutate the returned instance.

  The following fields are required:

  .folderPath()
  .newFolderName()