All Implemented Interfaces:


public final class FileUploadParams.Body

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public final class`	`FileUploadParams.Body.Builder`	A builder for Body.

Field Summary

Fields
Modifier and Type	Field	Description

Constructor Summary

Constructors
Constructor	Description

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final InputStream`	`file()`	The API accepts any of the following: Binary data – send the raw bytes as `multipart/form-data`. HTTP / HTTPS URL – a publicly reachable URL that ImageKit’s servers can fetch. Base64 string – the file encoded as a Base64 data URI or plain Base64. When supplying a URL, the server must receive the response headers within 8 seconds; otherwise the request fails with 400 Bad Request.
`final String`	`fileName()`	The name with which the file has to be uploaded.
`final Optional<String>`	`token()`	This is the client-generated JSON Web Token (JWT).
`final Optional<String>`	`checks()`	Server-side checks to run on the asset.
`final Optional<String>`	`customCoordinates()`	Define an important area in the image.
`final Optional<FileUploadParams.CustomMetadata>`	`customMetadata()`	JSON key-value pairs to associate with the asset.
`final Optional<String>`	`description()`	Optional text to describe the contents of the file.
`final Optional<List<ExtensionItem>>`	`extensions()`	Array of extensions to be applied to the asset.
`final Optional<String>`	`folder()`	The folder path in which the image has to be uploaded.
`final Optional<Boolean>`	`isPrivateFile()`	Whether to mark the file as private or not.
`final Optional<Boolean>`	`isPublished()`	Whether to upload file as published or not.
`final Optional<Boolean>`	`overwriteAiTags()`	If set to `true` and a file already exists at the exact location, its AITags will be removed.
`final Optional<Boolean>`	`overwriteCustomMetadata()`	If the request does not have `customMetadata`, and a file already exists at the exact location, existing customMetadata will be removed.
`final Optional<Boolean>`	`overwriteFile()`	If `false` and `useUniqueFileName` is also `false`, and a file already exists at the exact location, upload API will return an error immediately.
`final Optional<Boolean>`	`overwriteTags()`	If the request does not have `tags`, and a file already exists at the exact location, existing tags will be removed.
`final Optional<List<FileUploadParams.ResponseField>>`	`responseFields()`	Array of response field keys to include in the API response body.
`final Optional<List<String>>`	`tags()`	Set the tags while uploading the file.
`final Optional<FileUploadParams.UploadTransformation>`	`transformation()`	Configure pre-processing (`pre`) and post-processing (`post`) transformations.
`final Optional<Boolean>`	`useUniqueFileName()`	Whether to use a unique filename for this file or not.
`final Optional<String>`	`webhookUrl()`	The final status of extensions after they have completed execution will be delivered to this endpoint as a POST request.
`final MultipartField<InputStream>`	`_file()`	Returns the raw multipart value of file.
`final MultipartField<String>`	`_fileName()`	Returns the raw multipart value of fileName.
`final MultipartField<String>`	`_token()`	Returns the raw multipart value of token.
`final MultipartField<String>`	`_checks()`	Returns the raw multipart value of checks.
`final MultipartField<String>`	`_customCoordinates()`	Returns the raw multipart value of customCoordinates.
`final MultipartField<FileUploadParams.CustomMetadata>`	`_customMetadata()`	Returns the raw multipart value of customMetadata.
`final MultipartField<String>`	`_description()`	Returns the raw multipart value of description.
`final MultipartField<List<ExtensionItem>>`	`_extensions()`	Returns the raw multipart value of extensions.
`final MultipartField<String>`	`_folder()`	Returns the raw multipart value of folder.
`final MultipartField<Boolean>`	`_isPrivateFile()`	Returns the raw multipart value of isPrivateFile.
`final MultipartField<Boolean>`	`_isPublished()`	Returns the raw multipart value of isPublished.
`final MultipartField<Boolean>`	`_overwriteAiTags()`	Returns the raw multipart value of overwriteAiTags.
`final MultipartField<Boolean>`	`_overwriteCustomMetadata()`	Returns the raw multipart value of overwriteCustomMetadata.
`final MultipartField<Boolean>`	`_overwriteFile()`	Returns the raw multipart value of overwriteFile.
`final MultipartField<Boolean>`	`_overwriteTags()`	Returns the raw multipart value of overwriteTags.
`final MultipartField<List<FileUploadParams.ResponseField>>`	`_responseFields()`	Returns the raw multipart value of responseFields.
`final MultipartField<List<String>>`	`_tags()`	Returns the raw multipart value of tags.
`final MultipartField<FileUploadParams.UploadTransformation>`	`_transformation()`	Returns the raw multipart value of transformation.
`final MultipartField<Boolean>`	`_useUniqueFileName()`	Returns the raw multipart value of useUniqueFileName.
`final MultipartField<String>`	`_webhookUrl()`	Returns the raw multipart value of webhookUrl.
`final Map<String, JsonValue>`	`_additionalProperties()`
`final FileUploadParams.Body.Builder`	`toBuilder()`
`final FileUploadParams.Body`	`validate()`	Validates that the types of all values in this object match their expected types recursively.
`final Boolean`	`isValid()`
`Boolean`	`equals(Object other)`
`Integer`	`hashCode()`
`String`	`toString()`
`final static FileUploadParams.Body.Builder`	`builder()`	Returns a mutable builder for constructing an instance of Body.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
- Method Detail
  - file
