OSSClient (Aliyun OSS SDK for Java 2.0.4 API)

java.lang.Object
- com.aliyun.oss.OSSClient

所有已实现的接口:

OSS
```
public class OSSClient
extends Object
implements OSS
```
访问阿里云开放存储服务（Open Storage Service， OSS）的入口类。

构造器概要

构造器
构造器和说明
`OSSClient(String endpoint, CredentialsProvider credsProvider)` 使用默认配置及指定的`CredentialsProvider`与Endpoint构造一个新的`OSSClient`对象。
`OSSClient(String endpoint, CredentialsProvider credsProvider, ClientConfiguration config)` 使用指定的`CredentialsProvider`、配置及Endpoint构造一个新的`OSSClient`对象。
`OSSClient(String accessKeyId, String secretAccessKey)` 已过时。
`OSSClient(String endpoint, String accessKeyId, String secretAccessKey)` 使用指定的OSS Endpoint、阿里云颁发的Access Id/Access Key构造一个新的`OSSClient`对象。
`OSSClient(String endpoint, String accessKeyId, String secretAccessKey, ClientConfiguration config)` 使用指定的OSS Endpoint、阿里云颁发的Access Id/Access Key、客户端配置构造一个新的`OSSClient`对象。
`OSSClient(String endpoint, String accessKeyId, String secretAccessKey, String securityToken)` 使用指定的OSS Endpoint、STS提供的临时Token信息(Access Id/Access Key/Security Token) 构造一个新的`OSSClient`对象。
`OSSClient(String endpoint, String accessKeyId, String secretAccessKey, String securityToken, ClientConfiguration config)` 使用指定的OSS Endpoint、STS提供的临时Token信息(Access Id/Access Key/Security Token)、客户端配置构造一个新的`OSSClient`对象。

方法概要

