public interface OSS
Open Storage Service is the public massive, secure, low cost and high reliable storage service.
Users could use RESTFul APIs to access the data at anytime and anywhere.
Users could also manage the data and its configuration with the web console.
Based on OSS, user could build apps that need to have massive data access, such asmedia sharing app,
cloud disk app, personal or enterprise data backup apps,etc
OSS interface is the SDK's entry point interface. It wraps the OSS RESTful APIs in sync and async APIs the network request cannot be issued in UI thread.
限定符和类型 | 方法和说明 |
---|---|
AbortMultipartUploadResult |
abortMultipartUpload(AbortMultipartUploadRequest request)
Synchronously cancel the multipart upload.
|
void |
abortResumableUpload(ResumableUploadRequest request)
If the multipart upload is not aborted in a resumable upload,
this API needs to be called to abort the underlying multipart upload.
|
AppendObjectResult |
appendObject(AppendObjectRequest request)
Synchronously append the file
The object created by this method is Appendable type.
|
OSSAsyncTask<AbortMultipartUploadResult> |
asyncAbortMultipartUpload(AbortMultipartUploadRequest request,
OSSCompletedCallback<AbortMultipartUploadRequest,AbortMultipartUploadResult> completedCallback)
Asynchronously cancel the multipart upload.
|
OSSAsyncTask<AppendObjectResult> |
asyncAppendObject(AppendObjectRequest request,
OSSCompletedCallback<AppendObjectRequest,AppendObjectResult> completedCallback)
Asynchronously append the file
The object created by this method is Appendable type.
|
OSSAsyncTask<CompleteMultipartUploadResult> |
asyncCompleteMultipartUpload(CompleteMultipartUploadRequest request,
OSSCompletedCallback<CompleteMultipartUploadRequest,CompleteMultipartUploadResult> completedCallback)
Asynchronously complete the multipart upload.
|
OSSAsyncTask<CopyObjectResult> |
asyncCopyObject(CopyObjectRequest request,
OSSCompletedCallback<CopyObjectRequest,CopyObjectResult> completedCallback)
Asynchronously copy a file
It copies an existing file to another one.
|
OSSAsyncTask<CreateBucketResult> |
asyncCreateBucket(CreateBucketRequest request,
OSSCompletedCallback<CreateBucketRequest,CreateBucketResult> completedCallback)
Asynchronously create bucket
|
OSSAsyncTask<DeleteBucketResult> |
asyncDeleteBucket(DeleteBucketRequest request,
OSSCompletedCallback<DeleteBucketRequest,DeleteBucketResult> completedCallback)
Asynchronously delete bucket
|
OSSAsyncTask<DeleteObjectResult> |
asyncDeleteObject(DeleteObjectRequest request,
OSSCompletedCallback<DeleteObjectRequest,DeleteObjectResult> completedCallback)
Asynchronously delete file
RESTFul API:DeleteObject
|
OSSAsyncTask<GetBucketACLResult> |
asyncGetBucketACL(GetBucketACLRequest request,
OSSCompletedCallback<GetBucketACLRequest,GetBucketACLResult> completedCallback)
Asynchronously get bucket ACL
|
OSSAsyncTask<GetObjectResult> |
asyncGetObject(GetObjectRequest request,
OSSCompletedCallback<GetObjectRequest,GetObjectResult> completedCallback)
Asynchronously download file
Gets the object.
|
OSSAsyncTask<HeadObjectResult> |
asyncHeadObject(HeadObjectRequest request,
OSSCompletedCallback<HeadObjectRequest,HeadObjectResult> completedCallback)
Asynchronously get the file's metadata.
|
OSSAsyncTask<InitiateMultipartUploadResult> |
asyncInitMultipartUpload(InitiateMultipartUploadRequest request,
OSSCompletedCallback<InitiateMultipartUploadRequest,InitiateMultipartUploadResult> completedCallback)
Asynchronously initialize a multipart upload
Before use Multipart Upload for uploading data, this API is called to initiate the multipart upload,
which will get the upload Id from OSS.
|
OSSAsyncTask<ListObjectsResult> |
asyncListObjects(ListObjectsRequest request,
OSSCompletedCallback<ListObjectsRequest,ListObjectsResult> completedCallback)
Asynchronously list files
Get Bucket API is for listing bucket's all object information (not data itself).
|
OSSAsyncTask<ListPartsResult> |
asyncListParts(ListPartsRequest request,
OSSCompletedCallback<ListPartsRequest,ListPartsResult> completedCallback)
Asynchronously list parts uploaded
List Parts API could list all uploaded parts of the specified upload Id.
|
OSSAsyncTask<CompleteMultipartUploadResult> |
asyncMultipartUpload(MultipartUploadRequest request,
OSSCompletedCallback<MultipartUploadRequest,CompleteMultipartUploadResult> completedCallback)
Asynchronously do a multipart upload
|
OSSAsyncTask<PutObjectResult> |
asyncPutObject(PutObjectRequest request,
OSSCompletedCallback<PutObjectRequest,PutObjectResult> completedCallback)
Asynchronously upload file
RESTFul API:PutObject
|
OSSAsyncTask<ResumableUploadResult> |
asyncResumableUpload(ResumableUploadRequest request,
OSSCompletedCallback<ResumableUploadRequest,ResumableUploadResult> completedCallback)
Asynchronously do a resumable upload
|
OSSAsyncTask<UploadPartResult> |
asyncUploadPart(UploadPartRequest request,
OSSCompletedCallback<UploadPartRequest,UploadPartResult> completedCallback)
Asynchronously upload the part data
After the multipart upload is initialized, we can upload the part data with specified object key
and upload Id.
|
CompleteMultipartUploadResult |
completeMultipartUpload(CompleteMultipartUploadRequest request)
Synchronously complete the multipart upload.
|
CopyObjectResult |
copyObject(CopyObjectRequest request)
Synchronously copy a file
It copies an existing file to another one.
|
CreateBucketResult |
createBucket(CreateBucketRequest request)
Synchronously create bucket
|
DeleteBucketResult |
deleteBucket(DeleteBucketRequest request)
Synchronously delete bucket
|
DeleteObjectResult |
deleteObject(DeleteObjectRequest request)
Synchronously delete file
RESTFul API:DeleteObject
|
boolean |
doesObjectExist(java.lang.String bucketName,
java.lang.String objectKey)
Checks if the object exists in OSS
|
GetBucketACLResult |
getBucketACL(GetBucketACLRequest request)
Synchronously get bucket ACL
|
GetObjectResult |
getObject(GetObjectRequest request)
Synchronously download file
Gets the object.
|
HeadObjectResult |
headObject(HeadObjectRequest request)
Synchronously get the file's metadata.
|
InitiateMultipartUploadResult |
initMultipartUpload(InitiateMultipartUploadRequest request)
Synchronously initialize a multipart upload
Before use Multipart Upload for uploading data, this API is called to initiate the multipart upload,
which will get the upload Id from OSS.
|
ListObjectsResult |
listObjects(ListObjectsRequest request)
Synchronously list files
Get Bucket API is for listing bucket's all object information (not data itself).
|
ListPartsResult |
listParts(ListPartsRequest request)
Synchronously list parts uploaded
List Parts API could list all uploaded parts of the specified upload Id.
|
CompleteMultipartUploadResult |
multipartUpload(MultipartUploadRequest request)
Synchronously do a multipart upload
|
java.lang.String |
presignConstrainedObjectURL(GeneratePresignedUrlRequest request)
Generates the signed url for 3rd parties accessing object
|
java.lang.String |
presignConstrainedObjectURL(java.lang.String bucketName,
java.lang.String objectKey,
long expiredTimeInSeconds)
Generates the signed url for 3rd parties accessing object
|
java.lang.String |
presignPublicObjectURL(java.lang.String bucketName,
java.lang.String objectKey)
Generates the signed url for the public available object
|
PutObjectResult |
putObject(PutObjectRequest request)
Synchronously upload file
RESTFul API:PutObject
|
ResumableUploadResult |
resumableUpload(ResumableUploadRequest request)
Synchronously do a resumable upload
|
void |
updateCredentialProvider(OSSCredentialProvider credentialProvider)
Update the credential provider instance.
|
UploadPartResult |
uploadPart(UploadPartRequest request)
Synchronously upload the part data
After the multipart upload is initialized, we can upload the part data with specified object key
and upload Id.
|
OSSAsyncTask<PutObjectResult> asyncPutObject(PutObjectRequest request, OSSCompletedCallback<PutObjectRequest,PutObjectResult> completedCallback)
request
- the PutObjectRequest instancecompletedCallback
- PutObjectResult putObject(PutObjectRequest request) throws ClientException, ServiceException
request
- the PutObjectRequest instanceClientException
ServiceException
OSSAsyncTask<GetObjectResult> asyncGetObject(GetObjectRequest request, OSSCompletedCallback<GetObjectRequest,GetObjectResult> completedCallback)
request
- completedCallback
- GetObjectResult getObject(GetObjectRequest request) throws ClientException, ServiceException
request
- ClientException
ServiceException
OSSAsyncTask<DeleteObjectResult> asyncDeleteObject(DeleteObjectRequest request, OSSCompletedCallback<DeleteObjectRequest,DeleteObjectResult> completedCallback)
request
- completedCallback
- DeleteObjectResult deleteObject(DeleteObjectRequest request) throws ClientException, ServiceException
request
- ClientException
ServiceException
OSSAsyncTask<AppendObjectResult> asyncAppendObject(AppendObjectRequest request, OSSCompletedCallback<AppendObjectRequest,AppendObjectResult> completedCallback)
request
- completedCallback
- AppendObjectResult appendObject(AppendObjectRequest request) throws ClientException, ServiceException
request
- ClientException
ServiceException
OSSAsyncTask<HeadObjectResult> asyncHeadObject(HeadObjectRequest request, OSSCompletedCallback<HeadObjectRequest,HeadObjectResult> completedCallback)
request
- completedCallback
- HeadObjectResult headObject(HeadObjectRequest request) throws ClientException, ServiceException
request
- ClientException
ServiceException
OSSAsyncTask<CopyObjectResult> asyncCopyObject(CopyObjectRequest request, OSSCompletedCallback<CopyObjectRequest,CopyObjectResult> completedCallback)
request
- completedCallback
- CopyObjectResult copyObject(CopyObjectRequest request) throws ClientException, ServiceException
request
- ClientException
ServiceException
OSSAsyncTask<CreateBucketResult> asyncCreateBucket(CreateBucketRequest request, OSSCompletedCallback<CreateBucketRequest,CreateBucketResult> completedCallback)
request
- completedCallback
- CreateBucketResult createBucket(CreateBucketRequest request) throws ClientException, ServiceException
request
- ClientException
ServiceException
OSSAsyncTask<DeleteBucketResult> asyncDeleteBucket(DeleteBucketRequest request, OSSCompletedCallback<DeleteBucketRequest,DeleteBucketResult> completedCallback)
request
- completedCallback
- DeleteBucketResult deleteBucket(DeleteBucketRequest request) throws ClientException, ServiceException
request
- ClientException
ServiceException
OSSAsyncTask<GetBucketACLResult> asyncGetBucketACL(GetBucketACLRequest request, OSSCompletedCallback<GetBucketACLRequest,GetBucketACLResult> completedCallback)
request
- completedCallback
- GetBucketACLResult getBucketACL(GetBucketACLRequest request) throws ClientException, ServiceException
request
- ClientException
ServiceException
OSSAsyncTask<ListObjectsResult> asyncListObjects(ListObjectsRequest request, OSSCompletedCallback<ListObjectsRequest,ListObjectsResult> completedCallback)
request
- completedCallback
- ListObjectsResult listObjects(ListObjectsRequest request) throws ClientException, ServiceException
request
- ClientException
ServiceException
OSSAsyncTask<InitiateMultipartUploadResult> asyncInitMultipartUpload(InitiateMultipartUploadRequest request, OSSCompletedCallback<InitiateMultipartUploadRequest,InitiateMultipartUploadResult> completedCallback)
request
- completedCallback
- InitiateMultipartUploadResult initMultipartUpload(InitiateMultipartUploadRequest request) throws ClientException, ServiceException
request
- ClientException
ServiceException
OSSAsyncTask<UploadPartResult> asyncUploadPart(UploadPartRequest request, OSSCompletedCallback<UploadPartRequest,UploadPartResult> completedCallback)
request
- completedCallback
- UploadPartResult uploadPart(UploadPartRequest request) throws ClientException, ServiceException
request
- ClientException
ServiceException
OSSAsyncTask<CompleteMultipartUploadResult> asyncCompleteMultipartUpload(CompleteMultipartUploadRequest request, OSSCompletedCallback<CompleteMultipartUploadRequest,CompleteMultipartUploadResult> completedCallback)
request
- completedCallback
- CompleteMultipartUploadResult completeMultipartUpload(CompleteMultipartUploadRequest request) throws ClientException, ServiceException
request
- ClientException
ServiceException
OSSAsyncTask<AbortMultipartUploadResult> asyncAbortMultipartUpload(AbortMultipartUploadRequest request, OSSCompletedCallback<AbortMultipartUploadRequest,AbortMultipartUploadResult> completedCallback)
request
- completedCallback
- AbortMultipartUploadResult abortMultipartUpload(AbortMultipartUploadRequest request) throws ClientException, ServiceException
request
- ClientException
ServiceException
OSSAsyncTask<ListPartsResult> asyncListParts(ListPartsRequest request, OSSCompletedCallback<ListPartsRequest,ListPartsResult> completedCallback)
request
- completedCallback
- ListPartsResult listParts(ListPartsRequest request) throws ClientException, ServiceException
request
- ClientException
ServiceException
void updateCredentialProvider(OSSCredentialProvider credentialProvider)
OSSAsyncTask<CompleteMultipartUploadResult> asyncMultipartUpload(MultipartUploadRequest request, OSSCompletedCallback<MultipartUploadRequest,CompleteMultipartUploadResult> completedCallback)
request
- ClientException
ServiceException
CompleteMultipartUploadResult multipartUpload(MultipartUploadRequest request) throws ClientException, ServiceException
request
- ClientException
ServiceException
OSSAsyncTask<ResumableUploadResult> asyncResumableUpload(ResumableUploadRequest request, OSSCompletedCallback<ResumableUploadRequest,ResumableUploadResult> completedCallback)
request
- ClientException
ServiceException
ResumableUploadResult resumableUpload(ResumableUploadRequest request) throws ClientException, ServiceException
request
- ClientException
ServiceException
java.lang.String presignConstrainedObjectURL(GeneratePresignedUrlRequest request) throws ClientException
request
- Generates the signed by custom config @see {GeneratePresignedUrlRequest}ClientException
java.lang.String presignConstrainedObjectURL(java.lang.String bucketName, java.lang.String objectKey, long expiredTimeInSeconds) throws ClientException
bucketName
- bucket nameobjectKey
- Object keyexpiredTimeInSeconds
- URL's expiration time in secondsClientException
java.lang.String presignPublicObjectURL(java.lang.String bucketName, java.lang.String objectKey)
bucketName
- bucket nameobjectKey
- Object keyboolean doesObjectExist(java.lang.String bucketName, java.lang.String objectKey) throws ClientException, ServiceException
bucketName
- objectKey
- ClientException
ServiceException
void abortResumableUpload(ResumableUploadRequest request) throws java.io.IOException
request
- java.io.IOException