```
 final InputStream file()
```
    The API accepts any of the following:
    Binary data – send the raw bytes as multipart/form-data.
    HTTP / HTTPS URL – a publicly reachable URL that ImageKit’s servers can fetch.
    Base64 string – the file encoded as a Base64 data URI or plain Base64.
    When supplying a URL, the server must receive the response headers within 8 seconds; otherwise the request fails with 400 Bad Request.
  - fileName
```
 final String fileName()
```
    The name with which the file has to be uploaded.
  - token
```
 final Optional<String> token()
```
    This is the client-generated JSON Web Token (JWT). The ImageKit.io server uses it to authenticate and check that the upload request parameters have not been tampered with after the token has been generated. Learn how to create the token on the page below. This field is only required for authentication when uploading a file from the client side.
    Note: Sending a JWT that has been used in the past will result in a validation error. Even if your previous request resulted in an error, you should always send a new token.
    ⚠️Warning: JWT must be generated on the server-side because it is generated using your account's private API key. This field is required for authentication when uploading a file from the client-side.
  - checks
```
 final Optional<String> checks()
```
    Server-side checks to run on the asset. Read more about /docs/api-reference/upload-file/upload-file-v2#upload-api-checks.
  - customCoordinates
```
 final Optional<String> customCoordinates()
```
    Define an important area in the image. This is only relevant for image type files.
    To be passed as a string with the x and y coordinates of the top-left corner, and width and height of the area of interest in the format x,y,width,height. For example - 10,10,100,100
    Can be used with fo-customtransformation.
    If this field is not specified and the file is overwritten, then customCoordinates will be removed.
  - customMetadata
```
 final Optional<FileUploadParams.CustomMetadata> customMetadata()
```
    JSON key-value pairs to associate with the asset. Create the custom metadata fields before setting these values.
  - description
```
 final Optional<String> description()
```
    Optional text to describe the contents of the file.
  - extensions
```
 final Optional<List<ExtensionItem>> extensions()
```
    Array of extensions to be applied to the asset. Each extension can be configured with specific parameters based on the extension type.
  - folder
```
 final Optional<String> folder()
```
    The folder path in which the image has to be uploaded. If the folder(s) didn't exist before, a new folder(s) is created. Using multiple / creates a nested folder.
  - isPrivateFile
```
 final Optional<Boolean> isPrivateFile()
```
    Whether to mark the file as private or not.
    If true, the file is marked as private and is accessible only using named transformation or signed URL.
  - isPublished
```
 final Optional<Boolean> isPublished()
```
    Whether to upload file as published or not.
    If false, the file is marked as unpublished, which restricts access to the file only via the media library. Files in draft or unpublished state can only be publicly accessed after being published.
    The option to upload in draft state is only available in custom enterprise pricing plans.
  - overwriteAiTags