方法
限定符和类型	方法和说明
`void`	`abortMultipartUpload(AbortMultipartUploadRequest request)` 终止一个Multipart上传事件。
`String`	`calculatePostSignature(String postPolicy)` 根据Access Key Secret和policy计算签名，OSS依据该签名验证Post请求的合法性。
`CompleteMultipartUploadResult`	`completeMultipartUpload(CompleteMultipartUploadRequest request)` 完成一个Multipart上传事件。
`CopyObjectResult`	`copyObject(CopyObjectRequest copyObjectRequest)` 拷贝一个在OSS上已经存在的Object成另外一个Object。
`CopyObjectResult`	`copyObject(String sourceBucketName, String sourceKey, String destinationBucketName, String destinationKey)` 拷贝一个在OSS上已经存在的Object成另外一个Object。
`Bucket`	`createBucket(CreateBucketRequest createBucketRequest)` 创建`Bucket`。
`Bucket`	`createBucket(String bucketName)` 创建`Bucket`。
`void`	`deleteBucket(String bucketName)` 删除`Bucket`。
`void`	`deleteBucketCORSRules(String bucketName)` 删除指定bucket下面的所有跨域访问规则
`void`	`deleteBucketLifecycle(String bucketName)` 关闭`Bucket`的Lifecycle规则。
`void`	`deleteBucketLogging(String bucketName)` 关闭`Bucket`的访问日志记录功能。
`void`	`deleteBucketWebsite(String bucketName)` 关闭`Bucket`的静态网站托管模式。
`void`	`deleteObject(String bucketName, String key)` 删除指定的`OSSObject`。
`DeleteObjectsResult`	`deleteObjects(DeleteObjectsRequest deleteObjectsRequest)` 批量删除指定Bucket下的`OSSObject`。
`boolean`	`doesBucketExist(String bucketName)` 判断给定`Bucket`是否存在。
`boolean`	`doesObjectExist(HeadObjectRequest headObjectRequest)` 判断指定的`OSSObject`是否存在。
`boolean`	`doesObjectExist(String bucketName, String key)` 判断指定`Bucket`下是否存在指定的`OSSObject`。
`String`	`generatePostPolicy(Date expiration, PolicyConditions conds)` 生成Post请求的policy表单域。
`URL`	`generatePresignedUrl(GeneratePresignedUrlRequest request)` 生成一个包含签名信息并可以访问`OSSObject`的URL。
`URL`	`generatePresignedUrl(String bucketName, String key, Date expiration)` 生成一个用HTTP GET方法访问`OSSObject`的URL。
`URL`	`generatePresignedUrl(String bucketName, String key, Date expiration, HttpMethod method)` 生成一个用指定HTTP方法访问`OSSObject`的URL。
`AccessControlList`	`getBucketAcl(String bucketName)` 返回给定`Bucket`的Access Control List(ACL)。
`List<SetBucketCORSRequest.CORSRule>`	`getBucketCORSRules(String bucketName)` 列出指定bucket的跨域访问规则
`List<LifecycleRule>`	`getBucketLifecycle(String bucketName)` 获取`Bucket`的Lifecycle规则列表。
`String`	`getBucketLocation(String bucketName)` 返回给定`Bucket`所在的数据中心。
`BucketLoggingResult`	`getBucketLogging(String bucketName)` 查看`Bucket`的访问日志配置。
`BucketReferer`	`getBucketReferer(String bucketName)` 返回给定`Bucket`的http referer。
`BucketWebsiteResult`	`getBucketWebsite(String bucketName)` 获取`Bucket`的静态网站托管状态。
`CredentialsProvider`	`getCredentialsProvider()`
`URI`	`getEndpoint()` 获取OSS services的Endpoint。
`OSSObject`	`getObject(GetObjectRequest getObjectRequest)` 从OSS指定的`Bucket`中导出`OSSObject`。
`ObjectMetadata`	`getObject(GetObjectRequest getObjectRequest, File file)` 从OSS指定的`Bucket`中导出指定的`OSSObject`到目标文件。
`OSSObject`	`getObject(String bucketName, String key)` 从OSS指定的`Bucket`中导出`OSSObject`。
`OSSObject`	`getObject(URL signedUrl, Map<String,String> requestHeaders)` 使用URL签名方式导出`OSSObject`。
`ObjectMetadata`	`getObjectMetadata(String bucketName, String key)` 返回`OSSObject`的元数据。
`InitiateMultipartUploadResult`	`initiateMultipartUpload(InitiateMultipartUploadRequest request)` 初始化一个Multipart上传事件。
`boolean`	`isBucketExist(String bucketName)` 已过时。
`List<Bucket>`	`listBuckets()` 返回请求者拥有的所有`Bucket`的列表。
`BucketList`	`listBuckets(ListBucketsRequest listBucketsRequest)` 按要求返回请求者的`Bucket`列表。
`BucketList`	`listBuckets(String prefix, String marker, Integer maxKeys)` 按要求返回请求者的`Bucket`列表。
`MultipartUploadListing`	`listMultipartUploads(ListMultipartUploadsRequest request)` 列出所有执行中的 Multipart上传事件。
`ObjectListing`	`listObjects(ListObjectsRequest listObjectsRequest)` 列出指定`Bucket`下的`OSSObject`。
`ObjectListing`	`listObjects(String bucketName)` 列出指定`Bucket`下的`OSSObject`。
`ObjectListing`	`listObjects(String bucketName, String prefix)` 列出指定`Bucket`下key以给定prefix开头的`OSSObject`。
`PartListing`	`listParts(ListPartsRequest request)` 列出multipart中上传的所有part信息
`ResponseMessage`	`optionsObject(OptionsRequest request)` 已过时。
`PutObjectResult`	`putObject(PutObjectRequest putObjectRequest)` 上传指定文件或输入流至指定的`Bucket`。
`PutObjectResult`	`putObject(String bucketName, String key, File file)` 上传指定文件到OSS中指定的`Bucket`。
`PutObjectResult`	`putObject(String bucketName, String key, InputStream input, ObjectMetadata metadata)` 上传指定的`OSSObject`到OSS中指定的`Bucket`。
`PutObjectResult`	`putObject(URL signedUrl, InputStream requestContent, long contentLength, Map<String,String> requestHeaders)` 使用URL签名方式上传指定输入流。
`PutObjectResult`	`putObject(URL signedUrl, InputStream requestContent, long contentLength, Map<String,String> requestHeaders, boolean useChunkEncoding)` 使用URL签名方式上传指定输入流。
`PutObjectResult`	`putObject(URL signedUrl, String filePath, Map<String,String> requestHeaders)` 使用URL签名方式上传指定文件。
`PutObjectResult`	`putObject(URL signedUrl, String filePath, Map<String,String> requestHeaders, boolean useChunkEncoding)` 使用URL签名方式上传指定文件。
`void`	`setBucketAcl(String bucketName, CannedAccessControlList acl)` 设置指定`Bucket`的Access Control List(ACL)。
`void`	`setBucketCORS(SetBucketCORSRequest request)` 操作将在指定的bucket上设定一个跨域资源共享(CORS)的规则，如果原规则存在则覆盖原规则
`void`	`setBucketLifecycle(SetBucketLifecycleRequest setBucketLifecycleRequest)` 设置`Bucket`的Lifecycle规则。
`void`	`setBucketLogging(SetBucketLoggingRequest request)`
`void`	`setBucketReferer(String bucketName, BucketReferer referer)` 设置指定`Bucket`的http referer。
`void`	`setBucketWebsite(SetBucketWebsiteRequest setBucketWebSiteRequest)` 将一个`Bucket`设置成静态网站托管模式。
`void`	`setEndpoint(String endpoint)` 设置OSS services的Endpoint。
`void`	`shutdown()` 关闭Client实例，并释放所有正在使用的资源。
`void`	`switchCredentials(Credentials creds)` 切换用户身份认证。
`UploadPartResult`	`uploadPart(UploadPartRequest request)` 上传一个分块（Part）到指定的的Multipart上传事件中。
`UploadPartCopyResult`	`uploadPartCopy(UploadPartCopyRequest request)` 分片拷贝。

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - OSSClient
```
@Deprecated
public OSSClient(String accessKeyId,
                    String secretAccessKey)
```
    已过时。
    
    使用默认的OSS Endpoint(http://oss-cn-hangzhou.aliyuncs.com)及阿里云颁发的Access Id/Access Key构造一个新的OSSClient对象。
    
    参数:
    accessKeyId - 访问OSS的Access Key ID。
    secretAccessKey - 访问OSS的Secret Access Key。
  - OSSClient
```
public OSSClient(String endpoint,
         String accessKeyId,
         String secretAccessKey)
```
    使用指定的OSS Endpoint、阿里云颁发的Access Id/Access Key构造一个新的OSSClient对象。
    
    参数:
    endpoint - OSS服务的Endpoint。
    accessKeyId - 访问OSS的Access Key ID。
    secretAccessKey - 访问OSS的Secret Access Key。
  - OSSClient
```
public OSSClient(String endpoint,
         String accessKeyId,
         String secretAccessKey,
         String securityToken)
```
    使用指定的OSS Endpoint、STS提供的临时Token信息(Access Id/Access Key/Security Token) 构造一个新的OSSClient对象。
    
    参数:
    endpoint - OSS服务的Endpoint。
    accessKeyId - STS提供的临时访问ID。
    secretAccessKey - STS提供的访问密钥。
    securityToken - STS提供的安全令牌。
  - OSSClient
```
public OSSClient(String endpoint,
         String accessKeyId,
         String secretAccessKey,
         ClientConfiguration config)
```
    使用指定的OSS Endpoint、阿里云颁发的Access Id/Access Key、客户端配置构造一个新的OSSClient对象。
    
    参数:
    endpoint - OSS服务的Endpoint。
    accessKeyId - 访问OSS的Access Key ID。
    secretAccessKey - 访问OSS的Secret Access Key。
    config - 客户端配置 ClientConfiguration。如果为null则会使用默认配置。
  - OSSClient
```
public OSSClient(String endpoint,
         String accessKeyId,
         String secretAccessKey,
         String securityToken,
         ClientConfiguration config)
```
    使用指定的OSS Endpoint、STS提供的临时Token信息(Access Id/Access Key/Security Token)、客户端配置构造一个新的OSSClient对象。
    
    参数:
    endpoint - OSS服务的Endpoint。
    accessKeyId - STS提供的临时访问ID。
    secretAccessKey - STS提供的访问密钥。
    securityToken - STS提供的安全令牌。
    config - 客户端配置 ClientConfiguration。如果为null则会使用默认配置。
  - OSSClient
```
public OSSClient(String endpoint,
         CredentialsProvider credsProvider)
```
    使用默认配置及指定的CredentialsProvider与Endpoint构造一个新的OSSClient对象。
    
    参数:
    endpoint - OSS services的Endpoint。
    credsProvider - Credentials提供者。
  - OSSClient
```
public OSSClient(String endpoint,
         CredentialsProvider credsProvider,
         ClientConfiguration config)
```
    使用指定的CredentialsProvider、配置及Endpoint构造一个新的OSSClient对象。
    
    参数:
    endpoint - OSS services的Endpoint。
    credsProvider - Credentials提供者。
    config - client配置。
- 方法详细资料
  - getEndpoint
```
public URI getEndpoint()
```
    获取OSS services的Endpoint。
    
    返回:
    OSS services的Endpoint。
  - setEndpoint
```
public void setEndpoint(String endpoint)
```
    设置OSS services的Endpoint。
    
    参数:
    endpoint - OSS services的Endpoint。
  - switchCredentials
```
public void switchCredentials(Credentials creds)
```
    从接口复制的说明: OSS
    
    切换用户身份认证。
    
    指定者:
    
    switchCredentials 在接口中 OSS
    
    参数:
    creds - 用户身份认证。
  - getCredentialsProvider
```
public CredentialsProvider getCredentialsProvider()
```
  - createBucket
```
public Bucket createBucket(String bucketName)
                    throws OSSException,
                           ClientException
```
    从接口复制的说明: OSS
    
    创建Bucket。
    
    指定者:
    
    createBucket 在接口中 OSS
    
    参数:
    bucketName - Bucket名称。
    
    抛出:
    
    OSSException
    
    ClientException
  - createBucket
```
public Bucket createBucket(CreateBucketRequest createBucketRequest)
                    throws OSSException,
                           ClientException
```
    从接口复制的说明: OSS
    
    创建Bucket。
    
    指定者:
    
    createBucket 在接口中 OSS
    
    参数:
    createBucketRequest - 请求参数CreateBucketRequest。
    
    抛出:
    
    OSSException
    
    ClientException
  - deleteBucket
```
public void deleteBucket(String bucketName)
                  throws OSSException,
                         ClientException
```
    从接口复制的说明: OSS
    
    删除Bucket。
    
    指定者:
    
    deleteBucket 在接口中 OSS
    
    参数:
    bucketName - Bucket名称。
    
    抛出:
    
    OSSException
    
    ClientException
  - listBuckets
```
public List<Bucket> listBuckets()
                         throws OSSException,
                                ClientException
```
    从接口复制的说明: OSS
    
    返回请求者拥有的所有Bucket的列表。
    
    指定者:
    
    listBuckets 在接口中 OSS
    
    返回:
    请求者拥有的所有Bucket的列表。
    
    抛出:
    
    OSSException
    
    ClientException
  - listBuckets
```
public BucketList listBuckets(ListBucketsRequest listBucketsRequest)
                       throws OSSException,
                              ClientException
```
    从接口复制的说明: OSS
    
    按要求返回请求者的Bucket列表。
    
    指定者:
    
    listBuckets 在接口中 OSS
    
    参数:
    listBucketsRequest - 请求信息
    
    返回:
    该次请求获得的所有Bucket的列表。
    
    抛出:
    
    OSSException
    
    ClientException
  - listBuckets
```
public BucketList listBuckets(String prefix,
                     String marker,
                     Integer maxKeys)
                       throws OSSException,
                              ClientException
```
    从接口复制的说明: OSS
    
    按要求返回请求者的Bucket列表。
    
    指定者:
    
    listBuckets 在接口中 OSS
    
    参数:
    prefix - 限定返回的bucket的名字必须以prefix作为前缀，可以为null（表示不设置前缀）
    marker - 设定结果从marker之后按字母排序的第一个开始返回，可以为null（表示没有marker的点，从头开始返回）
    maxKeys - 限定此次返回bucket的最大数，取值不能大于1000，默认为100，可以为null（表示默认返回最多100个）
    
    返回:
    该次请求获得的所有Bucket的列表。
    
    抛出:
    
    OSSException
    
    ClientException
  - setBucketAcl
```
public void setBucketAcl(String bucketName,
                CannedAccessControlList acl)
                  throws OSSException,
                         ClientException
```
    从接口复制的说明: OSS
    
    设置指定Bucket的Access Control List(ACL)。
    
    指定者:
    
    setBucketAcl 在接口中 OSS
    
    参数:
    bucketName - Bucket名称。
    acl - CannedAccessControlList中列出的ACL。如果传入null，则表示使用默认值CannedAccessControlList.Private。
    
    抛出:
    
    OSSException
    
    ClientException
  - getBucketAcl
```
public AccessControlList getBucketAcl(String bucketName)
                               throws OSSException,
                                      ClientException
```
    从接口复制的说明: OSS
    
    返回给定Bucket的Access Control List(ACL)。
    
    指定者:
    
    getBucketAcl 在接口中 OSS
    
    参数:
    bucketName - Bucket名称。
    
    返回:
    Access Control List(ACL) AccessControlList。
    
    抛出:
    
    OSSException
    
    ClientException
  - setBucketReferer
```
public void setBucketReferer(String bucketName,
                    BucketReferer referer)
                      throws OSSException,
                             ClientException
```
    从接口复制的说明: OSS
    
    设置指定Bucket的http referer。
    
    指定者:
    
    setBucketReferer 在接口中 OSS
    
    参数:
    bucketName - Bucket名称。
    referer - BucketReferer。如果传入null，则表示使用默认值BucketReferer。
    
    抛出:
    
    OSSException
    
    ClientException
  - getBucketReferer
```
public BucketReferer getBucketReferer(String bucketName)
                               throws OSSException,
                                      ClientException
```
    从接口复制的说明: OSS
    
    返回给定Bucket的http referer。
    
    指定者:
    
    getBucketReferer 在接口中 OSS
    
    参数:
    bucketName - Bucket名称。
    
    返回:
    bucket http referer BucketReferer。
    
    抛出:
    
    OSSException
    
    ClientException
  - getBucketLocation
```
public String getBucketLocation(String bucketName)
                         throws OSSException,
                                ClientException
```
    从接口复制的说明: OSS
    
    返回给定Bucket所在的数据中心。
    
    指定者:
    
    getBucketLocation 在接口中 OSS
    
    参数:
    bucketName - Bucket名称。
    
    返回:
    Bucket所在的数据中心。
    
    抛出:
    
    OSSException
    
    ClientException
  - doesBucketExist
```
public boolean doesBucketExist(String bucketName)
                        throws OSSException,
                               ClientException
```
    从接口复制的说明: OSS
    
    判断给定Bucket是否存在。
    
    指定者:
    
    doesBucketExist 在接口中 OSS
    
    参数:
    bucketName - Bucket名称。
    
    抛出:
    
    OSSException
    
    ClientException
  - isBucketExist
```
@Deprecated
public boolean isBucketExist(String bucketName)
                      throws OSSException,
                             ClientException
```
    已过时。
    
    已过时。请使用doesBucketExist(String)。
    
    抛出:
    
    OSSException
    
    ClientException
  - listObjects
```
public ObjectListing listObjects(String bucketName)
                          throws OSSException,
                                 ClientException
```
    从接口复制的说明: OSS
    
    列出指定Bucket下的OSSObject。
    
    指定者:
    
    listObjects 在接口中 OSS
    
    参数:
    bucketName - Bucket名称。
    
    返回:
    Object列表ObjectListing
    
    抛出:
    
    OSSException
    
    ClientException
  - listObjects
```
public ObjectListing listObjects(String bucketName,
                        String prefix)
                          throws OSSException,
                                 ClientException
```
    从接口复制的说明: OSS
    
    列出指定Bucket下key以给定prefix开头的OSSObject。
    
    指定者:
    
    listObjects 在接口中 OSS
    
    参数:
    bucketName - Bucket名称。
    prefix - 限定返回的Object key必须以prefix作为前缀。
    
    返回:
    Object列表ObjectListing
    
    抛出:
    
    OSSException
    
    ClientException
  - listObjects
```
public ObjectListing listObjects(ListObjectsRequest listObjectsRequest)
                          throws OSSException,
                                 ClientException
```
    从接口复制的说明: OSS
    
    列出指定Bucket下的OSSObject。
    
    指定者:
    
    listObjects 在接口中 OSS
    
    参数:
    listObjectsRequest - 请求信息。
    
    返回:
    object列表ObjectListing
    
    抛出:
    
    OSSException
    
    ClientException
  - putObject
```
public PutObjectResult putObject(String bucketName,
                        String key,
                        InputStream input,
                        ObjectMetadata metadata)
                          throws OSSException,
                                 ClientException
```
    从接口复制的说明: OSS
    
    上传指定的OSSObject到OSS中指定的Bucket。
    
    指定者:
    
    putObject 在接口中 OSS
    
    参数:
    bucketName - Bucket名称。
    key - object的key。
    input - 输入流。
    metadata - object的元信息ObjectMetadata，若该元信息未包含Content-Length，则采用chunked编码传输请求数据。
    
    抛出:
    
    OSSException
    
    ClientException
  - putObject
```
public PutObjectResult putObject(String bucketName,
                        String key,
                        File file)
                          throws OSSException,
                                 ClientException
```
    从接口复制的说明: OSS
    
    上传指定文件到OSS中指定的Bucket。
    
    指定者:
    
    putObject 在接口中 OSS
    
    参数:
    bucketName - Bucket名称。
    key - object的key。
    file - 指定上传文件。
    
    抛出:
    
    OSSException
    
    ClientException
  - putObject
```
public PutObjectResult putObject(PutObjectRequest putObjectRequest)
                          throws OSSException,
                                 ClientException
```
    从接口复制的说明: OSS
    
    上传指定文件或输入流至指定的Bucket。
    
    指定者:
    
    putObject 在接口中 OSS
    
    参数:
    putObjectRequest - 请求参数PutObjectRequest。
    
    返回:
    请求结果PutObjectResult实例。
    
    抛出:
    
    OSSException
    
    ClientException
  - putObject
```
public PutObjectResult putObject(URL signedUrl,
                        String filePath,
                        Map<String,String> requestHeaders)
                          throws OSSException,
                                 ClientException
```
    从接口复制的说明: OSS
    
    使用URL签名方式上传指定文件。
    
    指定者:
    
    putObject 在接口中 OSS
    
    参数:
    signedUrl - PUT请求类型的URL签名。
    filePath - 上传文件的路径。
    requestHeaders - 请求头（包括HTTP标准请求头、用户自定义请求头）。
    
    返回:
    请求结果PutObjectResult实例。
    
    抛出:
    
    OSSException
    
    ClientException
  - putObject
```
public PutObjectResult putObject(URL signedUrl,
                        String filePath,
                        Map<String,String> requestHeaders,
                        boolean useChunkEncoding)
                          throws OSSException,
                                 ClientException
```
    从接口复制的说明: OSS
    
    使用URL签名方式上传指定文件。
    
    指定者:
    
    putObject 在接口中 OSS
    
    参数:
    signedUrl - PUT请求类型的URL签名。
    filePath - 上传文件的路径。
    requestHeaders - 请求头（包括HTTP标准请求头、用户自定义请求头）。
    useChunkEncoding - 是否采用chunked编码传输请求数据。
    
    返回:
    请求结果PutObjectResult实例。
    
    抛出:
    
    OSSException
    
    ClientException
  - putObject
```
public PutObjectResult putObject(URL signedUrl,
                        InputStream requestContent,
                        long contentLength,
                        Map<String,String> requestHeaders)
                          throws OSSException,
                                 ClientException
```
    从接口复制的说明: OSS
    
    使用URL签名方式上传指定输入流。
    
    指定者:
    
    putObject 在接口中 OSS
    
    参数:
    signedUrl - PUT请求类型的URL签名。
    requestContent - 请求输入流。
    contentLength - 请求输入流的长度。
    requestHeaders - 请求头（包括HTTP标准请求头、用户自定义请求头）。
    
    返回:
    请求结果PutObjectResult实例。
    
    抛出:
    
    OSSException
    
    ClientException
  - putObject
```
public PutObjectResult putObject(URL signedUrl,
                        InputStream requestContent,
                        long contentLength,
                        Map<String,String> requestHeaders,
                        boolean useChunkEncoding)
                          throws OSSException,
                                 ClientException
```
    从接口复制的说明: OSS
    
    使用URL签名方式上传指定输入流。
    
    指定者:
    
    putObject 在接口中 OSS
    
    参数:
    signedUrl - PUT请求类型的URL签名。
    requestContent - 请求输入流。
    contentLength - 请求输入流的长度，如果采用chunked编码则设置为-1。
    requestHeaders - 请求头（包括HTTP标准请求头、用户自定义请求头）。
    useChunkEncoding - 是否采用chunked编码传输请求数据。
    
    返回:
    请求结果PutObjectResult实例。
    
    抛出:
    
    OSSException
    
    ClientException
  - copyObject
```
public CopyObjectResult copyObject(String sourceBucketName,
                          String sourceKey,
                          String destinationBucketName,
                          String destinationKey)
                            throws OSSException,
                                   ClientException
```
    从接口复制的说明: OSS
    
    拷贝一个在OSS上已经存在的Object成另外一个Object。
    
    指定者:
    
    copyObject 在接口中 OSS
    
    参数:
    sourceBucketName - 源Object所在的Bucket的名称。
    sourceKey - 源Object的Key。
    destinationBucketName - 目标Object所在的Bucket的名称。
    destinationKey - 目标Object的Key。
    
    返回:
    请求结果CopyObjectResult实例。
    
    抛出:
    
    OSSException
    
    ClientException
  - copyObject
```
public CopyObjectResult copyObject(CopyObjectRequest copyObjectRequest)
                            throws OSSException,
                                   ClientException
```
    从接口复制的说明: OSS
    
    拷贝一个在OSS上已经存在的Object成另外一个Object。
    
    指定者:
    
    copyObject 在接口中 OSS
    
    参数:
    copyObjectRequest - 请求参数CopyObjectRequest实例。
    
    返回:
    
    抛出:
    
    OSSException
    
    ClientException
  - getObject
```
public OSSObject getObject(String bucketName,
                  String key)
                    throws OSSException,
                           ClientException
```
    从接口复制的说明: OSS
    
    从OSS指定的Bucket中导出OSSObject。
    
    指定者:
    
    getObject 在接口中 OSS
    
    参数:
    bucketName - Bucket名称。
    key - Object Key。
    
    返回:
    请求结果OSSObject实例。使用完之后需要手动关闭其中的ObjectContent释放请求连接。
    
    抛出:
    
    OSSException
    
    ClientException
  - getObject
```
public ObjectMetadata getObject(GetObjectRequest getObjectRequest,
                       File file)
                         throws OSSException,
                                ClientException
```
    从接口复制的说明: OSS
    
    从OSS指定的Bucket中导出指定的OSSObject到目标文件。
    
    指定者:
    
    getObject 在接口中 OSS
    
    参数:
    getObjectRequest - 请求参数GetObjectRequest。
    file - 目标文件。
    
    抛出:
    
    OSSException
    
    ClientException
  - getObject
```
public OSSObject getObject(GetObjectRequest getObjectRequest)
                    throws OSSException,
                           ClientException
```
    从接口复制的说明: OSS
    
    从OSS指定的Bucket中导出OSSObject。
    
    指定者:
    
    getObject 在接口中 OSS
    
    参数:
    getObjectRequest - 请求参数GetObjectRequest。
    
    返回:
    请求结果OSSObject实例。使用完之后需要手动关闭其中的ObjectContent释放请求连接。
    
    抛出:
    
    OSSException
    
    ClientException
  - getObject
```
public OSSObject getObject(URL signedUrl,
                  Map<String,String> requestHeaders)
                    throws OSSException,
                           ClientException
```
    从接口复制的说明: OSS
    
    使用URL签名方式导出OSSObject。
    
    指定者:
    
    getObject 在接口中 OSS
    
    参数:
    signedUrl - GET请求类型的URL签名。
    requestHeaders - 请求头（包括HTTP标准请求头、用户自定义请求头）。
    
    返回:
    请求结果OSSObject实例。使用完之后需要手动关闭其中的ObjectContent释放请求连接。
    
    抛出:
    
    OSSException
    
    ClientException
  - getObjectMetadata
```
public ObjectMetadata getObjectMetadata(String bucketName,
                               String key)
                                 throws OSSException,
                                        ClientException
```
    从接口复制的说明: OSS
    
    返回OSSObject的元数据。
    
    指定者:
    
    getObjectMetadata 在接口中 OSS
    
    参数:
    bucketName - Bucket名称。
    key - Object key。
    
    抛出:
    
    OSSException
    
    ClientException
  - deleteObject
```
public void deleteObject(String bucketName,
                String key)
                  throws OSSException,
                         ClientException
```
    从接口复制的说明: OSS
    
    删除指定的OSSObject。
    
    指定者:
    
    deleteObject 在接口中 OSS
    
    参数:
    bucketName - Bucket名称。
    key - Object key。
    
    抛出:
    
    OSSException
    
    ClientException
  - deleteObjects
```
public DeleteObjectsResult deleteObjects(DeleteObjectsRequest deleteObjectsRequest)
                                  throws OSSException,
                                         ClientException
```
    从接口复制的说明: OSS
    
    批量删除指定Bucket下的OSSObject。
    
    指定者:
    
    deleteObjects 在接口中 OSS
    
    参数:
    deleteObjectsRequest - 请求参数DeleteObjectsRequest实例。
    
    返回:
    批量删除结果。
    
    抛出:
    
    OSSException
    
    ClientException
  - doesObjectExist
```
public boolean doesObjectExist(String bucketName,
                      String key)
                        throws OSSException,
                               ClientException
```
    从接口复制的说明: OSS
    
    判断指定Bucket下是否存在指定的OSSObject。
    
    指定者:
    
    doesObjectExist 在接口中 OSS
    
    参数:
    bucketName - Bucket名称。
    key - Object Key。
    
    返回:
    如果存在返回True，不存在则返回False。
    
    抛出:
    
    OSSException
    
    ClientException
  - doesObjectExist
```
public boolean doesObjectExist(HeadObjectRequest headObjectRequest)
                        throws OSSException,
                               ClientException
```
    从接口复制的说明: OSS
    
    判断指定的OSSObject是否存在。
    
    指定者:
    
    doesObjectExist 在接口中 OSS
    
    参数:
    headObjectRequest - 请求参数HeadObjectRequest实例。
    
    返回:
    如果存在返回True，不存在则返回False。
    
    抛出:
    
    OSSException
    
    ClientException
  - generatePresignedUrl
```
public URL generatePresignedUrl(String bucketName,
                       String key,
                       Date expiration)
                         throws ClientException
```
    从接口复制的说明: OSS
    
    生成一个用HTTP GET方法访问OSSObject的URL。
    
    指定者:
    
    generatePresignedUrl 在接口中 OSS
    
    参数:
    bucketName - Bucket名称。
    key - Object key。
    expiration - URL的超时时间。
    
    返回:
    访问OSSObject的URL。
    
    抛出:
    
    ClientException
  - generatePresignedUrl
```
public URL generatePresignedUrl(String bucketName,
                       String key,
                       Date expiration,
                       HttpMethod method)
                         throws ClientException
```
    从接口复制的说明: OSS
    
    生成一个用指定HTTP方法访问OSSObject的URL。
    
    指定者:
    
    generatePresignedUrl 在接口中 OSS
    
    参数:
    bucketName - Bucket名称。
    key - Object Key。
    expiration - URL的超时时间。
    method - HTTP方法，只支持HttpMethod.GET和HttpMethod.PUT。
    
    返回:
    访问OSSObject的URL。
    
    抛出:
    
    ClientException
  - generatePresignedUrl
```
public URL generatePresignedUrl(GeneratePresignedUrlRequest request)
                         throws ClientException
```
    从接口复制的说明: OSS
    
    生成一个包含签名信息并可以访问OSSObject的URL。
    
    指定者:
    
    generatePresignedUrl 在接口中 OSS
    
    参数:
    request - GeneratePresignedUrlRequest对象。
    
    返回:
    包含签名信息并可以访问OSSObject的URL。
    
    抛出:
    
    ClientException
  - abortMultipartUpload
```
public void abortMultipartUpload(AbortMultipartUploadRequest request)
                          throws OSSException,
                                 ClientException
```
    从接口复制的说明: OSS
    
    终止一个Multipart上传事件。
    
    指定者:
    
    abortMultipartUpload 在接口中 OSS
    
    参数:
    request - AbortMultipartUploadRequest对象。
    
    抛出:
    
    ClientException
    
    OSSException
  - completeMultipartUpload
```
public CompleteMultipartUploadResult completeMultipartUpload(CompleteMultipartUploadRequest request)
                                                      throws OSSException,
                                                             ClientException
```
    从接口复制的说明: OSS
    
    完成一个Multipart上传事件。
    在将所有数据Part 都上传完成后，可以调用 Complete Multipart Upload API 来完成整个文件的 Multipart Upload。在执行该操作时，用户必须提供所有有效的数据Part的列表（包括part号码和ETAG）； OSS收到用户提交的Part列表后，会逐一验证每个数据 Part 的有效性。当所有的数据 Part 验证通过后，OSS 将把这些数据part组合成一个完整的 Object。
    
    此方法对应的操作为非幂等操作，SDK不会对其进行重试（即使设置最大重试次数大于0也不会重试）
    
    指定者:
    
    completeMultipartUpload 在接口中 OSS
    
    参数:
    request - CompleteMultipartUploadRequest对象。
    
    返回:
    CompleteMultipartUploadResult
    
    抛出:
    
    ClientException
    
    OSSException
  - initiateMultipartUpload
```
public InitiateMultipartUploadResult initiateMultipartUpload(InitiateMultipartUploadRequest request)
                                                      throws OSSException,
                                                             ClientException
```
    从接口复制的说明: OSS
    
    初始化一个Multipart上传事件。
    使用Multipart模式上传数据前，必须先调用该接口来通过OSS初始化一个Multipart上传事件。该接口会返回一个OSS服务器创建的全局唯一的Upload ID，用于标识本次Multipart上传事件。用户可以根据这个ID来发起相关的操作，如中止、查询Multipart上传等。
    
    此方法对应的操作为非幂等操作，SDK不会对其进行重试（即使设置最大重试次数大于0也不会重试）
    
    指定者:
    
    initiateMultipartUpload 在接口中 OSS
    
    参数:
    request - InitiateMultipartUploadRequest对象。
    
    返回:
    InitiateMultipartUploadResult
    
    抛出:
    
    ClientException
    
    OSSException
  - listMultipartUploads
```
public MultipartUploadListing listMultipartUploads(ListMultipartUploadsRequest request)
                                            throws OSSException,
                                                   ClientException
```
    从接口复制的说明: OSS
    
    列出所有执行中的 Multipart上传事件。
    即已经被初始化的 Multipart Upload 但是未被完成或被终止的 Multipart上传事件。 OSS返回的罗列结果中最多会包含1000个Multipart上传事件。
    
    指定者:
    
    listMultipartUploads 在接口中 OSS
    
    参数:
    request - ListMultipartUploadsRequest对象。
    
    返回:
    MultipartUploadListing Multipart上传事件的列表MultipartUploadListing。
    
    抛出:
    
    ClientException
    
    OSSException
  - listParts
```
public PartListing listParts(ListPartsRequest request)
                      throws OSSException,
                             ClientException
```
    从接口复制的说明: OSS
    
    列出multipart中上传的所有part信息
    
    指定者:
    
    listParts 在接口中 OSS
    
    参数:
    request - ListPartsRequest对象。
    
    返回:
    PartListing
    
    抛出:
    
    ClientException
    
    OSSException
  - uploadPart
```
public UploadPartResult uploadPart(UploadPartRequest request)
                            throws OSSException,
                                   ClientException
```
    从接口复制的说明: OSS
    
    上传一个分块（Part）到指定的的Multipart上传事件中。
    
    指定者:
    
    uploadPart 在接口中 OSS
    
    参数:
    request - UploadPartRequest对象。
    
    返回:
    UploadPartResult 上传Part的返回结果UploadPartResult。
    
    抛出:
    
    ClientException
    
    OSSException
  - uploadPartCopy
```
public UploadPartCopyResult uploadPartCopy(UploadPartCopyRequest request)
                                    throws OSSException,
                                           ClientException
```
    从接口复制的说明: OSS
    
    分片拷贝。
    
    指定者:
    
    uploadPartCopy 在接口中 OSS
    
    参数:
    request - 分片拷贝请求参数。
    
    返回:
    分片拷贝结果。
    
    抛出:
    
    OSSException
    
    ClientException
  - setBucketCORS
```
public void setBucketCORS(SetBucketCORSRequest request)
                   throws OSSException,
                          ClientException
```
    从接口复制的说明: OSS
    
    操作将在指定的bucket上设定一个跨域资源共享(CORS)的规则，如果原规则存在则覆盖原规则
    
    指定者:
    
    setBucketCORS 在接口中 OSS
    
    参数:
    request - SetBucketCORSRequest}
    
    抛出:
    
    OSSException
    
    ClientException
  - getBucketCORSRules
