IFSClient (OBS SDK for Java 3.21.12 API)

All Known Implementing Classes:

AbstractBatchClient, AbstractBucketAdvanceClient, AbstractBucketClient, AbstractClient, AbstractDeprecatedBucketClient, AbstractFileClient, AbstractMultipartObjectClient, AbstractObjectClient, AbstractPFSClient, ObsClient, OefClient, SecretFlexibleBucketObsClient, SecretFlexibleObsClient
```
public interface IFSClient
```
OBS文件网关接口

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`ObsFSFile`	`appendFile(WriteFileRequest request)` 在文件末尾追加内容
`void`	`close()` 关闭OBS客户端，释放连接资源
`DropFileResult`	`dropFile(DropFileRequest request)` 删除文件
`TaskProgressStatus`	`dropFolder(DropFolderRequest request)` 删除文件夹
`ObsFSAttribute`	`getAttribute(GetAttributeRequest request)` 获取文件/文件夹属性
`GetBucketFSStatusResult`	`getBucketFSStatus(GetBucketFSStatusRequest request)` 获取桶的文件网关特性状态
`ListContentSummaryResult`	`listContentSummary(ListContentSummaryRequest request)` 列举目录统计信息
`ObsFSBucket`	`newBucket(NewBucketRequest request)` 创建桶
`ObsFSFile`	`newFile(NewFileRequest request)` 创建文件
`ObsFSFolder`	`newFolder(NewFolderRequest request)` 创建文件夹
`ReadFileResult`	`readFile(ReadFileRequest request)` 读取文件内容
`RenameResult`	`renameFile(RenameRequest request)` 重命名文件
`RenameResult`	`renameFolder(RenameRequest request)` 重命名文件夹
`HeaderResponse`	`setBucketFSStatus(SetBucketFSStatusRequest request)` 设置桶的文件网关特性状态
`TruncateFileResult`	`truncateFile(TruncateFileRequest request)` 截断文件
`ObsFSFile`	`writeFile(WriteFileRequest request)` 写文件内容

- Method Detail
  - close
```
void close()
    throws IOException
```
    关闭OBS客户端，释放连接资源
    
    Throws:
    
    IOException - IO异常，当关闭资源失败时抛出该异常
  - newBucket
```
ObsFSBucket newBucket(NewBucketRequest request)
               throws ObsException
```
    创建桶
    
    Parameters:
    
    request - 创建桶请求参数
    
    Returns:
    
    代表支持文件接口的桶
    
    Throws:
    
    ObsException - OBS SDK自定义异常，当调用接口失败、访问OBS失败时抛出该异常
  - setBucketFSStatus
```
HeaderResponse setBucketFSStatus(SetBucketFSStatusRequest request)
                          throws ObsException
```
    设置桶的文件网关特性状态
    
    Parameters:
    
    request - 设置桶的文件网关特性状态的请求参数
    
    Returns:
    
    公共响应头信息
    
    Throws:
    
    ObsException - OBS SDK自定义异常，当调用接口失败、访问OBS失败时抛出该异常
  - getBucketFSStatus
```
GetBucketFSStatusResult getBucketFSStatus(GetBucketFSStatusRequest request)
                                   throws ObsException
```
    获取桶的文件网关特性状态
    
    Parameters:
    
    request - 获取桶的文件网关特性状态的请求参数
    
    Returns:
    
    获取桶的文件网关特性状态的响应结果
    
    Throws:
    
    ObsException - OBS SDK自定义异常，当调用接口失败、访问OBS失败时抛出该异常
  - newFile
```
ObsFSFile newFile(NewFileRequest request)
           throws ObsException
```
    创建文件
    
    Parameters:
    
    request - 创建文件请求参数
    
    Returns:
    
    代表支持文件接口的桶中的文件
    
    Throws:
    
    ObsException - OBS SDK自定义异常，当调用接口失败、访问OBS失败时抛出该异常
  - newFolder
```
ObsFSFolder newFolder(NewFolderRequest request)
               throws ObsException
```
    创建文件夹
    
    Parameters:
    
    request - 创建文件夹请求参数
    
    Returns:
    
    代表支持文件接口的桶中的文件夹
    
    Throws:
    
    ObsException - OBS SDK自定义异常，当调用接口失败、访问OBS失败时抛出该异常
  - getAttribute
