public interface StorageApi
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
productUri |
Modifier and Type | Method and Description |
---|---|
retrofit2.Call<java.lang.Void> |
createFolder(java.lang.String path,
java.lang.String storageName)
Create the folder
|
retrofit2.Call<java.lang.Void> |
deleteFile(java.lang.String path,
java.lang.String storageName,
java.lang.String versionId)
Delete file
|
retrofit2.Call<java.lang.Void> |
deleteFolder(java.lang.String path,
java.lang.String storageName,
java.lang.Boolean recursive)
Delete folder
|
retrofit2.Call<okhttp3.ResponseBody> |
downloadFile(java.lang.String path,
java.lang.String storageName,
java.lang.String versionId)
Download file
|
retrofit2.Call<DiscUsage> |
getDiscUsage(java.lang.String storageName)
Get disc usage
|
retrofit2.Call<FilesList> |
getFilesList(java.lang.String path,
java.lang.String storageName)
Get all files and folders within a folder
|
retrofit2.Call<FileVersions> |
getFileVersions(java.lang.String path,
java.lang.String storageName)
Get file versions
|
retrofit2.Call<java.lang.Void> |
moveFile(java.lang.String srcPath,
java.lang.String destPath,
java.lang.String srcStorageName,
java.lang.String destStorageName,
java.lang.String versionId)
Move file
|
retrofit2.Call<java.lang.Void> |
moveFolder(java.lang.String srcPath,
java.lang.String destPath,
java.lang.String srcStorageName,
java.lang.String destStorageName)
Move folder
|
retrofit2.Call<ObjectExist> |
objectExists(java.lang.String path,
java.lang.String storageName,
java.lang.String versionId)
Check if file or folder exists
|
retrofit2.Call<StorageExist> |
storageExists(java.lang.String storageName)
Check if storage exists
|
retrofit2.Call<FilesUploadResult> |
uploadFile(java.lang.String path,
okhttp3.MultipartBody.Part file,
java.lang.String storageName)
Upload file
|
static final java.lang.String productUri
@Headers(value="Content-Type:application/json") @DELETE(value="ocr/storage/file/{path}") retrofit2.Call<java.lang.Void> deleteFile(@Path(value="path") java.lang.String path, @Query(value="storageName") java.lang.String storageName, @Query(value="versionId") java.lang.String versionId)
path
- File path e.g. '/folder/file.ext' (required)storageName
- Storage name (optional)versionId
- File version ID to delete (optional)@Headers(value="Content-Type:application/json") @GET(value="ocr/storage/file/{path}") retrofit2.Call<okhttp3.ResponseBody> downloadFile(@Path(value="path") java.lang.String path, @Query(value="storageName") java.lang.String storageName, @Query(value="versionId") java.lang.String versionId)
path
- File path e.g. '/folder/file.ext' (required)storageName
- Storage name (optional)versionId
- File version ID to download (optional)@Headers(value="Content-Type:application/json") @PUT(value="ocr/storage/file/move/{srcPath}") retrofit2.Call<java.lang.Void> moveFile(@Path(value="srcPath") java.lang.String srcPath, @Query(value="destPath") java.lang.String destPath, @Query(value="srcStorageName") java.lang.String srcStorageName, @Query(value="destStorageName") java.lang.String destStorageName, @Query(value="versionId") java.lang.String versionId)
srcPath
- Source file path e.g. '/src.ext' (required)destPath
- Destination file path e.g. '/dest.ext' (required)srcStorageName
- Source storage name (optional)destStorageName
- Destination storage name (optional)versionId
- File version ID to move (optional)@Multipart @PUT(value="ocr/storage/file/{path}") retrofit2.Call<FilesUploadResult> uploadFile(@Path(value="path") java.lang.String path, @Part okhttp3.MultipartBody.Part file, @Query(value="storageName") java.lang.String storageName)
path
- Path where to upload including filename and extension e.g. /file.ext or /Folder 1/file.ext If the content is multipart and path does not contains the file name it tries to get them from filename parameter from Content-Disposition header. (required)file
- File to upload (required)storageName
- Storage name (optional)@Headers(value="Content-Type:application/json") @DELETE(value="ocr/storage/folder/{path}") retrofit2.Call<java.lang.Void> deleteFolder(@Path(value="path") java.lang.String path, @Query(value="storageName") java.lang.String storageName, @Query(value="recursive") java.lang.Boolean recursive)
path
- Folder path e.g. '/folder' (required)storageName
- Storage name (optional)recursive
- Enable to delete folders, subfolders and files (optional, default to false)@Headers(value="Content-Type:application/json") @GET(value="ocr/storage/folder/{path}") retrofit2.Call<FilesList> getFilesList(@Path(value="path") java.lang.String path, @Query(value="storageName") java.lang.String storageName)
path
- Folder path e.g. '/folder' (required)storageName
- Storage name (optional)@Headers(value="Content-Type:application/json") @PUT(value="ocr/storage/folder/move/{srcPath}") retrofit2.Call<java.lang.Void> moveFolder(@Path(value="srcPath") java.lang.String srcPath, @Query(value="destPath") java.lang.String destPath, @Query(value="srcStorageName") java.lang.String srcStorageName, @Query(value="destStorageName") java.lang.String destStorageName)
srcPath
- Folder path to move e.g. '/folder' (required)destPath
- Destination folder path to move to e.g '/dst' (required)srcStorageName
- Source storage name (optional)destStorageName
- Destination storage name (optional)@Headers(value="Content-Type:application/json") @PUT(value="ocr/storage/folder/{path}") retrofit2.Call<java.lang.Void> createFolder(@Path(value="path") java.lang.String path, @Query(value="storageName") java.lang.String storageName)
path
- Folder path to create e.g. 'folder_1/folder_2/' (required)storageName
- Storage name (optional)@Headers(value="Content-Type:application/json") @GET(value="ocr/storage/disc") retrofit2.Call<DiscUsage> getDiscUsage(@Query(value="storageName") java.lang.String storageName)
storageName
- Storage name (optional)@Headers(value="Content-Type:application/json") @GET(value="ocr/storage/exist/{path}") retrofit2.Call<ObjectExist> objectExists(@Path(value="path") java.lang.String path, @Query(value="storageName") java.lang.String storageName, @Query(value="versionId") java.lang.String versionId)
path
- File or folder path e.g. '/file.ext' or '/folder' (required)storageName
- Storage name (optional)versionId
- File version ID (optional)@Headers(value="Content-Type:application/json") @GET(value="ocr/storage/{storageName}/exist") retrofit2.Call<StorageExist> storageExists(@Path(value="storageName") java.lang.String storageName)
storageName
- Storage name (required)@Headers(value="Content-Type:application/json") @GET(value="ocr/storage/version/{path}") retrofit2.Call<FileVersions> getFileVersions(@Path(value="path") java.lang.String path, @Query(value="storageName") java.lang.String storageName)
path
- File path e.g. '/file.ext' (required)storageName
- Storage name (optional)