com.alibaba.sdk.android.oss

接口 OSS

所有已知实现类:

OSSClient

public interface OSS

The access entry point interface for OSS (Open Storage Service).

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<DeleteBucketLifecycleResult>	asyncDeleteBucketLifecycle(DeleteBucketLifecycleRequest request, OSSCompletedCallback<DeleteBucketLifecycleRequest,DeleteBucketLifecycleResult> completedCallback) Asynchronously delete bucket lifecycle
OSSAsyncTask<DeleteBucketLoggingResult>	asyncDeleteBucketLogging(DeleteBucketLoggingRequest request, OSSCompletedCallback<DeleteBucketLoggingRequest,DeleteBucketLoggingResult> completedCallback) Asynchronously delete bucket logging
OSSAsyncTask<DeleteMultipleObjectResult>	asyncDeleteMultipleObject(DeleteMultipleObjectRequest request, OSSCompletedCallback<DeleteMultipleObjectRequest,DeleteMultipleObjectResult> completedCallback) Asynchronously delete multiple objects
OSSAsyncTask<DeleteObjectResult>	asyncDeleteObject(DeleteObjectRequest request, OSSCompletedCallback<DeleteObjectRequest,DeleteObjectResult> completedCallback) Asynchronously delete file RESTFul API:DeleteObject
OSSAsyncTask<DeleteObjectTaggingResult>	asyncDeleteObjectTagging(DeleteObjectTaggingRequest request, OSSCompletedCallback<DeleteObjectTaggingRequest,DeleteObjectTaggingResult> completedCallback) You can call this operation to delete the tags of a specified object.
OSSAsyncTask<GetBucketACLResult>	asyncGetBucketACL(GetBucketACLRequest request, OSSCompletedCallback<GetBucketACLRequest,GetBucketACLResult> completedCallback) Asynchronously get bucket ACL
OSSAsyncTask<GetBucketInfoResult>	asyncGetBucketInfo(GetBucketInfoRequest request, OSSCompletedCallback<GetBucketInfoRequest,GetBucketInfoResult> completedCallback) Asynchronously get bucket info
OSSAsyncTask<GetBucketLifecycleResult>	asyncGetBucketLifecycle(GetBucketLifecycleRequest request, OSSCompletedCallback<GetBucketLifecycleRequest,GetBucketLifecycleResult> completedCallback) Asynchronously get bucket lifecycle
OSSAsyncTask<GetBucketLoggingResult>	asyncGetBucketLogging(GetBucketLoggingRequest request, OSSCompletedCallback<GetBucketLoggingRequest,GetBucketLoggingResult> completedCallback) Asynchronously get bucket logging
OSSAsyncTask<GetBucketRefererResult>	asyncGetBucketReferer(GetBucketRefererRequest request, OSSCompletedCallback<GetBucketRefererRequest,GetBucketRefererResult> completedCallback) Asynchronously get bucket referer
OSSAsyncTask<GetObjectResult>	asyncGetObject(GetObjectRequest request, OSSCompletedCallback<GetObjectRequest,GetObjectResult> completedCallback) Asynchronously download file Gets the object.
OSSAsyncTask<GetObjectACLResult>	asyncGetObjectACL(GetObjectACLRequest request, OSSCompletedCallback<GetObjectACLRequest,GetObjectACLResult> completedCallback)
OSSAsyncTask<GetObjectMetaResult>	asyncGetObjectMeta(GetObjectMetaRequest request, OSSCompletedCallback<GetObjectMetaRequest,GetObjectMetaResult> completedCallback) Asynchronously queries the metadata of an object, including ETag, Size, and LastModified.
OSSAsyncTask<GetObjectTaggingResult>	asyncGetObjectTagging(GetObjectTaggingRequest request, OSSCompletedCallback<GetObjectTaggingRequest,GetObjectTaggingResult> completedCallback) You can call this operation to query the tags of an object.
OSSAsyncTask<GetSymlinkResult>	asyncGetSymlink(GetSymlinkRequest request, OSSCompletedCallback<GetSymlinkRequest,GetSymlinkResult> completedCallback) Asynchronously gets the symlink information for the given symlink name.
OSSAsyncTask<HeadObjectResult>	asyncHeadObject(HeadObjectRequest request, OSSCompletedCallback<HeadObjectRequest,HeadObjectResult> completedCallback) Asynchronously get the file's metadata.
OSSAsyncTask<ImagePersistResult>	asyncImagePersist(ImagePersistRequest request, OSSCompletedCallback<ImagePersistRequest,ImagePersistResult> completedCallback)
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<ListBucketsResult>	asyncListBuckets(ListBucketsRequest request, OSSCompletedCallback<ListBucketsRequest,ListBucketsResult> completedCallback) Asynchronously list buckets RESTFul API:PutObject
OSSAsyncTask<ListMultipartUploadsResult>	asyncListMultipartUploads(ListMultipartUploadsRequest request, OSSCompletedCallback<ListMultipartUploadsRequest,ListMultipartUploadsResult> completedCallback) Asynchronously list multipart uploads
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<PutBucketLifecycleResult>	asyncPutBucketLifecycle(PutBucketLifecycleRequest request, OSSCompletedCallback<PutBucketLifecycleRequest,PutBucketLifecycleResult> completedCallback) Asynchronously put bucket lifecycle
OSSAsyncTask<PutBucketLoggingResult>	asyncPutBucketLogging(PutBucketLoggingRequest request, OSSCompletedCallback<PutBucketLoggingRequest,PutBucketLoggingResult> completedCallback) Asynchronously delete bucket logging
OSSAsyncTask<PutBucketRefererResult>	asyncPutBucketReferer(PutBucketRefererRequest request, OSSCompletedCallback<PutBucketRefererRequest,PutBucketRefererResult> completedCallback) Asynchronously put bucket referer
OSSAsyncTask<PutObjectResult>	asyncPutObject(PutObjectRequest request, OSSCompletedCallback<PutObjectRequest,PutObjectResult> completedCallback) Asynchronously upload file RESTFul API:PutObject
OSSAsyncTask<PutObjectTaggingResult>	asyncPutObjectTagging(PutObjectTaggingRequest request, OSSCompletedCallback<PutObjectTaggingRequest,PutObjectTaggingResult> completedCallback) You can call this operation to add tags to an object or update the tags added to the bucket.
OSSAsyncTask<PutSymlinkResult>	asyncPutSymlink(PutSymlinkRequest request, OSSCompletedCallback<PutSymlinkRequest,PutSymlinkResult> completedCallback) Asynchronously creates a symbol link to a target file under the bucket---this is not supported for archive class bucket.
OSSAsyncTask<RestoreObjectResult>	asyncRestoreObject(RestoreObjectRequest request, OSSCompletedCallback<RestoreObjectRequest,RestoreObjectResult> completedCallback) Asynchronously restores the object of archive storage.
OSSAsyncTask<ResumableDownloadResult>	asyncResumableDownload(ResumableDownloadRequest request, OSSCompletedCallback<ResumableDownloadRequest,ResumableDownloadResult> completedCallback) Asynchronously do a resumable download
OSSAsyncTask<ResumableUploadResult>	asyncResumableUpload(ResumableUploadRequest request, OSSCompletedCallback<ResumableUploadRequest,ResumableUploadResult> completedCallback) Asynchronously do a resumable upload
OSSAsyncTask<ResumableUploadResult>	asyncSequenceUpload(ResumableUploadRequest request, OSSCompletedCallback<ResumableUploadRequest,ResumableUploadResult> completedCallback)
OSSAsyncTask<TriggerCallbackResult>	asyncTriggerCallback(TriggerCallbackRequest request, OSSCompletedCallback<TriggerCallbackRequest,TriggerCallbackResult> completedCallback)
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
DeleteBucketLifecycleResult	deleteBucketLifecycle(DeleteBucketLifecycleRequest request) Synchronously delete bucket lifecycle
DeleteBucketLoggingResult	deleteBucketLogging(DeleteBucketLoggingRequest request) Synchronously delete bucket logging
DeleteMultipleObjectResult	deleteMultipleObject(DeleteMultipleObjectRequest request) delete multiple objects
DeleteObjectResult	deleteObject(DeleteObjectRequest request) Synchronously delete file RESTFul API:DeleteObject
DeleteObjectTaggingResult	deleteObjectTagging(DeleteObjectTaggingRequest request) You can call this operation to delete the tags of a specified object.
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
GetBucketInfoResult	getBucketInfo(GetBucketInfoRequest request) Gets the Bucket's basic information as well as its ACL.
GetBucketLifecycleResult	getBucketLifecycle(GetBucketLifecycleRequest request) Synchronously get bucket lifecycle
GetBucketLoggingResult	getBucketLogging(GetBucketLoggingRequest request) Synchronously get bucket logging
GetBucketRefererResult	getBucketReferer(GetBucketRefererRequest request) Synchronously get bucket referer
GetObjectResult	getObject(GetObjectRequest request) Synchronously download file Gets the object.
GetObjectACLResult	getObjectACL(GetObjectACLRequest request)
GetObjectMetaResult	getObjectMeta(GetObjectMetaRequest request) Synchronously queries the metadata of an object, including ETag, Size, and LastModified.
GetObjectTaggingResult	getObjectTagging(GetObjectTaggingRequest request) You can call this operation to query the tags of an object.
GetSymlinkResult	getSymlink(GetSymlinkRequest request) Synchronously gets the symlink information for the given symlink name.
HeadObjectResult	headObject(HeadObjectRequest request) Synchronously get the file's metadata.
ImagePersistResult	imagePersist(ImagePersistRequest request)
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.
ListBucketsResult	listBuckets(ListBucketsRequest request) Synchronously list buckets RESTFul API:PutObject
ListMultipartUploadsResult	listMultipartUploads(ListMultipartUploadsRequest request) Synchronously list multipart uploads
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
PutBucketLifecycleResult	putBucketLifecycle(PutBucketLifecycleRequest request) Synchronously put bucket lifecycle
PutBucketLoggingResult	putBucketLogging(PutBucketLoggingRequest request) Synchronously put bucket logging
PutBucketRefererResult	putBucketReferer(PutBucketRefererRequest request) Synchronously put bucket referer
PutObjectResult	putObject(PutObjectRequest request) Synchronously upload file RESTFul API:PutObject
PutObjectTaggingResult	putObjectTagging(PutObjectTaggingRequest request) You can call this operation to add tags to an object or update the tags added to the bucket.
PutSymlinkResult	putSymlink(PutSymlinkRequest request) Synchronously creates a symbol link to a target file under the bucket---this is not supported for archive class bucket.
RestoreObjectResult	restoreObject(RestoreObjectRequest request) Synchronously restores the object of archive storage.
ResumableUploadResult	resumableUpload(ResumableUploadRequest request) Synchronously do a resumable upload
ResumableUploadResult	sequenceUpload(ResumableUploadRequest request)
ResumableDownloadResult	syncResumableDownload(ResumableDownloadRequest request) Synchronously do a resumable download
TriggerCallbackResult	triggerCallback(TriggerCallbackRequest request)
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.

