IFSClient (OBS SDK for Java 3.24.3 API)

所有已知实现类:

AbstractBatchClient, AbstractBucketAdvanceClient, AbstractBucketClient, AbstractClient, AbstractDeprecatedBucketClient, AbstractFileClient, AbstractMultipartObjectClient, AbstractObjectClient, AbstractPFSClient, CryptoObsClient, ObsClient, OefClient, SecretFlexibleBucketObsClient, SecretFlexibleObsClient
```
public interface IFSClient
```
Gateway interface for OBS files

方法概要

所有方法实例方法抽象方法
限定符和类型	方法和说明
`ObsFSFile`	`appendFile(WriteFileRequest request)` Append data to a file.
`void`	`close()` Disable ObsClient and release connection resources.
`DeleteAccessLabelResult`	`deleteAccessLabelFs(DeleteAccessLabelRequest request)` delete access label of the folder s3 protocol is not supported
`DropFileResult`	`dropFile(DropFileRequest request)` Delete a file.
`TaskProgressStatus`	`dropFolder(DropFolderRequest request)` Delete a folder.
`GetAccessLabelResult`	`getAccessLabelFs(GetAccessLabelRequest request)` get access label of the folder s3 protocol is not supported
`ObsFSAttribute`	`getAttribute(GetAttributeRequest request)` Obtain file or folder properties.
`GetBucketFSStatusResult`	`getBucketFSStatus(GetBucketFSStatusRequest request)` Check whether the file gateway feature is enabled for the bucket.
`ContentSummaryFsResult`	`getContentSummaryFs(ContentSummaryFsRequest request)` obtain current folder contentSummary
`ListContentSummaryResult`	`listContentSummary(ListContentSummaryRequest request)` obtain folder contentSummary
`ListContentSummaryFsResult`	`listContentSummaryFs(ListContentSummaryFsRequest request)` obtain folder contentSummary
`ObsFSBucket`	`newBucket(NewBucketRequest request)` Create a bucket.
`ObsFSFile`	`newFile(NewFileRequest request)` Create a file.
`ObsFSFolder`	`newFolder(NewFolderRequest request)` Create a folder.
`ReadFileResult`	`readFile(ReadFileRequest request)` Obtain the file content.
`RenameResult`	`renameFile(RenameRequest request)` Rename a file.
`RenameResult`	`renameFolder(RenameRequest request)` Rename a folder.
`SetAccessLabelResult`	`setAccessLabelFs(SetAccessLabelRequest request)` set access label for a folder s3 protocol is not supported
`HeaderResponse`	`setBucketFSStatus(SetBucketFSStatusRequest request)` Specify whether to enable the file gateway feature for the bucket.
`TruncateFileResult`	`truncateFile(TruncateFileRequest request)` Truncate a file.
`ObsFSFile`	`writeFile(WriteFileRequest request)` Write data to a file.

- 方法详细资料
  - close
```
void close()
    throws IOException
```
    Disable ObsClient and release connection resources.
    
    抛出:
    
    IOException - ioException
  - newBucket
```
ObsFSBucket newBucket(NewBucketRequest request)
               throws ObsException
```
    Create a bucket.
    
    参数:
    
    request - Request parameters for creating a bucket
    
    返回:
    
    Bucket supporting the file interface
    
    抛出:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - setBucketFSStatus
```
HeaderResponse setBucketFSStatus(SetBucketFSStatusRequest request)
                          throws ObsException
```
    Specify whether to enable the file gateway feature for the bucket.
    
    参数:
    
    request - Request parameters for specifying whether to enable the file gateway feature for the bucket
    
    返回:
    
    Common response headers
    
    抛出:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - getBucketFSStatus
```
GetBucketFSStatusResult getBucketFSStatus(GetBucketFSStatusRequest request)
                                   throws ObsException
```
    Check whether the file gateway feature is enabled for the bucket.
    
    参数:
    
    request - Request parameters for checking whether the file gateway feature is enabled for the bucket
    
    返回:
    
    Response to the check of whether the file gateway feature is enabled for the bucket
    
    抛出:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - newFile
```
ObsFSFile newFile(NewFileRequest request)
           throws ObsException
```
    Create a file.
    
    参数:
    
    request - Request parameters for creating a file
    
    返回:
    
    Files in the bucket that supports the file interface
    
    抛出:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - newFolder
```
ObsFSFolder newFolder(NewFolderRequest request)
               throws ObsException
```
    Create a folder.
    
    参数:
    
    request - Request parameters for creating a folder
    
    返回:
    
    Folders in the bucket that supports the file interface
    
    抛出:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - getAttribute
```
ObsFSAttribute getAttribute(GetAttributeRequest request)
                     throws ObsException
```
    Obtain file or folder properties.
    
    参数:
    
    request - Request parameters for obtaining filer or folder properties
    
    返回:
    
    File or folder properties
    
    抛出:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - readFile
