COSClient (cos-java-sdk 4.6 API)

java.lang.Object
- com.qcloud.cos.COSClient

所有已实现的接口:

COS
```
public class COSClient
extends Object
implements COS
```
作者:

chengwu 封装Cos JAVA SDK暴露给用户的接口函数

构造器概要

构造器
构造器和说明
`COSClient(ClientConfig config, Credentials cred)`
`COSClient(Credentials cred)`
`COSClient(long appId, String secretId, String secretKey)`

方法概要

方法
限定符和类型	方法和说明
`String`	`createFolder(CreateFolderRequest request)` 创建目录
`String`	`delFile(DelFileRequest request)` 删除文件
`String`	`delFolder(DelFolderRequest request)` 删除目录请求
`InputStream`	`getFileInputStream(GetFileInputStreamRequest request)` 下载文件并得到下载流
`String`	`getFileLocal(GetFileLocalRequest request)` 下载文件到本地
`String`	`listFolder(ListFolderRequest request)` 获取目录列表请求
`String`	`moveFile(MoveFileRequest request)` 移动文件
`void`	`setConfig(ClientConfig config)`
`void`	`setCred(Credentials cred)`
`void`	`shutdown()` 关闭COS客户端连接池，释放涉及的资源，释放后，不能再使用COS的接口，必须重新生成一个新对象
`String`	`statFile(StatFileRequest request)` 获取文件属性
`String`	`statFolder(StatFolderRequest request)` 获取目录属性请求
`String`	`updateFile(UpdateFileRequest request)` 更新文件属性
`String`	`updateFolder(UpdateFolderRequest request)` 更新目录属性
`String`	`uploadFile(UploadFileRequest request)` 上传文件请求, 对小文件(8MB以下)使用单文件上传接口, 大文件使用分片上传接口, 推荐使用
`String`	`uploadSingleFile(UploadFileRequest request)` 上传单文件请求, 不分片,优先推荐使用uploadFile接口
`String`	`uploadSliceFile(UploadSliceFileRequest request)` 分片上传文件

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

- 构造器详细资料
  - COSClient
```
public COSClient(long appId,
         String secretId,
         String secretKey)
```
  - COSClient
```
public COSClient(Credentials cred)
```
  - COSClient
```
public COSClient(ClientConfig config,
         Credentials cred)
```
- 方法详细资料
  - setConfig
```
public void setConfig(ClientConfig config)
```
  - setCred
```
public void setCred(Credentials cred)
```
  - updateFolder
```
public String updateFolder(UpdateFolderRequest request)
```
    从接口复制的说明: COS
    
    更新目录属性
    
    指定者:
    
    updateFolder 在接口中 COS
    
    参数:
    request - 更新目录属性请求
    
    返回:
    JSON格式的字符串, 格式为{"code":$code, "message":"$mess"}, code为0表示成功, 其他为失败, message为success或者失败原因
  - updateFile
```
public String updateFile(UpdateFileRequest request)
```
    从接口复制的说明: COS
    
    更新文件属性
    
    指定者:
    
    updateFile 在接口中 COS
    
    参数:
    request - 更新文件属性请求
    
    返回:
    JSON格式的字符串, 格式为{"code":$code, "message":"$mess"}, code为0表示成功, 其他为失败, message为success或者失败原因
  - delFolder
```
public String delFolder(DelFolderRequest request)
```
    从接口复制的说明: COS
    
    删除目录请求
    
    指定者:
    
    delFolder 在接口中 COS
    
    参数:
    request - 删除目录请求
    
    返回:
    JSON格式的字符串, 格式为{"code":$code, "message":"$mess"}, code为0表示成功, 其他为失败, message为success或者失败原因
  - moveFile
```
public String moveFile(MoveFileRequest request)
```
    从接口复制的说明: COS
    
    移动文件
    
    指定者:
    
    moveFile 在接口中 COS
    
    参数:
    request - 移动文件请求
    
    返回:
    JSON格式的字符串, 格式为{"code":$code, "message":"$mess"}, code为0表示成功, 其他为失败, message为success或者失败原因
  - delFile
```
public String delFile(DelFileRequest request)
```
    从接口复制的说明: COS
    
    删除文件
    
    指定者:
    
    delFile 在接口中 COS
    
    参数:
    request - 删除文件请求
    
    返回:
    JSON格式的字符串, 格式为{"code":$code, "message":"$mess"}, code为0表示成功, 其他为失败, message为success或者失败原因
  - statFolder
