import { AbstractClient } from "../../../common/abstract_client"; import { ClientConfig } from "../../../common/interface"; import { ListConsoleGroupUsersRequest, ListConsoleGroupsRequest, UpdateConsoleUsersResponse, DeleteWorkflowResponse, ListConsoleUsersResponse, RemoveConsoleUsersResponse, DeleteWorkflowRequest, ListWorkflowTaskRunsRequest, CreateWorkflowRequest, CreateFileResponse, UpdateWorkflowRequest, UnbindWorkflowBundleResponse, KillWorkflowRunResponse, ListWorkflowsRequest, ListWorkflowRunsRequest, GetWorkflowTaskRunResponse, GetFileRequest, RerunWorkflowRunResponse, GetFileResponse, ListConsoleGroupUsersResponse, CreateConsoleGroupRequest, RerunWorkflowRunRequest, ListWorkflowsResponse, AddConsoleUsersRequest, KillWorkflowRunRequest, ListWorkflowTaskRunsResponse, AddConsoleUsersResponse, ListConsoleGroupsResponse, RunWorkflowRequest, UpdateConsoleGroupRequest, GetWorkflowResponse, GetWorkflowTaskRunRequest, DeleteFileResponse, CreateConsoleGroupResponse, DeleteConsoleGroupsRequest, UpdateWorkflowResponse, GetWorkflowRequest, CreateFileRequest, UpdateFileRequest, GetWorkflowRunRequest, RemoveConsoleUsersRequest, RunWorkflowResponse, ListConsoleUsersRequest, ListWorkflowRunsResponse, UpdateConsoleGroupResponse, DeleteConsoleGroupsResponse, CreateWorkflowResponse, ListConsoleRolesRequest, DeleteFileRequest, GetWorkflowRunResponse, UnbindWorkflowBundleRequest, ListConsoleRolesResponse, UpdateFileResponse, UpdateConsoleUsersRequest } from "./databuddy_models"; /** * databuddy client * @class */ export declare class Client extends AbstractClient { constructor(clientConfig: ClientConfig); /** * 更新工作流 */ UpdateWorkflow(req: UpdateWorkflowRequest, cb?: (error: string, rep: UpdateWorkflowResponse) => void): Promise; /** * 添加控制台用户 */ AddConsoleUsers(req: AddConsoleUsersRequest, cb?: (error: string, rep: AddConsoleUsersResponse) => void): Promise; /** * 获取工作流详细信息 */ GetWorkflow(req: GetWorkflowRequest, cb?: (error: string, rep: GetWorkflowResponse) => void): Promise; /** * 查询任务运行详情 */ GetWorkflowTaskRun(req: GetWorkflowTaskRunRequest, cb?: (error: string, rep: GetWorkflowTaskRunResponse) => void): Promise; /** * 查询工作流任务历史运行列表 */ ListWorkflowTaskRuns(req: ListWorkflowTaskRunsRequest, cb?: (error: string, rep: ListWorkflowTaskRunsResponse) => void): Promise; /** * 删除控制台用户组 */ DeleteConsoleGroups(req: DeleteConsoleGroupsRequest, cb?: (error: string, rep: DeleteConsoleGroupsResponse) => void): Promise; /** * 获取文件的元信息,可选包含文件内容,支持按版本读取历史快照。 **前置条件** 1. FileId 与 FilePath 二选一,至少传一个;同时传时以 FileId 为准; 2. 对应文件必须存在,且调用方对该文件有读权限; 3. 传 VersionId 时该版本必须存在。 **错误码(Module 均为 `Studio`)** | 错误码(Code) | InnerCode | 描述 | 处理建议 | | --- | --- | --- | --- | | `MissingParameter.WorkspaceId` | 1030001 | 缺少 WorkspaceId | 请传入 WorkspaceId | | `MissingParameter.FileId` | 1030003 | FileId 与 FilePath 同时为空 | FileId 与 FilePath 二选一,至少传一个 | | `InvalidParameterValue.FileType` | 1030102 | FileType 取值不支持 | FileType 取 FILE/NOTEBOOK_FILE/SQL_FILE | | `ResourceNotFound.FileNotFound` | 1030203 | 文件不存在或已删除 | 请确认 FileId 或 FilePath | | `ResourceNotFound.FileVersionNotFound` | 1030205 | 指定的文件版本不存在 | 请确认 VersionId,或调用 ListFileVersions 获取 | | `UnauthorizedOperation.FileReadDenied` | 1030304 | 对该文件无读权限 | 请联系文件负责人或空间管理员授权 | | `InternalError` | 1030900 | 服务内部异常 | 请携带 RequestId 联系支持 | */ GetFile(req: GetFileRequest, cb?: (error: string, rep: GetFileResponse) => void): Promise; /** * 查询工作流列表 */ ListWorkflows(req: ListWorkflowsRequest, cb?: (error: string, rep: ListWorkflowsResponse) => void): Promise; /** * 解绑工作流Bundle信息 说明:本接口语义等同于规范动词清单中的 Detach,因兼容既有产品形态保留 Unbind 命名 */ UnbindWorkflowBundle(req: UnbindWorkflowBundleRequest, cb?: (error: string, rep: UnbindWorkflowBundleResponse) => void): Promise; /** * 删除工作流 */ DeleteWorkflow(req: DeleteWorkflowRequest, cb?: (error: string, rep: DeleteWorkflowResponse) => void): Promise; /** * 将文件移入回收站(软删除),同时清理该文件的版本记录与执行结果快照。 **前置条件** 1. FileId 对应文件必须存在且为活跃状态; 2. 调用方对该文件有删除权限; 3. 文件未被工作流任务引用。 **错误码(Module 均为 `Studio`)** | 错误码(Code) | InnerCode | 描述 | 处理建议 | | --- | --- | --- | --- | | `MissingParameter.WorkspaceId` | 1030001 | 缺少 WorkspaceId | 请传入 WorkspaceId | | `MissingParameter.FileId` | 1030003 | 缺少 FileId | 请传入 FileId | | `InvalidParameterValue.FileType` | 1030102 | FileType 取值不支持 | FileType 取 FILE/NOTEBOOK_FILE/SQL_FILE | | `ResourceNotFound.FileNotFound` | 1030203 | 文件不存在或已删除 | 请确认 FileId | | `ResourceInUse.FileReferencedByTask` | 1030204 | 文件被工作流任务引用,不允许删除 | 请先解除任务引用后再删除 | | `UnauthorizedOperation.FileDeleteDenied` | 1030303 | 对该文件无删除权限 | 请联系文件负责人或空间管理员授权 | | `InternalError` | 1030900 | 服务内部异常 | 请携带 RequestId 联系支持 | */ DeleteFile(req: DeleteFileRequest, cb?: (error: string, rep: DeleteFileResponse) => void): Promise; /** * 创建控制台用户组 */ CreateConsoleGroup(req: CreateConsoleGroupRequest, cb?: (error: string, rep: CreateConsoleGroupResponse) => void): Promise; /** * 终止工作流的运行 */ KillWorkflowRun(req: KillWorkflowRunRequest, cb?: (error: string, rep: KillWorkflowRunResponse) => void): Promise; /** * 查询工作流运行详情 */ GetWorkflowRun(req: GetWorkflowRunRequest, cb?: (error: string, rep: GetWorkflowRunResponse) => void): Promise; /** * 查询控制台用户列表 */ ListConsoleUsers(req: ListConsoleUsersRequest, cb?: (error: string, rep: ListConsoleUsersResponse) => void): Promise; /** *

批量移除控制台用户(单次最多10个;前置校验任一不满足整体拒绝;执行阶段单个失败不中断后续删除,成败以 SuccessUins/FailItems 为准)

*/ RemoveConsoleUsers(req: RemoveConsoleUsersRequest, cb?: (error: string, rep: RemoveConsoleUsersResponse) => void): Promise; /** * 运行工作流 */ RunWorkflow(req: RunWorkflowRequest, cb?: (error: string, rep: RunWorkflowResponse) => void): Promise; /** * 查询控制台用户组列表 */ ListConsoleGroups(req: ListConsoleGroupsRequest, cb?: (error: string, rep: ListConsoleGroupsResponse) => void): Promise; /** * 查询控制台角色列表 */ ListConsoleRoles(req: ListConsoleRolesRequest, cb?: (error: string, rep: ListConsoleRolesResponse) => void): Promise; /** * 重跑工作流 */ RerunWorkflowRun(req: RerunWorkflowRunRequest, cb?: (error: string, rep: RerunWorkflowRunResponse) => void): Promise; /** * 修改控制台用户组 */ UpdateConsoleGroup(req: UpdateConsoleGroupRequest, cb?: (error: string, rep: UpdateConsoleGroupResponse) => void): Promise; /** * 创建工作流 */ CreateWorkflow(req: CreateWorkflowRequest, cb?: (error: string, rep: CreateWorkflowResponse) => void): Promise; /** * 更新文件内容与运行配置(计算资源、默认 catalog/schema、参数等),返回更新后的文件元信息。 **前置条件** 1. FileId 对应文件必须存在且为活跃状态; 2. 调用方对该文件有写权限; 3. 仅更新配置时不传 Storage;仅更新内容时不传 FileConfig; 4. FileConfig.ResourceId 非空时会校验资源类型与文件类型的匹配性。 **错误码(Module 均为 `Studio`)** | 错误码(Code) | InnerCode | 描述 | 处理建议 | | --- | --- | --- | --- | | `MissingParameter.WorkspaceId` | 1030001 | 缺少 WorkspaceId | 请传入 WorkspaceId | | `MissingParameter.FileId` | 1030003 | 缺少 FileId | 请传入 FileId | | `InvalidParameterValue.FileType` | 1030102 | FileType 取值不支持 | FileType 取 FILE/NOTEBOOK_FILE/SQL_FILE | | `InvalidParameterValue.ResourceId` | 1030104 | 计算资源类型与文件类型不匹配 | Python/Notebook 选数据计算资源,SQL 选数据分析资源 | | `ResourceNotFound.FileNotFound` | 1030203 | 文件不存在或已删除 | 请确认 FileId,或调用 GetFile 校验文件状态 | | `UnauthorizedOperation.FileWriteDenied` | 1030302 | 对该文件无写权限 | 请联系文件负责人或空间管理员授权 | | `FailedOperation.FileStorageUpdateFailed` | 1030401 | 文件内容写入存储失败 | 请稍后重试,持续失败请携带 RequestId 联系支持 | | `InternalError` | 1030900 | 服务内部异常 | 请携带 RequestId 联系支持 | */ UpdateFile(req: UpdateFileRequest, cb?: (error: string, rep: UpdateFileResponse) => void): Promise; /** * 修改控制台用户角色 */ UpdateConsoleUsers(req: UpdateConsoleUsersRequest, cb?: (error: string, rep: UpdateConsoleUsersResponse) => void): Promise; /** * 在Studio(统一开发 IDE)的工作空间文件树中新建一个文件(Notebook/SQL/Python等),创建成功后返回文件的完整元信息。 **前置条件** 1. WorkspaceId 对应工作空间存在,且调用方为该工作空间成员; 2. ParentFolderPath 对应的父文件夹必须存在,且调用方对其有写权限(根目录传 `/`); 3. FileName 在同一父文件夹下不能重名(含后缀比较); 4. FileName 后缀必须与 FileType 匹配(`.ipynb`↔`NOTEBOOK_FILE`、`.sql`↔`SQL_FILE`); 5. 需带文件内容创建时通过 Storage 传入(大文件走 COS 中转,小文件放 Storage.Content)。 */ CreateFile(req: CreateFileRequest, cb?: (error: string, rep: CreateFileResponse) => void): Promise; /** * 查询控制台用户组成员列表 */ ListConsoleGroupUsers(req: ListConsoleGroupUsersRequest, cb?: (error: string, rep: ListConsoleGroupUsersResponse) => void): Promise; /** * 工作流运行列表 */ ListWorkflowRuns(req: ListWorkflowRunsRequest, cb?: (error: string, rep: ListWorkflowRunsResponse) => void): Promise; }