方法详细资料

asyncListBuckets

OSSAsyncTask<ListBucketsResult> asyncListBuckets(ListBucketsRequest request,
                                                 OSSCompletedCallback<ListBucketsRequest,ListBucketsResult> completedCallback)

Asynchronously list buckets RESTFul API:PutObject

参数:

request -

completedCallback -

返回:

listBuckets

ListBucketsResult listBuckets(ListBucketsRequest request)
                       throws ClientException,
                              ServiceException

Synchronously list buckets RESTFul API:PutObject

参数:

request -

返回:

抛出:

ClientException

ServiceException

asyncPutObject

OSSAsyncTask<PutObjectResult> asyncPutObject(PutObjectRequest request,
                                             OSSCompletedCallback<PutObjectRequest,PutObjectResult> completedCallback)

Asynchronously upload file RESTFul API:PutObject

参数:

request - the PutObjectRequest instance

completedCallback -

返回:

putObject

PutObjectResult putObject(PutObjectRequest request)
                   throws ClientException,
                          ServiceException

Synchronously upload file RESTFul API:PutObject

参数:

request - the PutObjectRequest instance

返回:

抛出:

ClientException

ServiceException

asyncGetObject

OSSAsyncTask<GetObjectResult> asyncGetObject(GetObjectRequest request,
                                             OSSCompletedCallback<GetObjectRequest,GetObjectResult> completedCallback)

