| 构造器和说明 |
|---|
OSSClient(String accessKeyId,
String accessKeySecret)
使用默认的OSS Endpoint构造一个新的
OSSClient对象。 |
OSSClient(String endpoint,
String accessKeyId,
String accessKeySecret)
使用指定的OSS Endpoint构造一个新的
OSSClient对象。 |
OSSClient(String endpoint,
String accessKeyId,
String accessKeySecret,
ClientConfiguration config)
使用指定的OSS Endpoint和配置构造一个新的
OSSClient对象。 |
public OSSClient(String accessKeyId, String accessKeySecret)
OSSClient对象。accessKeyId - 访问OSS的Access Key ID。accessKeySecret - 访问OSS的Access Key Secret。public OSSClient(String endpoint, String accessKeyId, String accessKeySecret)
OSSClient对象。endpoint - OSS服务的Endpoint。必须以"http://"开头。accessKeyId - 访问OSS的Access Key ID。accessKeySecret - 访问OSS的Access Key Secret。public OSSClient(String endpoint, String accessKeyId, String accessKeySecret, ClientConfiguration config)
OSSClient对象。endpoint - OSS服务的Endpoint。必须以"http://"开头。accessKeyId - 访问OSS的Access Key ID。accessKeySecret - 访问OSS的Access Key Secret。config - 客户端配置 ClientConfiguration。 如果为null则会使用默认配置。public URI getEndpoint()
public String getAccessKeyId()
public String getAccessKeySecret()
public Bucket createBucket(String bucketName) throws OSSException, ClientException
OSSBucket。createBucket 在接口中 OSSbucketName - Bucket名称。OSSExceptionClientExceptionpublic Bucket createBucket(CreateBucketRequest createBucketRequest)
OSSBucket。createBucket 在接口中 OSScreateBucketRequest - 请求参数CreateBucketRequest。public void deleteBucket(String bucketName) throws OSSException, ClientException
OSSBucket。deleteBucket 在接口中 OSSbucketName - Bucket名称。OSSExceptionClientExceptionpublic List<Bucket> listBuckets() throws OSSException, ClientException
OSSBucket的列表。listBuckets 在接口中 OSSBucket的列表。OSSExceptionClientExceptionpublic void setBucketAcl(String bucketName, CannedAccessControlList acl) throws OSSException, ClientException
OSSBucket的Access Control List(ACL)。setBucketAcl 在接口中 OSSbucketName - Bucket名称。acl - CannedAccessControlList中列出的ACL。
如果传入null,则表示使用默认值CannedAccessControlList.Private。OSSExceptionClientExceptionpublic AccessControlList getBucketAcl(String bucketName) throws OSSException, ClientException
OSSBucket的Access Control List(ACL)。getBucketAcl 在接口中 OSSbucketName - Bucket名称。AccessControlList。OSSExceptionClientExceptionpublic String getBucketLocation(String bucketName) throws OSSException, ClientException
OSSBucket所在的数据中心。getBucketLocation 在接口中 OSSbucketName - Bucket名称。OSSExceptionClientExceptionpublic boolean doesBucketExist(String bucketName) throws OSSException, ClientException
OSSBucket是否存在。doesBucketExist 在接口中 OSSbucketName - Bucket名称。OSSExceptionClientException@Deprecated public boolean isBucketExist(String bucketName) throws OSSException, ClientException
doesBucketExist(String)。bucketName - OSSExceptionClientExceptionpublic ObjectListing listObjects(String bucketName) throws OSSException, ClientException
OSSlistObjects 在接口中 OSSbucketName - Bucket名称。ObjectListingOSSExceptionClientExceptionpublic ObjectListing listObjects(String bucketName, String prefix) throws OSSException, ClientException
OSSlistObjects 在接口中 OSSbucketName - Bucket名称。prefix - 限定返回的Object key必须以prefix作为前缀。ObjectListingOSSExceptionClientExceptionpublic ObjectListing listObjects(ListObjectsRequest listObjectsRequest) throws OSSException, ClientException
OSSlistObjects 在接口中 OSSlistObjectsRequest - 请求信息。ObjectListingOSSExceptionClientExceptionpublic PutObjectResult putObject(String bucketName, String key, InputStream input, ObjectMetadata metadata) throws OSSException, ClientException
OSSputObject 在接口中 OSSbucketName - Bucket名称。key - object的key。input - 输入流。metadata - object的元信息ObjectMetadata。OSSExceptionClientExceptionpublic CopyObjectResult copyObject(String sourceBucketName, String sourceKey, String destinationBucketName, String destinationKey) throws OSSException, ClientException
OSScopyObject 在接口中 OSSsourceBucketName - 源Object所在的Bucket的名称。sourceKey - 源Object的Key。destinationBucketName - 目标Object所在的Bucket的名称。destinationKey - 目标Object的Key。CopyObjectResult实例。OSSExceptionClientExceptionpublic CopyObjectResult copyObject(CopyObjectRequest copyObjectRequest) throws OSSException, ClientException
OSScopyObject 在接口中 OSScopyObjectRequest - 请求参数CopyObjectRequest实例。OSSExceptionClientExceptionpublic OSSObject getObject(String bucketName, String key) throws OSSException, ClientException
OSSgetObject 在接口中 OSSbucketName - Bucket名称。key - Object Key。OSSObject实例。使用完之后需要手动关闭其中的ObjectContent释放请求连接。OSSExceptionClientExceptionpublic ObjectMetadata getObject(GetObjectRequest getObjectRequest, File file) throws OSSException, ClientException
OSSgetObject 在接口中 OSSgetObjectRequest - 请求参数GetObjectRequest。file - 目标文件。OSSExceptionClientExceptionpublic OSSObject getObject(GetObjectRequest getObjectRequest) throws OSSException, ClientException
OSSgetObject 在接口中 OSSgetObjectRequest - 请求参数GetObjectRequest。OSSObject实例。使用完之后需要手动关闭其中的ObjectContent释放请求连接。OSSExceptionClientExceptionpublic ObjectMetadata getObjectMetadata(String bucketName, String key) throws OSSException, ClientException
OSSOSSObject的元数据。getObjectMetadata 在接口中 OSSbucketName - Bucket名称。key - Object key。OSSExceptionClientExceptionpublic void deleteObject(String bucketName, String key) throws OSSException, ClientException
OSSOSSObject。deleteObject 在接口中 OSSbucketName - Bucket名称。key - Object key。OSSExceptionClientExceptionpublic URL generatePresignedUrl(String bucketName, String key, Date expiration) throws ClientException
OSSOSSObject的URL。generatePresignedUrl 在接口中 OSSbucketName - Bucket名称。key - Object key。expiration - URL的超时时间。OSSObject的URL。ClientExceptionpublic URL generatePresignedUrl(String bucketName, String key, Date expiration, HttpMethod method) throws ClientException
OSSOSSObject的URL。generatePresignedUrl 在接口中 OSSbucketName - Bucket名称。key - Object Key。expiration - URL的超时时间。method - HTTP方法,只支持HttpMethod.GET和HttpMethod.PUT。OSSObject的URL。ClientExceptionpublic URL generatePresignedUrl(GeneratePresignedUrlRequest request) throws ClientException
OSSOSSObject的URL。generatePresignedUrl 在接口中 OSSrequest - GeneratePresignedUrlRequest对象。OSSObject的URL。ClientExceptionpublic void abortMultipartUpload(AbortMultipartUploadRequest request) throws OSSException, ClientException
OSSabortMultipartUpload 在接口中 OSSrequest - AbortMultipartUploadRequest对象。ClientExceptionOSSExceptionpublic CompleteMultipartUploadResult completeMultipartUpload(CompleteMultipartUploadRequest request) throws OSSException, ClientException
OSS在将所有数据Part 都上传完成后,可以调用 Complete Multipart Upload API 来完成整个文件的 Multipart Upload。在执行该操作时,用户必须提供所有有效 的数据Part的列表(包括part号码和ETAG); OSS收到用户提交的Part列表后, 会逐一验证每个数据 Part 的有效性。当所有的数据 Part 验证通过后,OSS 将把 这些数据part组合成一个完整的 Object。
此方法对应的操作为非幂等操作,SDK不会对其进行重试(即使设置最大重试次数大于0也不会重试)
completeMultipartUpload 在接口中 OSSrequest - CompleteMultipartUploadRequest对象。ClientExceptionOSSExceptionpublic InitiateMultipartUploadResult initiateMultipartUpload(InitiateMultipartUploadRequest request) throws OSSException, ClientException
OSS使用Multipart模式上传数据前,必须先调用该接口来通过OSS初始化一个Multipart上传事件。 该接口会返回一个OSS服务器创建的全局唯一的Upload ID,用于标识本次Multipart上传事件。 用户可以根据这个ID来发起相关的操作,如中止、查询Multipart上传等。
此方法对应的操作为非幂等操作,SDK不会对其进行重试(即使设置最大重试次数大于0也不会重试)
initiateMultipartUpload 在接口中 OSSrequest - InitiateMultipartUploadRequest对象。ClientExceptionOSSExceptionpublic MultipartUploadListing listMultipartUploads(ListMultipartUploadsRequest request) throws OSSException, ClientException
OSS即已经被初始化的 Multipart Upload 但是未被完成或被终止的 Multipart上传事件。 OSS返回的罗列结果中最多会包含1000个Multipart上传事件。
listMultipartUploads 在接口中 OSSrequest - ListMultipartUploadsRequest对象。MultipartUploadListing。ClientExceptionOSSExceptionpublic PartListing listParts(ListPartsRequest request) throws OSSException, ClientException
OSSlistParts 在接口中 OSSrequest - ListPartsRequest对象。ClientExceptionOSSExceptionpublic UploadPartResult uploadPart(UploadPartRequest request) throws OSSException, ClientException
OSSuploadPart 在接口中 OSSrequest - UploadPartRequest对象。UploadPartResult。ClientExceptionOSSExceptionpublic UploadPartCopyResult uploadPartCopy(UploadPartCopyRequest request) throws OSSException, ClientException
uploadPartCopy 在接口中 OSSOSSExceptionClientExceptionpublic void setBucketCORS(SetBucketCORSRequest request) throws OSSException, ClientException
OSSsetBucketCORS 在接口中 OSSrequest - SetBucketCORSRequest}OSSExceptionClientExceptionpublic List<SetBucketCORSRequest.CORSRule> getBucketCORSRules(String bucketName) throws OSSException, ClientException
OSSgetBucketCORSRules 在接口中 OSSOSSExceptionClientExceptionpublic void deleteBucketCORSRules(String bucketName) throws OSSException, ClientException
OSSdeleteBucketCORSRules 在接口中 OSSOSSExceptionClientExceptionpublic ResponseMessage optionsObject(OptionsRequest request) throws OSSException, ClientException
OSSoptionsObject 在接口中 OSSOSSExceptionClientExceptionpublic void setBucketLogging(SetBucketLoggingRequest request) throws OSSException, ClientException
setBucketLogging 在接口中 OSSOSSExceptionClientExceptionpublic BucketLoggingResult getBucketLogging(String bucketName)
OSSBucket的访问日志配置。getBucketLogging 在接口中 OSSpublic void deleteBucketLogging(String bucketName) throws OSSException, ClientException
OSSBucket的访问日志记录功能。deleteBucketLogging 在接口中 OSSOSSExceptionClientExceptionpublic void setBucketWebsite(SetBucketWebsiteRequest setBucketWebSiteRequest) throws OSSException, ClientException
OSSBucket设置成静态网站托管模式。setBucketWebsite 在接口中 OSSOSSExceptionClientExceptionpublic BucketWebsiteResult getBucketWebsite(String bucketName) throws OSSException, ClientException
OSSBucket的静态网站托管状态。getBucketWebsite 在接口中 OSSOSSExceptionClientExceptionpublic void deleteBucketWebsite(String bucketName) throws OSSException, ClientException
OSSBucket的静态网站托管模式。deleteBucketWebsite 在接口中 OSSOSSExceptionClientExceptionCopyright © 2014. All Rights Reserved.