```
public List<SetBucketCORSRequest.CORSRule> getBucketCORSRules(String bucketName)
                                                       throws OSSException,
                                                              ClientException
```
    从接口复制的说明: OSS
    
    列出指定bucket的跨域访问规则
    
    指定者:
    
    getBucketCORSRules 在接口中 OSS
    
    返回:
    
    抛出:
    
    OSSException
    
    ClientException
  - deleteBucketCORSRules
```
public void deleteBucketCORSRules(String bucketName)
                           throws OSSException,
                                  ClientException
```
    从接口复制的说明: OSS
    
    删除指定bucket下面的所有跨域访问规则
    
    指定者:
    
    deleteBucketCORSRules 在接口中 OSS
    
    抛出:
    
    OSSException
    
    ClientException
  - optionsObject
```
@Deprecated
public ResponseMessage optionsObject(OptionsRequest request)
                              throws OSSException,
                                     ClientException
```
    已过时。
    
    从接口复制的说明: OSS
    
    option object
    
    指定者:
    
    optionsObject 在接口中 OSS
    
    返回:
    
    抛出:
    
    OSSException
    
    ClientException
  - setBucketLogging
```
public void setBucketLogging(SetBucketLoggingRequest request)
                      throws OSSException,
                             ClientException
```
    指定者:
    
    setBucketLogging 在接口中 OSS
    
    抛出:
    
    OSSException
    
    ClientException
  - getBucketLogging
