Class FolderCopyParams
-
- All Implemented Interfaces:
-
io.imagekit.core.Params
public final class FolderCopyParams implements Params
This will copy one folder into another. The selected folder, its nested folders, files, and their versions (in
includeVersionsis set to true) are copied in this operation. Note: If any file at the destination has the same name as the source file, then the source file and its versions will be appended to the destination file version history.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classFolderCopyParams.BuilderA builder for FolderCopyParams.
public final classFolderCopyParams.Body
-
Method Summary
Modifier and Type Method Description final StringdestinationPath()Full path to the destination folder where you want to copy the source folder into. final StringsourceFolderPath()The full path to the source folder you want to copy. final Optional<Boolean>includeVersions()Option to copy all versions of files that are nested inside the selected folder. final JsonField<String>_destinationPath()Returns the raw JSON value of destinationPath. final JsonField<String>_sourceFolderPath()Returns the raw JSON value of sourceFolderPath. final JsonField<Boolean>_includeVersions()Returns the raw JSON value of includeVersions. final Map<String, JsonValue>_additionalBodyProperties()final Headers_additionalHeaders()Additional headers to send with the request. final QueryParams_additionalQueryParams()Additional query param to send with the request. final FolderCopyParams.BuildertoBuilder()final FolderCopyParams.Body_body()Headers_headers()The full set of headers in the parameters, including both fixed and additional headers. QueryParams_queryParams()The full set of query params in the parameters, including both fixed and additional query params. Booleanequals(Object other)IntegerhashCode()StringtoString()final static FolderCopyParams.Builderbuilder()Returns a mutable builder for constructing an instance of FolderCopyParams. -
-
Method Detail
-
destinationPath
final String destinationPath()
Full path to the destination folder where you want to copy the source folder into.
-
sourceFolderPath
final String sourceFolderPath()
The full path to the source folder you want to copy.
-
includeVersions
final Optional<Boolean> includeVersions()
Option to copy all versions of files that are nested inside the selected folder. By default, only the current version of each file will be copied. When set to true, all versions of each file will be copied. Default value -
false.
-
_destinationPath
final JsonField<String> _destinationPath()
Returns the raw JSON value of destinationPath.
Unlike destinationPath, this method doesn't throw if the JSON field has an unexpected type.
-
_sourceFolderPath
final JsonField<String> _sourceFolderPath()
Returns the raw JSON value of sourceFolderPath.
Unlike sourceFolderPath, this method doesn't throw if the JSON field has an unexpected type.
-
_includeVersions
final JsonField<Boolean> _includeVersions()
Returns the raw JSON value of includeVersions.
Unlike includeVersions, this method doesn't throw if the JSON field has an unexpected type.
-
_additionalBodyProperties
final Map<String, JsonValue> _additionalBodyProperties()
-
_additionalHeaders
final Headers _additionalHeaders()
Additional headers to send with the request.
-
_additionalQueryParams
final QueryParams _additionalQueryParams()
Additional query param to send with the request.
-
toBuilder
final FolderCopyParams.Builder toBuilder()
-
_body
final FolderCopyParams.Body _body()
-
_headers
Headers _headers()
The full set of headers in the parameters, including both fixed and additional headers.
-
_queryParams
QueryParams _queryParams()
The full set of query params in the parameters, including both fixed and additional query params.
-
builder
final static FolderCopyParams.Builder builder()
Returns a mutable builder for constructing an instance of FolderCopyParams.
The following fields are required:
.destinationPath() .sourceFolderPath()
-
-
-
-