Asynchronously download file Gets the object. (the caller needs the read permission on the object) RESTFul API:GetObject

参数:

request -

completedCallback -

返回:

getObject

GetObjectResult getObject(GetObjectRequest request)
                   throws ClientException,
                          ServiceException

Synchronously download file Gets the object. (the caller needs the read permission on the object) RESTFul API:GetObject

参数:

request -

返回:

抛出:

ClientException

ServiceException

asyncDeleteObject

OSSAsyncTask<DeleteObjectResult> asyncDeleteObject(DeleteObjectRequest request,
                                                   OSSCompletedCallback<DeleteObjectRequest,DeleteObjectResult> completedCallback)

Asynchronously delete file RESTFul API:DeleteObject

参数:

request -

completedCallback -

返回:

deleteObject

DeleteObjectResult deleteObject(DeleteObjectRequest request)
                         throws ClientException,
                                ServiceException

Synchronously delete file RESTFul API:DeleteObject

参数:

request -

返回:

抛出:

ClientException

ServiceException

asyncDeleteMultipleObject

OSSAsyncTask<DeleteMultipleObjectResult> asyncDeleteMultipleObject(DeleteMultipleObjectRequest request,
                                                                   OSSCompletedCallback<DeleteMultipleObjectRequest,DeleteMultipleObjectResult> completedCallback)

Asynchronously delete multiple objects

参数:

request -

completedCallback -

返回:

deleteMultipleObject

DeleteMultipleObjectResult deleteMultipleObject(DeleteMultipleObjectRequest request)
                                         throws ClientException,
                                                ServiceException

delete multiple objects

参数:

request -

返回:

抛出:

ClientException

ServiceException

asyncAppendObject

OSSAsyncTask<AppendObjectResult> asyncAppendObject(AppendObjectRequest request,
                                                   OSSCompletedCallback<AppendObjectRequest,AppendObjectResult> completedCallback)

Asynchronously append the file The object created by this method is Appendable type. While the object created by PUT Object is normal type (not appendable).

参数:

request -

completedCallback -

返回:

appendObject

AppendObjectResult appendObject(AppendObjectRequest request)
                         throws ClientException,
                                ServiceException

Synchronously append the file The object created by this method is Appendable type. While the object created by PUT Object is normal type (not appendable).

参数:

request -

返回:

抛出:

ClientException

ServiceException

asyncHeadObject

OSSAsyncTask<HeadObjectResult> asyncHeadObject(HeadObjectRequest request,
                                               OSSCompletedCallback<HeadObjectRequest,HeadObjectResult> completedCallback)

Asynchronously get the file's metadata. Head Object only returns the metadata information, not the object content.

参数:

request -

completedCallback -

返回:

headObject