```
public BucketLoggingResult getBucketLogging(String bucketName)
                                     throws OSSException,
                                            ClientException
```
    从接口复制的说明: OSS
    
    查看Bucket的访问日志配置。
    
    指定者:
    
    getBucketLogging 在接口中 OSS
    
    返回:
    
    抛出:
    
    OSSException
    
    ClientException
  - deleteBucketLogging
```
public void deleteBucketLogging(String bucketName)
                         throws OSSException,
                                ClientException
```
    从接口复制的说明: OSS
    
    关闭Bucket的访问日志记录功能。
    
    指定者:
    
    deleteBucketLogging 在接口中 OSS
    
    抛出:
    
    OSSException
    
    ClientException
  - setBucketWebsite
```
public void setBucketWebsite(SetBucketWebsiteRequest setBucketWebSiteRequest)
                      throws OSSException,
                             ClientException
```
    从接口复制的说明: OSS
    
    将一个Bucket设置成静态网站托管模式。
    
    指定者:
    
    setBucketWebsite 在接口中 OSS
    
    抛出:
    
    OSSException
    
    ClientException
  - getBucketWebsite
```
public BucketWebsiteResult getBucketWebsite(String bucketName)
                                     throws OSSException,
                                            ClientException
```
    从接口复制的说明: OSS
    
    获取Bucket的静态网站托管状态。
    
    指定者:
    
    getBucketWebsite 在接口中 OSS
    
    返回:
    
    抛出:
    
    OSSException
    
    ClientException
  - deleteBucketWebsite
