Constructor Detail

Method Detail

• filePath

   final FileRenameParams.Body.Builder filePath(String filePath)

  The full path of the file you want to rename.

• filePath

   final FileRenameParams.Body.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.Body.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.Body.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.Body.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.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 FileRenameParams.Body.Builder additionalProperties(Map<String, JsonValue> additionalProperties)

• putAdditionalProperty

   final FileRenameParams.Body.Builder putAdditionalProperty(String key, JsonValue value)

• putAllAdditionalProperties

   final FileRenameParams.Body.Builder putAllAdditionalProperties(Map<String, JsonValue> additionalProperties)

• removeAdditionalProperty

   final FileRenameParams.Body.Builder removeAdditionalProperty(String key)

• removeAllAdditionalProperties

   final FileRenameParams.Body.Builder removeAllAdditionalProperties(Set<String> keys)

• build

   final FileRenameParams.Body build()

  Returns an immutable instance of Body.

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

  The following fields are required:

  .filePath()
  .newFileName()