```
public String statFolder(StatFolderRequest request)
```
    从接口复制的说明: COS
    
    获取目录属性请求
    
    指定者:
    
    statFolder 在接口中 COS
    
    参数:
    request - 获取目录属性请求
    
    返回:
    JSON格式的字符串, 格式为{"code":$code, "message":"$mess"}, code为0表示成功, 其他为失败, message为success或者失败原因
  - statFile
```
public String statFile(StatFileRequest request)
```
    从接口复制的说明: COS
    
    获取文件属性
    
    指定者:
    
    statFile 在接口中 COS
    
    参数:
    request - 获取文件属性请求
    
    返回:
    JSON格式的字符串, 格式为{"code":$code, "message":"$mess"}, code为0表示成功, 其他为失败, message为success或者失败原因
  - createFolder
```
public String createFolder(CreateFolderRequest request)
```
    从接口复制的说明: COS
    
    创建目录
    
    指定者:
    
    createFolder 在接口中 COS
    
    参数:
    request - 创建目录请求
    
    返回:
    JSON格式的字符串, 格式为{"code":$code, "message":"$mess"}, code为0表示成功, 其他为失败, message为success或者失败原因
  - listFolder
```
public String listFolder(ListFolderRequest request)
```
    从接口复制的说明: COS
    
    获取目录列表请求
    
    指定者:
    
    listFolder 在接口中 COS
    
    参数:
    request - 获取目录列表请求
    
    返回:
    JSON格式的字符串, 格式为{"code":$code, "message":"$mess"}, code为0表示成功, 其他为失败, message为success或者失败原因
  - uploadFile
```
public String uploadFile(UploadFileRequest request)
```
    从接口复制的说明: COS
    
    上传文件请求, 对小文件(8MB以下)使用单文件上传接口, 大文件使用分片上传接口, 推荐使用
    
    指定者:
    
    uploadFile 在接口中 COS
    
    参数:
    request - 上传文件请求
    
    返回:
    JSON格式的字符串, 格式为{"code":$code, "message":"$mess"}, code为0表示成功, 其他为失败, message为success或者失败原因
  - uploadSingleFile
```
public String uploadSingleFile(UploadFileRequest request)
```
    从接口复制的说明: COS
    
    上传单文件请求, 不分片,优先推荐使用uploadFile接口
    
    指定者:
    
    uploadSingleFile 在接口中 COS
    
    参数:
    request - 上传文件请求
    
    返回:
    JSON格式的字符串, 格式为{"code":$code, "message":"$mess"}, code为0表示成功, 其他为失败, message为success或者失败原因
  - uploadSliceFile
```
public String uploadSliceFile(UploadSliceFileRequest request)
```
    从接口复制的说明: COS
    
    分片上传文件
    
    指定者:
    
    uploadSliceFile 在接口中 COS
    
    参数:
    request - 分片上传请求
    
    返回:
    JSON格式的字符串, 格式为{"code":$code, "message":$mess}, code为0表示成功, 其他为失败, message为success或者失败原因
  - getFileInputStream
```
public InputStream getFileInputStream(GetFileInputStreamRequest request)
                               throws Exception
```
    从接口复制的说明: COS
    
    下载文件并得到下载流
    
    指定者:
    
    getFileInputStream 在接口中 COS
    
    返回:
    下载输入流
    
    抛出:
    
    Exception
  - getFileLocal
```
public String getFileLocal(GetFileLocalRequest request)
```
    从接口复制的说明: COS
    
    下载文件到本地
    
    指定者:
    
    getFileLocal 在接口中 COS
    
    返回:
    JSON格式的字符串, 格式为{"code":$code, "message":"$mess"}, code为0表示成功, 其他为失败, message为success或者失败原因
  - shutdown
```
public void shutdown()
```
    从接口复制的说明: COS
    
    关闭COS客户端连接池，释放涉及的资源，释放后，不能再使用COS的接口，必须重新生成一个新对象
    
    指定者:
    
    shutdown 在接口中 COS

类 COSClient

构造器概要

方法概要

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

构造器详细资料

COSClient

COSClient

COSClient

方法详细资料

setConfig

setCred

updateFolder

updateFile

delFolder

moveFile

delFile

statFolder

statFile

createFolder

listFolder

uploadFile

uploadSingleFile

uploadSliceFile

getFileInputStream

getFileLocal

shutdown