HeadObjectResult headObject(HeadObjectRequest request)
                     throws ClientException,
                            ServiceException

Synchronously get the file's metadata. Head Object only returns the metadata information, not the object content.

参数:

request -

返回:

抛出:

ClientException

ServiceException

asyncGetObjectMeta

OSSAsyncTask<GetObjectMetaResult> asyncGetObjectMeta(GetObjectMetaRequest request,
                                                     OSSCompletedCallback<GetObjectMetaRequest,GetObjectMetaResult> completedCallback)

Asynchronously queries the metadata of an object, including ETag, Size, and LastModified. The content of the object is not returned.

参数:

request -

completedCallback -

返回:

getObjectMeta

GetObjectMetaResult getObjectMeta(GetObjectMetaRequest request)
                           throws ClientException,
                                  ServiceException

Synchronously queries the metadata of an object, including ETag, Size, and LastModified. The content of the object is not returned.

参数:

request -

返回:

抛出:

ClientException

ServiceException

asyncCopyObject

OSSAsyncTask<CopyObjectResult> asyncCopyObject(CopyObjectRequest request,
                                               OSSCompletedCallback<CopyObjectRequest,CopyObjectResult> completedCallback)

Asynchronously copy a file It copies an existing file to another one. This API just sends the PUT object request to OSS with the x-oss-copy-source information. And therefore the file's content is not downloaded or uploaded from to server. This API only fit the files whose size is less than 1GB. For bigger files, please use multipart copy API. Checks out the multipart upload APIs.

参数:

request -

completedCallback -

返回:

copyObject

CopyObjectResult copyObject(CopyObjectRequest request)
                     throws ClientException,
                            ServiceException

Synchronously copy a file It copies an existing file to another one. This API just sends the PUT object request to OSS with the x-oss-copy-source information. And therefore the file's content is not downloaded or uploaded from to server. This API only fit the files whose size is less than 1GB. For bigger files, please use multipart copy API. Checks out the multipart upload APIs.

参数:

request -

返回:

抛出:

ClientException

ServiceException

asyncGetObjectACL

OSSAsyncTask<GetObjectACLResult> asyncGetObjectACL(GetObjectACLRequest request,
                                                   OSSCompletedCallback<GetObjectACLRequest,GetObjectACLResult> completedCallback)

getObjectACL

GetObjectACLResult getObjectACL(GetObjectACLRequest request)
                         throws ClientException,
                                ServiceException

抛出:

ClientException

ServiceException

asyncCreateBucket

OSSAsyncTask<CreateBucketResult> asyncCreateBucket(CreateBucketRequest request,
                                                   OSSCompletedCallback<CreateBucketRequest,CreateBucketResult> completedCallback)

Asynchronously create bucket

参数:

request -

completedCallback -

返回:

createBucket

CreateBucketResult createBucket(CreateBucketRequest request)
                         throws ClientException,
                                ServiceException

Synchronously create bucket

参数:

request -

返回:

抛出:

ClientException

ServiceException

asyncDeleteBucket

OSSAsyncTask<DeleteBucketResult> asyncDeleteBucket(DeleteBucketRequest request,
                                                   OSSCompletedCallback<DeleteBucketRequest,DeleteBucketResult> completedCallback)

Asynchronously delete bucket

参数:

request -

completedCallback -

返回:

deleteBucket

DeleteBucketResult deleteBucket(DeleteBucketRequest request)
                         throws ClientException,
                                ServiceException

Synchronously delete bucket

参数:

request -

返回:

抛出:

ClientException

ServiceException

asyncGetBucketInfo

OSSAsyncTask<GetBucketInfoResult> asyncGetBucketInfo(GetBucketInfoRequest request,
                                                     OSSCompletedCallback<GetBucketInfoRequest,GetBucketInfoResult> completedCallback)

Asynchronously get bucket info

参数:

request - A GetBucketInfoRequest instance which specifies the bucket name.

completedCallback - A OSSCompletedCallback instance that specifies callback functions

返回:

getBucketInfo

GetBucketInfoResult getBucketInfo(GetBucketInfoRequest request)
                           throws ClientException,
                                  ServiceException

Gets the Bucket's basic information as well as its ACL.

参数:

request - A GetBucketInfoRequest instance which specifies the bucket name.

返回:

A GetBucketInfoResult instance.

抛出:

ClientException - OSS Client side exception.

ServiceException - OSS Server side exception.

asyncGetBucketACL

OSSAsyncTask<GetBucketACLResult> asyncGetBucketACL(GetBucketACLRequest request,
                                                   OSSCompletedCallback<GetBucketACLRequest,GetBucketACLResult> completedCallback)

Asynchronously get bucket ACL

参数:

request -

completedCallback -

返回:

getBucketACL

GetBucketACLResult getBucketACL(GetBucketACLRequest request)
                         throws ClientException,
                                ServiceException

Synchronously get bucket ACL

参数:

request -

返回:

抛出:

ClientException

ServiceException

getBucketReferer

GetBucketRefererResult getBucketReferer(GetBucketRefererRequest request)
                                 throws ClientException,
                                        ServiceException

Synchronously get bucket referer

参数:

request -

返回:

抛出:

ClientException

ServiceException

asyncPutBucketReferer

OSSAsyncTask<PutBucketRefererResult> asyncPutBucketReferer(PutBucketRefererRequest request,
                                                           OSSCompletedCallback<PutBucketRefererRequest,PutBucketRefererResult> completedCallback)

Asynchronously put bucket referer

参数:

request -

completedCallback -

返回:

putBucketReferer

PutBucketRefererResult putBucketReferer(PutBucketRefererRequest request)
                                 throws ClientException,
                                        ServiceException

Synchronously put bucket referer

参数:

request -

返回:

抛出:

ClientException

ServiceException

deleteBucketLogging

DeleteBucketLoggingResult deleteBucketLogging(DeleteBucketLoggingRequest request)
                                       throws ClientException,
                                              ServiceException

Synchronously delete bucket logging

参数:

request -

返回:

抛出:

ClientException

ServiceException

asyncDeleteBucketLogging

OSSAsyncTask<DeleteBucketLoggingResult> asyncDeleteBucketLogging(DeleteBucketLoggingRequest request,
                                                                 OSSCompletedCallback<DeleteBucketLoggingRequest,DeleteBucketLoggingResult> completedCallback)

Asynchronously delete bucket logging

参数:

request -

completedCallback -

返回:

putBucketLogging

PutBucketLoggingResult putBucketLogging(PutBucketLoggingRequest request)
                                 throws ClientException,
                                        ServiceException

Synchronously put bucket logging

参数:

request -

返回:

抛出:

ClientException

ServiceException

asyncPutBucketLogging

OSSAsyncTask<PutBucketLoggingResult> asyncPutBucketLogging(PutBucketLoggingRequest request,
                                                           OSSCompletedCallback<PutBucketLoggingRequest,PutBucketLoggingResult> completedCallback)

Asynchronously delete bucket logging

参数:

request -

completedCallback -

返回:

getBucketLogging

GetBucketLoggingResult getBucketLogging(GetBucketLoggingRequest request)
                                 throws ClientException,
                                        ServiceException

Synchronously get bucket logging

参数:

request -

返回:

抛出:

ClientException

ServiceException

asyncGetBucketLogging

OSSAsyncTask<GetBucketLoggingResult> asyncGetBucketLogging(GetBucketLoggingRequest request,
                                                           OSSCompletedCallback<GetBucketLoggingRequest,GetBucketLoggingResult> completedCallback)

Asynchronously get bucket logging

参数:

request -

completedCallback -

返回:

asyncGetBucketReferer

OSSAsyncTask<GetBucketRefererResult> asyncGetBucketReferer(GetBucketRefererRequest request,
                                                           OSSCompletedCallback<GetBucketRefererRequest,GetBucketRefererResult> completedCallback)

Asynchronously get bucket referer

参数:

request -

completedCallback -

返回:

putBucketLifecycle

PutBucketLifecycleResult putBucketLifecycle(PutBucketLifecycleRequest request)
                                     throws ClientException,
                                            ServiceException

Synchronously put bucket lifecycle

参数:

request -

返回:

抛出:

ClientException

ServiceException

asyncPutBucketLifecycle

OSSAsyncTask<PutBucketLifecycleResult> asyncPutBucketLifecycle(PutBucketLifecycleRequest request,
                                                               OSSCompletedCallback<PutBucketLifecycleRequest,PutBucketLifecycleResult> completedCallback)

Asynchronously put bucket lifecycle

参数:

request -

completedCallback -

返回:

getBucketLifecycle

GetBucketLifecycleResult getBucketLifecycle(GetBucketLifecycleRequest request)
                                     throws ClientException,
                                            ServiceException

Synchronously get bucket lifecycle

参数:

request -

返回:

抛出:

ClientException

ServiceException

asyncGetBucketLifecycle

OSSAsyncTask<GetBucketLifecycleResult> asyncGetBucketLifecycle(GetBucketLifecycleRequest request,
                                                               OSSCompletedCallback<GetBucketLifecycleRequest,GetBucketLifecycleResult> completedCallback)

Asynchronously get bucket lifecycle

参数:

request -

completedCallback -

返回:

deleteBucketLifecycle

DeleteBucketLifecycleResult deleteBucketLifecycle(DeleteBucketLifecycleRequest request)
                                           throws ClientException,
                                                  ServiceException

Synchronously delete bucket lifecycle

参数:

request -

返回:

抛出:

ClientException

ServiceException

asyncDeleteBucketLifecycle

OSSAsyncTask<DeleteBucketLifecycleResult> asyncDeleteBucketLifecycle(DeleteBucketLifecycleRequest request,
                                                                     OSSCompletedCallback<DeleteBucketLifecycleRequest,DeleteBucketLifecycleResult> completedCallback)

Asynchronously delete bucket lifecycle

参数:

request -

completedCallback -

返回:

asyncListObjects

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).

参数:

request -

completedCallback -

返回:

listObjects

ListObjectsResult listObjects(ListObjectsRequest request)
                       throws ClientException,
                              ServiceException

Synchronously list files Get Bucket API is for listing bucket's all object information (not data itself).

参数:

request -

返回:

抛出:

ClientException

ServiceException

asyncInitMultipartUpload

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. Then this upload Id will be used in the subsequent calls, such as abort the multipart upload, query the multipart upload, upload part, etc.

参数:

request -

completedCallback -

返回:

initMultipartUpload

InitiateMultipartUploadResult initMultipartUpload(InitiateMultipartUploadRequest request)
                                           throws ClientException,
                                                  ServiceException

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. Then this upload Id will be used in the subsequent calls, such as abort the multipart upload, query the multipart upload, upload part, etc.

参数:

request -

返回:

抛出:

ClientException

ServiceException

asyncUploadPart

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. For each part to upload, it has a unique part number (from 1 to 10000). And for the same upload Id, this part number identify the part and its position in the whole target object. If the same part number and upload Id are uploaded with other data later, then this part's data is overwritten. Except the last part, the minimal part size is 100KB.

参数:

request -

completedCallback -

返回:

uploadPart

UploadPartResult uploadPart(UploadPartRequest request)
                     throws ClientException,
                            ServiceException

Synchronously upload the part data After the multipart upload is initialized, we can upload the part data with specified object key and upload Id. For each part to upload, it has a unique part number (from 1 to 10000). And for the same upload Id, this part number identify the part and its position in the whole target object. If the same part number and upload Id are uploaded with other data later, then this part's data is overwritten. Except the last part, the minimal part size is 100KB.

参数:

request -

返回:

抛出:

ClientException

ServiceException

asyncCompleteMultipartUpload

OSSAsyncTask<CompleteMultipartUploadResult> asyncCompleteMultipartUpload(CompleteMultipartUploadRequest request,
                                                                         OSSCompletedCallback<CompleteMultipartUploadRequest,CompleteMultipartUploadResult> completedCallback)

Asynchronously complete the multipart upload. After uploading all parts' data, this API needs to be called to complete the whole upload. To call this API, the valid list of the part numbers and ETags (wrapped as PartETag) are specified. The OSS will validate very part and their rankings and then merge the parts into target file. After this call, the parts data is unavailable to user.

参数:

request -

completedCallback -

返回:

completeMultipartUpload

CompleteMultipartUploadResult completeMultipartUpload(CompleteMultipartUploadRequest request)
                                               throws ClientException,
                                                      ServiceException

Synchronously complete the multipart upload. After uploading all parts' data, this API needs to be called to complete the whole upload. To call this API, the valid list of the part numbers and ETags (wrapped as PartETag) are specified. The OSS will validate very part and their rankings and then merge the parts into target file. After this call, the parts data is unavailable to user.

参数:

request -

返回:

抛出:

ClientException

ServiceException

asyncAbortMultipartUpload

OSSAsyncTask<AbortMultipartUploadResult> asyncAbortMultipartUpload(AbortMultipartUploadRequest request,
                                                                   OSSCompletedCallback<AbortMultipartUploadRequest,AbortMultipartUploadResult> completedCallback)

Asynchronously cancel the multipart upload. This API is to abort the multipart upload with specified upload Id. When the multipart upload is aborted, the upload Id is invalid anymore and all parts data will be deleted.

参数:

request -

completedCallback -

返回:

abortMultipartUpload

AbortMultipartUploadResult abortMultipartUpload(AbortMultipartUploadRequest request)
                                         throws ClientException,
                                                ServiceException

Synchronously cancel the multipart upload. This API is to abort the multipart upload with specified upload Id. When the multipart upload is aborted, the upload Id is invalid anymore and all parts data will be deleted.

参数:

request -

返回:

抛出:

ClientException

ServiceException

asyncListParts

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.

参数:

request -

completedCallback -

返回:

listParts

ListPartsResult listParts(ListPartsRequest request)
                   throws ClientException,
                          ServiceException

Synchronously list parts uploaded List Parts API could list all uploaded parts of the specified upload Id.

参数:

request -

返回:

抛出:

ClientException

ServiceException

asyncListMultipartUploads

OSSAsyncTask<ListMultipartUploadsResult> asyncListMultipartUploads(ListMultipartUploadsRequest request,
                                                                   OSSCompletedCallback<ListMultipartUploadsRequest,ListMultipartUploadsResult> completedCallback)

Asynchronously list multipart uploads

参数:

request -

返回:

抛出:

ClientException

ServiceException

listMultipartUploads

ListMultipartUploadsResult listMultipartUploads(ListMultipartUploadsRequest request)
                                         throws ClientException,
                                                ServiceException

Synchronously list multipart uploads

参数:

request -

返回:

抛出:

ClientException

ServiceException

updateCredentialProvider

void updateCredentialProvider(OSSCredentialProvider credentialProvider)

Update the credential provider instance. The old one will not be used.

asyncMultipartUpload

OSSAsyncTask<CompleteMultipartUploadResult> asyncMultipartUpload(MultipartUploadRequest request,
                                                                 OSSCompletedCallback<MultipartUploadRequest,CompleteMultipartUploadResult> completedCallback)

Asynchronously do a multipart upload

参数:

request -

返回:

抛出:

ClientException

ServiceException

multipartUpload