```
public void deleteBucketWebsite(String bucketName)
                         throws OSSException,
                                ClientException
```
    从接口复制的说明: OSS
    
    关闭Bucket的静态网站托管模式。
    
    指定者:
    
    deleteBucketWebsite 在接口中 OSS
    
    抛出:
    
    OSSException
    
    ClientException
  - generatePostPolicy
```
public String generatePostPolicy(Date expiration,
                        PolicyConditions conds)
```
    从接口复制的说明: OSS
    
    生成Post请求的policy表单域。
    
    指定者:
    
    generatePostPolicy 在接口中 OSS
    
    参数:
    expiration - policy过期时间。
    conds - policy条件列表。
    
    返回:
    policy字符串。
  - calculatePostSignature
```
public String calculatePostSignature(String postPolicy)
                              throws ClientException
```
    从接口复制的说明: OSS
    
    根据Access Key Secret和policy计算签名，OSS依据该签名验证Post请求的合法性。
    
    指定者:
    
    calculatePostSignature 在接口中 OSS
    
    参数:
    postPolicy - 由OSS.generatePostPolicy(Date, PolicyConditions)生成的policy字符串。
    
    返回:
    post签名。
    
    抛出:
    
    ClientException
  - setBucketLifecycle
```
public void setBucketLifecycle(SetBucketLifecycleRequest setBucketLifecycleRequest)
                        throws OSSException,
                               ClientException
```
    从接口复制的说明: OSS
    
    设置Bucket的Lifecycle规则。
    
    指定者:
    
    setBucketLifecycle 在接口中 OSS
    
    参数:
    setBucketLifecycleRequest - 请求参数。
    
    抛出:
    
    OSSException - OSS Server异常信息。
    
    ClientException - OSS Client异常信息。
  - getBucketLifecycle