```
 final Optional<Boolean> overwriteAiTags()
```
    If set to true and a file already exists at the exact location, its AITags will be removed. Set overwriteAITags to false to preserve AITags.
  - overwriteCustomMetadata
```
 final Optional<Boolean> overwriteCustomMetadata()
```
    If the request does not have customMetadata, and a file already exists at the exact location, existing customMetadata will be removed.
  - overwriteFile
```
 final Optional<Boolean> overwriteFile()
```
    If false and useUniqueFileName is also false, and a file already exists at the exact location, upload API will return an error immediately.
  - overwriteTags
```
 final Optional<Boolean> overwriteTags()
```
    If the request does not have tags, and a file already exists at the exact location, existing tags will be removed.
  - responseFields
```
 final Optional<List<FileUploadParams.ResponseField>> responseFields()
```
    Array of response field keys to include in the API response body.
  - tags
```
 final Optional<List<String>> tags()
```
    Set the tags while uploading the file. Provide an array of tag strings (e.g. ["tag1", "tag2", "tag3"]). The combined length of all tag characters must not exceed 500, and the % character is not allowed. If this field is not specified and the file is overwritten, the existing tags will be removed.
  - transformation
```
 final Optional<FileUploadParams.UploadTransformation> transformation()
```
    Configure pre-processing (pre) and post-processing (post) transformations.
    pre — applied before the file is uploaded to the Media Library. Useful for reducing file size or applying basic optimizations upfront (e.g., resize, compress).
    post — applied immediately after upload. Ideal for generating transformed versions (like video encodes or thumbnails) in advance, so they're ready for delivery without delay.
    You can mix and match any combination of post-processing types.
  - useUniqueFileName
```
 final Optional<Boolean> useUniqueFileName()
```
    Whether to use a unique filename for this file or not.
    If true, ImageKit.io will add a unique suffix to the filename parameter to get a unique filename.
    If false, then the image is uploaded with the provided filename parameter, and any existing file with the same name is replaced.
  - webhookUrl
```
 final Optional<String> webhookUrl()
```
    The final status of extensions after they have completed execution will be delivered to this endpoint as a POST request. /docs/api-reference/digital-asset-management-dam/managing-assets/update-file-details#webhook-payload-structure about the webhook payload structure.
  - _file
```
 final MultipartField<InputStream> _file()
```
    Returns the raw multipart value of file.
    Unlike file, this method doesn't throw if the multipart field has an unexpected type.
  - _fileName
```
 final MultipartField<String> _fileName()
```
    Returns the raw multipart value of fileName.
    Unlike fileName, this method doesn't throw if the multipart field has an unexpected type.
  - _token
```
 final MultipartField<String> _token()
```
    Returns the raw multipart value of token.
    Unlike token, this method doesn't throw if the multipart field has an unexpected type.
  - _checks
```
 final MultipartField<String> _checks()
```
    Returns the raw multipart value of checks.
    Unlike checks, this method doesn't throw if the multipart field has an unexpected type.
  - _customCoordinates
```
 final MultipartField<String> _customCoordinates()
```
    Returns the raw multipart value of customCoordinates.
    Unlike customCoordinates, this method doesn't throw if the multipart field has an unexpected type.
  - _customMetadata
```
 final MultipartField<FileUploadParams.CustomMetadata> _customMetadata()
```
    Returns the raw multipart value of customMetadata.
    Unlike customMetadata, this method doesn't throw if the multipart field has an unexpected type.
  - _description
```
 final MultipartField<String> _description()
```
    Returns the raw multipart value of description.
    Unlike description, this method doesn't throw if the multipart field has an unexpected type.
  - _extensions
```
 final MultipartField<List<ExtensionItem>> _extensions()
```
    Returns the raw multipart value of extensions.
    Unlike extensions, this method doesn't throw if the multipart field has an unexpected type.
  - _folder
```
 final MultipartField<String> _folder()
```
    Returns the raw multipart value of folder.
    Unlike folder, this method doesn't throw if the multipart field has an unexpected type.
  - _isPrivateFile
