cn.ucloud.ufs.client.UFSClient Maven / Gradle / Ivy

Go to download
package cn.ucloud.ufs.client;

import cn.ucloud.common.client.UcloudClient;
import cn.ucloud.common.handler.UcloudHandler;
import cn.ucloud.ufs.model.*;

/**
 * @description: 文件存储接口
 * @author: codezhang
 * @date: 2018-10-08 14:31
 **/
public interface UFSClient extends UcloudClient {

    /**
     * 创建文件系统
     * @param param 参数对象
     * @return 结果对象
     * @throws Exception 出错则抛出异常
     */
    CreateUFSVolumeResult createUFSVolume(CreateUFSVolumeParam param) throws Exception;

    /**
     * 创建文件系统
     * @param param     参数对象
     * @param handler   回调处理器
     * @param asyncFlag 异步标记，默认异步true
     */
    void createUFSVolume(CreateUFSVolumeParam param, UcloudHandler handler,
                         Boolean... asyncFlag);


    /**
     * 获取文件系统列表
     * @param param 参数对象
     * @return 结果对象
     * @throws Exception 出错则抛出异常
     */
    DescribeUFSVolumeResult describeUFSVolume(DescribeUFSVolumeParam param) throws Exception;

    /**
     * 获取文件系统列表
     * @param param     参数对象
     * @param handler   回调处理器
     * @param asyncFlag 异步标记，默认异步true
     */
    void describeUFSVolume(DescribeUFSVolumeParam param, UcloudHandler handler,
                           Boolean... asyncFlag);


    /**
     * 获取文件系统价格
     * @param param 参数对象
     * @return 结果对象
     * @throws Exception 出错则抛出异常
     */
    DescribeUFSVolumePriceResult describeUFSVolumePrice(DescribeUFSVolumePriceParam param)
            throws Exception;

    /**
     * 获取文件系统价格
     * @param param     参数对象
     * @param handler   回调处理器
     * @param asyncFlag 异步标记，默认异步true
     */
    void describeUFSVolumePrice(DescribeUFSVolumePriceParam param,
                                UcloudHandler handler,
                                Boolean... asyncFlag);



    /**
     * 文件系统扩容价格
     * @param param 参数对象
     * @return 结果对象
     * @throws Exception 出错则抛出异常
     */
    DescribeUFSVolumeUpgradePriceResult describeUFSVolumeUpgradePrice(DescribeUFSVolumeUpgradePriceParam param)
            throws Exception;

    /**
     * 文件系统扩容价格
     * @param param     参数对象
     * @param handler   回调处理器
     * @param asyncFlag 异步标记，默认异步true
     */
    void describeUFSVolumeUpgradePrice(DescribeUFSVolumeUpgradePriceParam param,
                                       UcloudHandler handler,
                                       Boolean... asyncFlag);


    /**
     * 获取文件系统白名单
     * @param param 参数对象
     * @return 结果对象
     * @throws Exception 出错则抛出异常
     */
    DescribeUFSVolumeWhiteListResult describeUFSVolumeWhiteList(DescribeUFSVolumeWhiteListParam param)
            throws Exception;

    /**
     * 获取文件系统白名单
     * @param param     参数对象
     * @param handler   回调处理器
     * @param asyncFlag 异步标记，默认异步true
     */
    void describeUFSVolumeWhiteList(DescribeUFSVolumeWhiteListParam param,
                                    UcloudHandler handler,
                                    Boolean... asyncFlag);


    /**
     * 文件系统扩容
     * @param param 参数对象
     * @return 结果对象
     * @throws Exception 出错则抛出异常
     */
    ExtendUFSVolumeResult extendUFSVolume(ExtendUFSVolumeParam param) throws Exception;

    /**
     * 文件系统扩容
     * @param param     参数对象
     * @param handler   回调处理器
     * @param asyncFlag 异步标记，默认异步true
     */
    void extendUFSVolume(ExtendUFSVolumeParam param, UcloudHandler handler,
                         Boolean... asyncFlag);


    /**
     * 初始化文件系统白名单
     * @param param 参数对象
     * @return 结果对象
     * @throws Exception 出错则抛出异常
     */
    @Deprecated
    InitUFSVolumeWhiteListResult initUFSVolumeWhiteList(InitUFSVolumeWhiteListParam param)
            throws Exception;

    /**
     * 初始化文件系统白名单
     * @param param     参数对象
     * @param handler   回调处理器
     * @param asyncFlag 异步标记，默认异步true
     */
    @Deprecated
    void initUFSVolumeWhiteList(InitUFSVolumeWhiteListParam param,
                                UcloudHandler handler,
                                Boolean... asyncFlag);


    /**
     * 删除文件系统
     * @param param 参数对象
     * @return 结果对象
     * @throws Exception 出错则抛出异常
     */
    RemoveUFSVolumeResult removeUFSVolume(RemoveUFSVolumeParam param) throws Exception;

    /**
     * 删除文件系统
     * @param param     参数对象
     * @param handler   回调处理器
     * @param asyncFlag 异步标记，默认异步true
     */
    void removeUFSVolume(RemoveUFSVolumeParam param, UcloudHandler handler,
                         Boolean... asyncFlag);


    /**
     * 更改文件系统相关信息（名称／备注）
     * @param param 参数对象
     * @return 结果对象
     * @throws Exception 出错则抛出异常
     */
    UpdateUFSVolumeInfoResult updateUFSVolumeInfo(UpdateUFSVolumeInfoParam param) throws Exception;

    /**
     * 更改文件系统相关信息（名称／备注）
     * @param param     参数对象
     * @param handler   回调处理器
     * @param asyncFlag 异步标记，默认异步true
     */
    void updateUFSVolumeInfo(UpdateUFSVolumeInfoParam param,
                             UcloudHandler handler,
                             Boolean... asyncFlag);

    /**
     * 更新文件系统白名单
     * @param param 参数对象
     * @return 结果对象
     * @throws Exception 出错则抛出异常
     */
    UpdateUFSVolumeWhiteListResult updateUFSVolumeWhiteList(UpdateUFSVolumeWhiteListParam param)
            throws Exception;

    /**
     * 更新文件系统白名单
     * @param param     参数对象
     * @param handler   回调处理器
     * @param asyncFlag 异步标记，默认异步true
     */
    void updateUFSVolumeWhiteList(UpdateUFSVolumeWhiteListParam param,
                                  UcloudHandler handler,
                                  Boolean... asyncFlag);

}