Interface UploadService
-
- All Implemented Interfaces:
public interface UploadService
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public interface
UploadService.WithRawResponse
A view of UploadService that provides access to raw HTTP responses for each method.
-
Method Summary
Modifier and Type Method Description abstract UploadService.WithRawResponse
withRawResponse()
Returns a view of this service that provides access to raw HTTP responses for each method. abstract PartService
parts()
Upload
create(UploadCreateParams params)
Creates an intermediate Upload object that you can add Parts to. abstract Upload
create(UploadCreateParams params, RequestOptions requestOptions)
Upload
cancel(UploadCancelParams params)
Cancels the Upload. abstract Upload
cancel(UploadCancelParams params, RequestOptions requestOptions)
Upload
complete(UploadCompleteParams params)
Completes the Upload. abstract Upload
complete(UploadCompleteParams params, RequestOptions requestOptions)
-
-
Method Detail
-
withRawResponse
abstract UploadService.WithRawResponse withRawResponse()
Returns a view of this service that provides access to raw HTTP responses for each method.
-
parts
abstract PartService parts()
-
create
Upload create(UploadCreateParams params)
Creates an intermediate Upload object that you can add Parts to. Currently, an Upload can accept at most 8 GB in total and expires after an hour after you create it.
Once you complete the Upload, we will create a File object that contains all the parts you uploaded. This File is usable in the rest of our platform as a regular File object.
For certain
purpose
values, the correctmime_type
must be specified. Please refer to documentation for the supported MIME types for your use case.For guidance on the proper filename extensions for each purpose, please follow the documentation on creating a File.
-
create
abstract Upload create(UploadCreateParams params, RequestOptions requestOptions)
-
cancel
Upload cancel(UploadCancelParams params)
Cancels the Upload. No Parts may be added after an Upload is cancelled.
-
cancel
abstract Upload cancel(UploadCancelParams params, RequestOptions requestOptions)
-
complete
Upload complete(UploadCompleteParams params)
Completes the Upload.
Within the returned Upload object, there is a nested File object that is ready to use in the rest of the platform.
You can specify the order of the Parts by passing in an ordered list of the Part IDs.
The number of bytes uploaded upon completion must match the number of bytes initially specified when creating the Upload object. No Parts may be added after an Upload is completed.
-
complete
abstract Upload complete(UploadCompleteParams params, RequestOptions requestOptions)
-
-
-
-