```
 final MultipartField<Boolean> _isPrivateFile()
```
    Returns the raw multipart value of isPrivateFile.
    Unlike isPrivateFile, this method doesn't throw if the multipart field has an unexpected type.
  - _isPublished
```
 final MultipartField<Boolean> _isPublished()
```
    Returns the raw multipart value of isPublished.
    Unlike isPublished, this method doesn't throw if the multipart field has an unexpected type.
  - _overwriteAiTags
```
 final MultipartField<Boolean> _overwriteAiTags()
```
    Returns the raw multipart value of overwriteAiTags.
    Unlike overwriteAiTags, this method doesn't throw if the multipart field has an unexpected type.
  - _overwriteCustomMetadata
```
 final MultipartField<Boolean> _overwriteCustomMetadata()
```
    Returns the raw multipart value of overwriteCustomMetadata.
    Unlike overwriteCustomMetadata, this method doesn't throw if the multipart field has an unexpected type.
  - _overwriteFile
```
 final MultipartField<Boolean> _overwriteFile()
```
    Returns the raw multipart value of overwriteFile.
    Unlike overwriteFile, this method doesn't throw if the multipart field has an unexpected type.
  - _overwriteTags
```
 final MultipartField<Boolean> _overwriteTags()
```
    Returns the raw multipart value of overwriteTags.
    Unlike overwriteTags, this method doesn't throw if the multipart field has an unexpected type.
  - _responseFields
```
 final MultipartField<List<FileUploadParams.ResponseField>> _responseFields()
```
    Returns the raw multipart value of responseFields.
    Unlike responseFields, this method doesn't throw if the multipart field has an unexpected type.
  - _tags
```
 final MultipartField<List<String>> _tags()
```
    Returns the raw multipart value of tags.
    Unlike tags, this method doesn't throw if the multipart field has an unexpected type.
  - _transformation
```
 final MultipartField<FileUploadParams.UploadTransformation> _transformation()
```
    Returns the raw multipart value of transformation.
    Unlike transformation, this method doesn't throw if the multipart field has an unexpected type.
  - _useUniqueFileName
```
 final MultipartField<Boolean> _useUniqueFileName()
```
    Returns the raw multipart value of useUniqueFileName.
    Unlike useUniqueFileName, this method doesn't throw if the multipart field has an unexpected type.
  - _webhookUrl
```
 final MultipartField<String> _webhookUrl()
```
    Returns the raw multipart value of webhookUrl.
    Unlike webhookUrl, this method doesn't throw if the multipart field has an unexpected type.
  - _additionalProperties
```
 final Map<String, JsonValue> _additionalProperties()
```
  - toBuilder
```
 final FileUploadParams.Body.Builder toBuilder()
```
  - validate
```
 final FileUploadParams.Body validate()
```
    Validates that the types of all values in this object match their expected types recursively.
    This method is not forwards compatible with new types from the API for existing fields.
  - isValid
```
 final Boolean isValid()
```
  - equals
```
 Boolean equals(Object other)
```
  - hashCode
```
 Integer hashCode()
```
  - toString
```
 String toString()
```
  - builder
```
 final static FileUploadParams.Body.Builder builder()
```
    Returns a mutable builder for constructing an instance of Body.
    The following fields are required:
    .file() .fileName()

Class FileUploadParams.Body

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Method Detail

file

fileName

token

checks

customCoordinates

customMetadata

description

extensions

folder

isPrivateFile

isPublished

overwriteAiTags

overwriteCustomMetadata

overwriteFile

overwriteTags

responseFields

tags

transformation

useUniqueFileName

webhookUrl

_file

_fileName

_token

_checks

_customCoordinates

_customMetadata

_description

_extensions

_folder

_isPrivateFile

_isPublished

_overwriteAiTags

_overwriteCustomMetadata

_overwriteFile

_overwriteTags

_responseFields

_tags

_transformation

_useUniqueFileName

_webhookUrl

_additionalProperties

toBuilder

validate

isValid

equals

hashCode

toString

builder