Constructor Detail

Method Detail

• body

   final FileRenameParams.Builder body(FileRenameParams.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:

  • filePath

  • newFileName

  • purgeCache

• filePath

   final FileRenameParams.Builder filePath(String filePath)

  The full path of the file you want to rename.

• filePath

   final FileRenameParams.Builder filePath(JsonField<String> filePath)

  Sets Builder.filePath to an arbitrary JSON value.

  You should usually call Builder.filePath with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• newFileName

   final FileRenameParams.Builder newFileName(String newFileName)

  The new name of the file. A filename can contain:

  Alphanumeric Characters: a-z, A-Z, 0-9 (including Unicode letters, marks, and numerals in other languages). Special Characters: ., _, and -.

  Any other character, including space, will be replaced by _.

• newFileName

   final FileRenameParams.Builder newFileName(JsonField<String> newFileName)

  Sets Builder.newFileName to an arbitrary JSON value.

  You should usually call Builder.newFileName 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 FileRenameParams.Builder purgeCache(Boolean purgeCache)

  Option to purge cache for the old file and its versions' URLs.

  When set to true, it will internally issue a purge cache request on CDN to remove cached content of old file and its versions. This purge request is counted against your monthly purge quota.

  Note: If the old file were accessible at https://ik.imagekit.io/demo/old-filename.jpg, a purge cache request would be issued against https://ik.imagekit.io/demo/old-filename.jpg* (with a wildcard at the end). It will remove the file and its versions' URLs and any transformations made using query parameters on this file or its 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 FileRenameParams.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 FileRenameParams.Builder additionalBodyProperties(Map<String, JsonValue> additionalBodyProperties)

• putAdditionalBodyProperty

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

• putAllAdditionalBodyProperties

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

• removeAdditionalBodyProperty

   final FileRenameParams.Builder removeAdditionalBodyProperty(String key)

• removeAllAdditionalBodyProperties

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

• additionalHeaders

   final FileRenameParams.Builder additionalHeaders(Headers additionalHeaders)

• additionalHeaders

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

• putAdditionalHeader

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

• putAdditionalHeaders

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

• putAllAdditionalHeaders

   final FileRenameParams.Builder putAllAdditionalHeaders(Headers additionalHeaders)

• putAllAdditionalHeaders

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

• replaceAdditionalHeaders

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

• replaceAdditionalHeaders

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

• replaceAllAdditionalHeaders

   final FileRenameParams.Builder replaceAllAdditionalHeaders(Headers additionalHeaders)

• replaceAllAdditionalHeaders

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

• removeAdditionalHeaders

   final FileRenameParams.Builder removeAdditionalHeaders(String name)

• removeAllAdditionalHeaders

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

• additionalQueryParams

   final FileRenameParams.Builder additionalQueryParams(QueryParams additionalQueryParams)

• additionalQueryParams

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

• putAdditionalQueryParam

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

• putAdditionalQueryParams

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

• putAllAdditionalQueryParams

   final FileRenameParams.Builder putAllAdditionalQueryParams(QueryParams additionalQueryParams)

• putAllAdditionalQueryParams

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

• replaceAdditionalQueryParams

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

• replaceAdditionalQueryParams

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

• replaceAllAdditionalQueryParams

   final FileRenameParams.Builder replaceAllAdditionalQueryParams(QueryParams additionalQueryParams)

• replaceAllAdditionalQueryParams

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

• removeAdditionalQueryParams

   final FileRenameParams.Builder removeAdditionalQueryParams(String key)

• removeAllAdditionalQueryParams

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

• build

   final FileRenameParams build()

  Returns an immutable instance of FileRenameParams.

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

  The following fields are required:

  .filePath()
  .newFileName()