```
ObsFSAttribute getAttribute(GetAttributeRequest request)
                     throws ObsException
```
    获取文件/文件夹属性
    
    Parameters:
    
    request - 获取文件/文件夹属性请求参数
    
    Returns:
    
    文件/文件夹属性
    
    Throws:
    
    ObsException - OBS SDK自定义异常，当调用接口失败、访问OBS失败时抛出该异常
  - readFile
```
ReadFileResult readFile(ReadFileRequest request)
                 throws ObsException
```
    读取文件内容
    
    Parameters:
    
    request - 读取文件内容的请求参数
    
    Returns:
    
    读取文件内容的响应结果
    
    Throws:
    
    ObsException - OBS SDK自定义异常，当调用接口失败、访问OBS失败时抛出该异常
  - writeFile
```
ObsFSFile writeFile(WriteFileRequest request)
             throws ObsException
```
    写文件内容
    
    Parameters:
    
    request - 写文件内容的请求参数
    
    Returns:
    
    代表支持文件接口的桶中的文件
    
    Throws:
    
    ObsException - OBS SDK自定义异常，当调用接口失败、访问OBS失败时抛出该异常
  - appendFile
```
ObsFSFile appendFile(WriteFileRequest request)
              throws ObsException
```
    在文件末尾追加内容
    
    Parameters:
    
    request - 写文件内容的请求参数
    
    Returns:
    
    代表支持文件接口的桶中的文件
    
    Throws:
    
    ObsException - OBS SDK自定义异常，当调用接口失败、访问OBS失败时抛出该异常
  - renameFile
```
RenameResult renameFile(RenameRequest request)
                 throws ObsException
```
    重命名文件
    
    Parameters:
    
    request - 重命名文件请求参数
    
    Returns:
    
    重命名文件响应结果
    
    Throws:
    
    ObsException - OBS SDK自定义异常，当调用接口失败、访问OBS失败时抛出该异常
  - renameFolder
```
RenameResult renameFolder(RenameRequest request)
                   throws ObsException
```
    重命名文件夹
    
    Parameters:
    
    request - 重命名文件夹请求参数
    
    Returns:
    
    重命名文件夹响应结果
    
    Throws:
    
    ObsException - OBS SDK自定义异常，当调用接口失败、访问OBS失败时抛出该异常
  - truncateFile
```
TruncateFileResult truncateFile(TruncateFileRequest request)
                         throws ObsException
```
    截断文件
    
    Parameters:
    
    request - 截断文件请求参数
    
    Returns:
    
    截断文件响应结果
    
    Throws:
    
    ObsException - OBS SDK自定义异常，当调用接口失败、访问OBS失败时抛出该异常
  - dropFile
```
DropFileResult dropFile(DropFileRequest request)
                 throws ObsException
```
    删除文件
    
    Parameters:
    
    request - 删除文件请求
    
    Returns:
    
    删除文件响应结果
    
    Throws:
    
    ObsException - OBS SDK自定义异常，当调用接口失败、访问OBS失败时抛出该异常
  - dropFolder
```
TaskProgressStatus dropFolder(DropFolderRequest request)
                       throws ObsException
```
    删除文件夹
    
    Parameters:
    
    request - 删除文件夹请求参数
    
    Returns:
    
    批量任务执行状态
    
    Throws:
    
    ObsException - OBS SDK自定义异常，当调用接口失败、访问OBS失败时抛出该异常
  - listContentSummary
```
ListContentSummaryResult listContentSummary(ListContentSummaryRequest request)
                                     throws ObsException
```
    列举目录统计信息
    
    Parameters:
    
    request - 列举目录统计信息请求参数
    
    Returns:
    
    列举目录统计信息响应结果
    
    Throws:
    
    ObsException - OBS SDK自定义异常，当调用接口失败、访问OBS失败时抛出该异常
    
    Since:
    
    3.20.5

Interface IFSClient

Method Summary

Method Detail

close

newBucket

setBucketFSStatus

getBucketFSStatus

newFile

newFolder

getAttribute

readFile

writeFile

appendFile

renameFile

renameFolder

truncateFile

dropFile

dropFolder

listContentSummary