org.nuxeo.client.methods

Interface BatchUploadAPI

public interface BatchUploadAPI

Since:

0.1

Method Summary

Modifier and Type	Method and Description
retrofit2.Call<okhttp3.ResponseBody>	cancel(String batchId)
retrofit2.Call<BatchUpload>	createBatch()
retrofit2.Call<Object>	execute(String batchId, String fileIdx, String operationId, OperationBody body)
retrofit2.Call<BatchUpload>	fetchBatchUpload(String batchId, String fileIdx)
retrofit2.Call<List<BatchUpload>>	fetchBatchUploads(String batchId)
retrofit2.Call<BatchUpload>	upload(String filename, long fileSize, String fileType, String uploadType, long uploadChunkIndex, long totalChunkCount, String batchId, String fileIdx, okhttp3.RequestBody blob)
retrofit2.Call<BatchUpload>	upload(String filename, String fileSize, String fileType, String uploadType, String uploadChunkIndex, String totalChunkCount, String batchId, String fileIdx, okhttp3.RequestBody file) Deprecated. since 3.1, use upload(String, long, String, String, long, long, String, String, RequestBody) instead

Method Detail

createBatch

@POST(value="upload")
retrofit2.Call<BatchUpload> createBatch()

fetchBatchUploads

@GET(value="upload/{batchId}")
retrofit2.Call<List<BatchUpload>> fetchBatchUploads(@Path(value="batchId")
                                                                                   String batchId)

fetchBatchUpload

@GET(value="upload/{batchId}/{fileIdx}")
retrofit2.Call<BatchUpload> fetchBatchUpload(@Path(value="batchId")
                                                                                      String batchId,
                                                                                      @Path(value="fileIdx")
                                                                                      String fileIdx)

cancel

@DELETE(value="upload/{batchId}")
retrofit2.Call<okhttp3.ResponseBody> cancel(@Path(value="batchId")
                                                                              String batchId)

execute

@POST(value="upload/{batchId}/{fileIdx}/execute/{operationId}")
retrofit2.Call<Object> execute(@Path(value="batchId")
                                                                                               String batchId,
                                                                                               @Path(value="fileIdx")
                                                                                               String fileIdx,
                                                                                               @Path(value="operationId")
                                                                                               String operationId,
                                                                                               @Body
                                                                                               OperationBody body)

upload

@Deprecated
 @Headers(value="Content-Type: application/octet-stream")
 @POST(value="upload/{batchId}/{fileIdx}")
retrofit2.Call<BatchUpload> upload(@Header(value="X-File-Name")
                                                                                                                                                    String filename,
                                                                                                                                                    @Header(value="X-File-Size")
                                                                                                                                                    String fileSize,
                                                                                                                                                    @Header(value="X-File-Type")
                                                                                                                                                    String fileType,
                                                                                                                                                    @Header(value="X-Upload-Type")
                                                                                                                                                    String uploadType,
                                                                                                                                                    @Header(value="X-Upload-Chunk-Index")
                                                                                                                                                    String uploadChunkIndex,
                                                                                                                                                    @Header(value="X-Upload-Chunk-Count")
                                                                                                                                                    String totalChunkCount,
                                                                                                                                                    @Path(value="batchId")
                                                                                                                                                    String batchId,
                                                                                                                                                    @Path(value="fileIdx")
                                                                                                                                                    String fileIdx,
                                                                                                                                                    @Body
                                                                                                                                                    okhttp3.RequestBody file)

Deprecated. since 3.1, use upload(String, long, String, String, long, long, String, String, RequestBody) instead

upload

@Headers(value="Content-Type: application/octet-stream")
 @POST(value="upload/{batchId}/{fileIdx}")
retrofit2.Call<BatchUpload> upload(@Header(value="X-File-Name")
                                                                                                                                       String filename,
                                                                                                                                       @Header(value="X-File-Size")
                                                                                                                                       long fileSize,
                                                                                                                                       @Header(value="X-File-Type")
                                                                                                                                       String fileType,
                                                                                                                                       @Header(value="X-Upload-Type")
                                                                                                                                       String uploadType,
                                                                                                                                       @Header(value="X-Upload-Chunk-Index")
                                                                                                                                       long uploadChunkIndex,
                                                                                                                                       @Header(value="X-Upload-Chunk-Count")
                                                                                                                                       long totalChunkCount,
                                                                                                                                       @Path(value="batchId")
                                                                                                                                       String batchId,
                                                                                                                                       @Path(value="fileIdx")
                                                                                                                                       String fileIdx,
                                                                                                                                       @Body
                                                                                                                                       okhttp3.RequestBody blob)