CompleteMultipartUploadResult multipartUpload(MultipartUploadRequest request)
                                       throws ClientException,
                                              ServiceException

Synchronously do a multipart upload

参数:

request -

返回:

抛出:

ClientException

ServiceException

asyncResumableUpload

OSSAsyncTask<ResumableUploadResult> asyncResumableUpload(ResumableUploadRequest request,
                                                         OSSCompletedCallback<ResumableUploadRequest,ResumableUploadResult> completedCallback)

Asynchronously do a resumable upload

参数:

request -

返回:

抛出:

ClientException

ServiceException

resumableUpload

ResumableUploadResult resumableUpload(ResumableUploadRequest request)
                               throws ClientException,
                                      ServiceException

Synchronously do a resumable upload

参数:

request -

返回:

抛出:

ClientException

ServiceException

asyncSequenceUpload

OSSAsyncTask<ResumableUploadResult> asyncSequenceUpload(ResumableUploadRequest request,
                                                        OSSCompletedCallback<ResumableUploadRequest,ResumableUploadResult> completedCallback)

sequenceUpload

ResumableUploadResult sequenceUpload(ResumableUploadRequest request)
                              throws ClientException,
                                     ServiceException

抛出:

ClientException

ServiceException

presignConstrainedObjectURL

java.lang.String presignConstrainedObjectURL(GeneratePresignedUrlRequest request)
                                      throws ClientException

Generates the signed url for 3rd parties accessing object

参数:

request - Generates the signed by custom config @see {GeneratePresignedUrlRequest}

返回:

抛出:

ClientException

presignConstrainedObjectURL

java.lang.String presignConstrainedObjectURL(java.lang.String bucketName,
                                             java.lang.String objectKey,
                                             long expiredTimeInSeconds)
                                      throws ClientException

Generates the signed url for 3rd parties accessing object

参数:

bucketName - bucket name

objectKey - Object key

expiredTimeInSeconds - URL's expiration time in seconds

返回:

抛出:

ClientException

presignPublicObjectURL

java.lang.String presignPublicObjectURL(java.lang.String bucketName,
                                        java.lang.String objectKey)

Generates the signed url for the public available object

参数:

bucketName - bucket name

objectKey - Object key

返回:

doesObjectExist

boolean doesObjectExist(java.lang.String bucketName,
                        java.lang.String objectKey)
                 throws ClientException,
                        ServiceException

Checks if the object exists in OSS

参数:

bucketName -

objectKey -

返回:

抛出:

ClientException

ServiceException

abortResumableUpload

void abortResumableUpload(ResumableUploadRequest request)
                   throws java.io.IOException

If the multipart upload is not aborted in a resumable upload, this API needs to be called to abort the underlying multipart upload.

参数:

request -

抛出:

java.io.IOException

asyncTriggerCallback

OSSAsyncTask<TriggerCallbackResult> asyncTriggerCallback(TriggerCallbackRequest request,
                                                         OSSCompletedCallback<TriggerCallbackRequest,TriggerCallbackResult> completedCallback)

triggerCallback

TriggerCallbackResult triggerCallback(TriggerCallbackRequest request)
                               throws ClientException,
                                      ServiceException

抛出:

ClientException

ServiceException

asyncImagePersist

OSSAsyncTask<ImagePersistResult> asyncImagePersist(ImagePersistRequest request,
                                                   OSSCompletedCallback<ImagePersistRequest,ImagePersistResult> completedCallback)

imagePersist

ImagePersistResult imagePersist(ImagePersistRequest request)
                         throws ClientException,
                                ServiceException

抛出:

ClientException

ServiceException

putSymlink

PutSymlinkResult putSymlink(PutSymlinkRequest request)
                     throws ClientException,
                            ServiceException

Synchronously creates a symbol link to a target file under the bucket---this is not supported for archive class bucket.

参数:

request - A PutSymlinkRequest instance that specifies the bucket name, symlink name.

返回:

An instance of PutSymlinkResult

抛出:

ClientException - OSS Client side exception.

ServiceException - OSS Server side exception.

asyncPutSymlink

OSSAsyncTask<PutSymlinkResult> asyncPutSymlink(PutSymlinkRequest request,
                                               OSSCompletedCallback<PutSymlinkRequest,PutSymlinkResult> completedCallback)

Asynchronously creates a symbol link to a target file under the bucket---this is not supported for archive class bucket.

参数:

request - A PutSymlinkRequest instance that specifies the bucket name, symlink name.

completedCallback - A OSSCompletedCallback instance that specifies callback functions

返回:

A OSSAsyncTask instance.

getSymlink

GetSymlinkResult getSymlink(GetSymlinkRequest request)
                     throws ClientException,
                            ServiceException

Synchronously gets the symlink information for the given symlink name.

参数:

request - A GetSymlinkRequest instance which specifies the bucket name and symlink name.

返回:

The symlink information, including the target file name and its metadata.

抛出:

ClientException - OSS Client side exception.

ServiceException - OSS Server side exception.

asyncGetSymlink

OSSAsyncTask<GetSymlinkResult> asyncGetSymlink(GetSymlinkRequest request,
                                               OSSCompletedCallback<GetSymlinkRequest,GetSymlinkResult> completedCallback)