```
public List<LifecycleRule> getBucketLifecycle(String bucketName)
                                       throws OSSException,
                                              ClientException
```
    从接口复制的说明: OSS
    
    获取Bucket的Lifecycle规则列表。
    
    指定者:
    
    getBucketLifecycle 在接口中 OSS
    
    参数:
    bucketName - 指定Bucket名称。
    
    返回:
    Lifecycle规则列表。
    
    抛出:
    
    OSSException - OSS Server异常信息。
    
    ClientException - OSS Client异常信息。
  - deleteBucketLifecycle
```
public void deleteBucketLifecycle(String bucketName)
                           throws OSSException,
                                  ClientException
```
    从接口复制的说明: OSS
    
    关闭Bucket的Lifecycle规则。
    
    指定者:
    
    deleteBucketLifecycle 在接口中 OSS
    
    参数:
    bucketName - 指定Bucket名称。
    
    抛出:
    
    OSSException - OSS Server异常信息。
    
    ClientException - OSS Client异常信息。
  - shutdown
```
public void shutdown()
```
    从接口复制的说明: OSS
    
    关闭Client实例，并释放所有正在使用的资源。一旦关闭，将不再处理任何发往OSS的请求。
    
    指定者:
    
    shutdown 在接口中 OSS

类 OSSClient