```
ReadFileResult readFile(ReadFileRequest request)
                 throws ObsException
```
    Obtain the file content.
    
    参数:
    
    request - Request parameters for obtaining the file content
    
    返回:
    
    Response to the request for obtaining file content
    
    抛出:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - writeFile
```
ObsFSFile writeFile(WriteFileRequest request)
             throws ObsException
```
    Write data to a file.
    
    参数:
    
    request - Request parameters for writing data to a file
    
    返回:
    
    Files in the bucket that supports the file interface
    
    抛出:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - appendFile
```
ObsFSFile appendFile(WriteFileRequest request)
              throws ObsException
```
    Append data to a file.
    
    参数:
    
    request - Request parameters for writing data to a file
    
    返回:
    
    Files in the bucket that supports the file interface
    
    抛出:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - renameFile
```
RenameResult renameFile(RenameRequest request)
                 throws ObsException
```
    Rename a file.
    
    参数:
    
    request - Request parameters for renaming a file
    
    返回:
    
    Response to the request for renaming a file
    
    抛出:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - renameFolder
```
RenameResult renameFolder(RenameRequest request)
                   throws ObsException
```
    Rename a folder.
    
    参数:
    
    request - Request parameters for renaming a folder
    
    返回:
    
    Response to the request for renaming a folder
    
    抛出:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - truncateFile
```
TruncateFileResult truncateFile(TruncateFileRequest request)
                         throws ObsException
```
    Truncate a file.
    
    参数:
    
    request - Request parameters for truncating a file
    
    返回:
    
    Response to the request for truncating a file
    
    抛出:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - dropFile
```
DropFileResult dropFile(DropFileRequest request)
                 throws ObsException
```
    Delete a file.
    
    参数:
    
    request - Request parameters for deleting a file
    
    返回:
    
    Response to the request for deleting a file
    
    抛出:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - dropFolder
```
TaskProgressStatus dropFolder(DropFolderRequest request)
                       throws ObsException
```
    Delete a folder.
    
    参数:
    
    request - Request parameters for deleting a folder
    
    返回:
    
    Batch task execution status
    
    抛出:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - listContentSummary
```
ListContentSummaryResult listContentSummary(ListContentSummaryRequest request)
                                     throws ObsException
```
    obtain folder contentSummary
    
    参数:
    
    request - Request parameters for obtain folder contentSummary
    
    返回:
    
    Response to the request for obtain folder contentSummary
    
    抛出:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
    
    从以下版本开始:
    
    3.20.5
  - listContentSummaryFs
```
ListContentSummaryFsResult listContentSummaryFs(ListContentSummaryFsRequest request)
                                         throws ObsException
```
    obtain folder contentSummary
    
    参数:
    
    request - Request parameters for obtain folder contentSummary
    
    返回:
    
    Response to the request for obtain folder contentSummary
    
    抛出:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - getContentSummaryFs
```
ContentSummaryFsResult getContentSummaryFs(ContentSummaryFsRequest request)
                                    throws ObsException
```
    obtain current folder contentSummary
    
    参数:
    
    request - Request parameters for obtain current folder contentSummary
    
    返回:
    
    Response to the request for obtain current folder contentSummary
    
    抛出:
    
    ObsException - ObsException OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - setAccessLabelFs
```
SetAccessLabelResult setAccessLabelFs(SetAccessLabelRequest request)
                               throws ObsException
```
    set access label for a folder s3 protocol is not supported
    
    参数:
    
    request - Request parameters for access label setting
    
    返回:
    
    Response to the request for access label setting
    
    抛出:
    
    ObsException - ObsException OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - getAccessLabelFs
```
GetAccessLabelResult getAccessLabelFs(GetAccessLabelRequest request)
                               throws ObsException
```
    get access label of the folder s3 protocol is not supported
    
    参数:
    
    request - Request parameters for getting access label
    
    返回:
    
    Response to the request for getting access label
    
    抛出:
    
    ObsException - ObsException OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - deleteAccessLabelFs
```
DeleteAccessLabelResult deleteAccessLabelFs(DeleteAccessLabelRequest request)
                                     throws ObsException
```
    delete access label of the folder s3 protocol is not supported
    
    参数:
    
    request - Request parameters for deleting access label
    
    返回:
    
    Response to the request for deleting access label
    
    抛出:
    
    ObsException - ObsException OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails

接口 IFSClient

方法概要

方法详细资料

close

newBucket

setBucketFSStatus

getBucketFSStatus

newFile

newFolder

getAttribute

readFile

writeFile

appendFile

renameFile

renameFolder

truncateFile

dropFile

dropFolder

listContentSummary

listContentSummaryFs

getContentSummaryFs

setAccessLabelFs

getAccessLabelFs

deleteAccessLabelFs