Asynchronously gets the symlink information for the given symlink name.

参数:

request - A GetSymlinkRequest instance which specifies the bucket name and symlink name.

completedCallback - A OSSCompletedCallback instance that specifies callback functions

返回:

A OSSAsyncTask instance.

restoreObject

RestoreObjectResult restoreObject(RestoreObjectRequest request)
                           throws ClientException,
                                  ServiceException

Synchronously restores the object of archive storage. The function is not applicable to Normal or IA storage. The restoreObject() needs to be called prior to calling getObject() on an archive object.

参数:

request - A RestoreObjectRequest instance that specifies the bucket name and object key.

返回:

A RestoreObjectResult instance.

抛出:

ClientException

ServiceException

asyncRestoreObject

OSSAsyncTask<RestoreObjectResult> asyncRestoreObject(RestoreObjectRequest request,
                                                     OSSCompletedCallback<RestoreObjectRequest,RestoreObjectResult> completedCallback)

Asynchronously restores the object of archive storage. The function is not applicable to Normal or IA storage. The restoreObject() needs to be called prior to calling getObject() on an archive object.

参数:

request - A RestoreObjectRequest instance that specifies the bucket name and object key.

completedCallback - A OSSCompletedCallback instance that specifies callback functions

返回:

A OSSAsyncTask instance.

asyncResumableDownload

OSSAsyncTask<ResumableDownloadResult> asyncResumableDownload(ResumableDownloadRequest request,
                                                             OSSCompletedCallback<ResumableDownloadRequest,ResumableDownloadResult> completedCallback)

Asynchronously do a resumable download

参数:

request - A ResumableDownloadRequest instance that specifies the bucket name and object key.

completedCallback - A OSSCompletedCallback instance that specifies callback functions

返回:

A OSSAsyncTask instance.

syncResumableDownload

ResumableDownloadResult syncResumableDownload(ResumableDownloadRequest request)
                                       throws ClientException,
                                              ServiceException

Synchronously do a resumable download

参数:

request - A ResumableDownloadRequest instance that specifies the bucket name and object key.

抛出:

ClientException

ServiceException

putObjectTagging

PutObjectTaggingResult putObjectTagging(PutObjectTaggingRequest request)
                                 throws ClientException,
                                        ServiceException

You can call this operation to add tags to an object or update the tags added to the bucket. The object tagging feature uses a key-value pair to tag an object.

参数:

request - A PutObjectTaggingRequest instance which specifies the bucket name、 object key and tags.

返回:

A PutObjectTaggingResult instance.

抛出:

ClientException

ServiceException

asyncPutObjectTagging

OSSAsyncTask<PutObjectTaggingResult> asyncPutObjectTagging(PutObjectTaggingRequest request,
                                                           OSSCompletedCallback<PutObjectTaggingRequest,PutObjectTaggingResult> completedCallback)

You can call this operation to add tags to an object or update the tags added to the bucket. The object tagging feature uses a key-value pair to tag an object.

参数:

request - A PutObjectTaggingRequest instance which specifies the bucket name、 object key and tags.

completedCallback - A OSSCompletedCallback instance that specifies callback functions

返回:

A OSSAsyncTask instance.

getObjectTagging

GetObjectTaggingResult getObjectTagging(GetObjectTaggingRequest request)
                                 throws ClientException,
                                        ServiceException

You can call this operation to query the tags of an object.

参数:

request - A GetObjectTaggingRequest instance which specifies the bucket name and object key.

返回:

A GetObjectTaggingResult instance.

抛出:

ClientException

ServiceException

asyncGetObjectTagging

OSSAsyncTask<GetObjectTaggingResult> asyncGetObjectTagging(GetObjectTaggingRequest request,
                                                           OSSCompletedCallback<GetObjectTaggingRequest,GetObjectTaggingResult> completedCallback)

You can call this operation to query the tags of an object.

参数:

request - A GetObjectTaggingRequest instance that specifies the bucket name and object key.

completedCallback - A OSSCompletedCallback instance that specifies callback functions

返回:

A OSSAsyncTask instance.

deleteObjectTagging

DeleteObjectTaggingResult deleteObjectTagging(DeleteObjectTaggingRequest request)
                                       throws ClientException,
                                              ServiceException

You can call this operation to delete the tags of a specified object.

参数:

request - A DeleteObjectTaggingRequest instance which specifies the bucket name and object key.

返回:

A DeleteObjectTaggingResult instance.

抛出:

ClientException

ServiceException

asyncDeleteObjectTagging

OSSAsyncTask<DeleteObjectTaggingResult> asyncDeleteObjectTagging(DeleteObjectTaggingRequest request,
                                                                 OSSCompletedCallback<DeleteObjectTaggingRequest,DeleteObjectTaggingResult> completedCallback)

You can call this operation to delete the tags of a specified object.

参数:

request - A DeleteObjectTaggingRequest instance that specifies the bucket name and object key.

completedCallback - A OSSCompletedCallback instance that specifies callback functions

返回:

A OSSAsyncTask instance.