构造器概要

方法概要

从类继承的方法 java.lang.Object

构造器详细资料

OSSClient

OSSClient

OSSClient

OSSClient

OSSClient

OSSClient

OSSClient

方法详细资料

getEndpoint

setEndpoint

switchCredentials

getCredentialsProvider

createBucket

createBucket

deleteBucket

listBuckets

listBuckets

listBuckets

setBucketAcl

getBucketAcl

setBucketReferer

getBucketReferer

getBucketLocation

doesBucketExist

isBucketExist

listObjects

listObjects

listObjects

putObject

putObject

putObject

putObject

putObject

putObject

putObject

copyObject

copyObject

getObject

getObject

getObject

getObject

getObjectMetadata

deleteObject

deleteObjects

doesObjectExist

doesObjectExist

generatePresignedUrl

generatePresignedUrl

generatePresignedUrl

abortMultipartUpload

completeMultipartUpload

initiateMultipartUpload

listMultipartUploads

listParts

uploadPart

uploadPartCopy

setBucketCORS

getBucketCORSRules

deleteBucketCORSRules

optionsObject

setBucketLogging

getBucketLogging

deleteBucketLogging

setBucketWebsite

getBucketWebsite

deleteBucketWebsite

generatePostPolicy

calculatePostSignature

setBucketLifecycle

getBucketLifecycle

deleteBucketLifecycle

shutdown