@alicloud/dataworks-public20240518 8.4.1 → 8.6.0

package/dist/client.d.ts

@@ -108,6 +108,36 @@ export default class Client extends OpenApi {
      * @returns AttachDataQualityRulesToEvaluationTaskResponse
      */
     attachDataQualityRulesToEvaluationTask(request: $_model.AttachDataQualityRulesToEvaluationTaskRequest): Promise<$_model.AttachDataQualityRulesToEvaluationTaskResponse>;
+    /**
+     * Create multiple metadata entities at a time. The metadata entities in a batch must be of the same type. Only the pure custom type and the extended table type (corresponding to Database/Table) are supported.
+     *
+     * @param tmpReq - BatchCreateMetaEntitiesRequest
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns BatchCreateMetaEntitiesResponse
+     */
+    batchCreateMetaEntitiesWithOptions(tmpReq: $_model.BatchCreateMetaEntitiesRequest, runtime: $dara.RuntimeOptions): Promise<$_model.BatchCreateMetaEntitiesResponse>;
+    /**
+     * Create multiple metadata entities at a time. The metadata entities in a batch must be of the same type. Only the pure custom type and the extended table type (corresponding to Database/Table) are supported.
+     *
+     * @param request - BatchCreateMetaEntitiesRequest
+     * @returns BatchCreateMetaEntitiesResponse
+     */
+    batchCreateMetaEntities(request: $_model.BatchCreateMetaEntitiesRequest): Promise<$_model.BatchCreateMetaEntitiesResponse>;
+    /**
+     * Deletes metadata entity objects in batches. You can delete custom entities and extended table type objects (Database/Table). You cannot delete columns separately. To delete associated column objects, delete the table.
+     *
+     * @param tmpReq - BatchDeleteMetaEntitiesRequest
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns BatchDeleteMetaEntitiesResponse
+     */
+    batchDeleteMetaEntitiesWithOptions(tmpReq: $_model.BatchDeleteMetaEntitiesRequest, runtime: $dara.RuntimeOptions): Promise<$_model.BatchDeleteMetaEntitiesResponse>;
+    /**
+     * Deletes metadata entity objects in batches. You can delete custom entities and extended table type objects (Database/Table). You cannot delete columns separately. To delete associated column objects, delete the table.
+     *
+     * @param request - BatchDeleteMetaEntitiesRequest
+     * @returns BatchDeleteMetaEntitiesResponse
+     */
+    batchDeleteMetaEntities(request: $_model.BatchDeleteMetaEntitiesRequest): Promise<$_model.BatchDeleteMetaEntitiesResponse>;
     /**
      * Performs incremental updates on multiple tasks at a time.
      *
@@ -169,6 +199,21 @@ export default class Client extends OpenApi {
      * @returns CloneDataSourceResponse
      */
     cloneDataSource(request: $_model.CloneDataSourceRequest): Promise<$_model.CloneDataSourceResponse>;
+    /**
+     * 创建 Agent
+     *
+     * @param tmpReq - CreateAgentRequest
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns CreateAgentResponse
+     */
+    createAgentWithOptions(tmpReq: $_model.CreateAgentRequest, runtime: $dara.RuntimeOptions): Promise<$_model.CreateAgentResponse>;
+    /**
+     * 创建 Agent
+     *
+     * @param request - CreateAgentRequest
+     * @returns CreateAgentResponse
+     */
+    createAgent(request: $_model.CreateAgentRequest): Promise<$_model.CreateAgentResponse>;
     /**
      * Creates a new Agent session and returns the session ID.
      *
@@ -244,6 +289,21 @@ export default class Client extends OpenApi {
      * @returns CreateComputeResourceResponse
      */
     createComputeResource(request: $_model.CreateComputeResourceRequest): Promise<$_model.CreateComputeResourceResponse>;
+    /**
+     * Create a custom attribute
+     *
+     * @param tmpReq - CreateCustomAttributeRequest
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns CreateCustomAttributeResponse
+     */
+    createCustomAttributeWithOptions(tmpReq: $_model.CreateCustomAttributeRequest, runtime: $dara.RuntimeOptions): Promise<$_model.CreateCustomAttributeResponse>;
+    /**
+     * Create a custom attribute
+     *
+     * @param request - CreateCustomAttributeRequest
+     * @returns CreateCustomAttributeResponse
+     */
+    createCustomAttribute(request: $_model.CreateCustomAttributeRequest): Promise<$_model.CreateCustomAttributeResponse>;
     /**
      * Creates an alert rule for a synchronization task.
      *
@@ -651,6 +711,21 @@ export default class Client extends OpenApi {
      * @returns CreateMetaCollectionResponse
      */
     createMetaCollection(request: $_model.CreateMetaCollectionRequest): Promise<$_model.CreateMetaCollectionResponse>;
+    /**
+     * Creates metadata entity definitions (including pure custom types and extended table types)
+     *
+     * @param tmpReq - CreateMetaEntityDefRequest
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns CreateMetaEntityDefResponse
+     */
+    createMetaEntityDefWithOptions(tmpReq: $_model.CreateMetaEntityDefRequest, runtime: $dara.RuntimeOptions): Promise<$_model.CreateMetaEntityDefResponse>;
+    /**
+     * Creates metadata entity definitions (including pure custom types and extended table types)
+     *
+     * @param request - CreateMetaEntityDefRequest
+     * @returns CreateMetaEntityDefResponse
+     */
+    createMetaEntityDef(request: $_model.CreateMetaEntityDefRequest): Promise<$_model.CreateMetaEntityDefResponse>;
     /**
      * Creates a network and associates the network with a general resource group.
      *
@@ -915,6 +990,21 @@ export default class Client extends OpenApi {
      * @returns CreateWorkflowInstancesResponse
      */
     createWorkflowInstances(request: $_model.CreateWorkflowInstancesRequest): Promise<$_model.CreateWorkflowInstancesResponse>;
+    /**
+     * 删除 Agent
+     *
+     * @param request - DeleteAgentRequest
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns DeleteAgentResponse
+     */
+    deleteAgentWithOptions(request: $_model.DeleteAgentRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DeleteAgentResponse>;
+    /**
+     * 删除 Agent
+     *
+     * @param request - DeleteAgentRequest
+     * @returns DeleteAgentResponse
+     */
+    deleteAgent(request: $_model.DeleteAgentRequest): Promise<$_model.DeleteAgentResponse>;
     /**
      * Deletes a custom monitoring alert rule.
      *
@@ -1014,6 +1104,21 @@ export default class Client extends OpenApi {
      * @returns DeleteComputeResourceResponse
      */
     deleteComputeResource(request: $_model.DeleteComputeResourceRequest): Promise<$_model.DeleteComputeResourceResponse>;
+    /**
+     * Delete Custom Attribute
+     *
+     * @param request - DeleteCustomAttributeRequest
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns DeleteCustomAttributeResponse
+     */
+    deleteCustomAttributeWithOptions(request: $_model.DeleteCustomAttributeRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DeleteCustomAttributeResponse>;
+    /**
+     * Delete Custom Attribute
+     *
+     * @param request - DeleteCustomAttributeRequest
+     * @returns DeleteCustomAttributeResponse
+     */
+    deleteCustomAttribute(request: $_model.DeleteCustomAttributeRequest): Promise<$_model.DeleteCustomAttributeResponse>;
     /**
      * Deletes an alert rule configured for a synchronization task.
      *
@@ -1335,6 +1440,21 @@ export default class Client extends OpenApi {
      * @returns DeleteLineageRelationshipResponse
      */
     deleteLineageRelationship(request: $_model.DeleteLineageRelationshipRequest): Promise<$_model.DeleteLineageRelationshipResponse>;
+    /**
+     * 删除 MCP Server
+     *
+     * @param request - DeleteMcpServerRequest
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns DeleteMcpServerResponse
+     */
+    deleteMcpServerWithOptions(request: $_model.DeleteMcpServerRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DeleteMcpServerResponse>;
+    /**
+     * 删除 MCP Server
+     *
+     * @param request - DeleteMcpServerRequest
+     * @returns DeleteMcpServerResponse
+     */
+    deleteMcpServer(request: $_model.DeleteMcpServerRequest): Promise<$_model.DeleteMcpServerResponse>;
     /**
      * Deletes a collection in Data Map. Collections include categories and data albums. If you want to delete a data album, the account that you use must be attached the AliyunDataWorksFullAccess policy, or you are the data album creator or administrator.
      *
@@ -1350,6 +1470,21 @@ export default class Client extends OpenApi {
      * @returns DeleteMetaCollectionResponse
      */
     deleteMetaCollection(request: $_model.DeleteMetaCollectionRequest): Promise<$_model.DeleteMetaCollectionResponse>;
+    /**
+     * Delete metadata entity definitions (including pure custom types and extended table types)
+     *
+     * @param request - DeleteMetaEntityDefRequest
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns DeleteMetaEntityDefResponse
+     */
+    deleteMetaEntityDefWithOptions(request: $_model.DeleteMetaEntityDefRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DeleteMetaEntityDefResponse>;
+    /**
+     * Delete metadata entity definitions (including pure custom types and extended table types)
+     *
+     * @param request - DeleteMetaEntityDefRequest
+     * @returns DeleteMetaEntityDefResponse
+     */
+    deleteMetaEntityDef(request: $_model.DeleteMetaEntityDefRequest): Promise<$_model.DeleteMetaEntityDefResponse>;
     /**
      * Disassociates and deletes a network from a general resource group.
      *
@@ -1529,6 +1664,21 @@ export default class Client extends OpenApi {
      * @returns DeleteRouteResponse
      */
     deleteRoute(request: $_model.DeleteRouteRequest): Promise<$_model.DeleteRouteResponse>;
+    /**
+     * 删除 Skill
+     *
+     * @param request - DeleteSkillRequest
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns DeleteSkillResponse
+     */
+    deleteSkillWithOptions(request: $_model.DeleteSkillRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DeleteSkillResponse>;
+    /**
+     * 删除 Skill
+     *
+     * @param request - DeleteSkillRequest
+     * @returns DeleteSkillResponse
+     */
+    deleteSkill(request: $_model.DeleteSkillRequest): Promise<$_model.DeleteSkillResponse>;
     /**
      * Deletes a task.
      *
@@ -1721,6 +1871,21 @@ export default class Client extends OpenApi {
      * @returns ExecuteAdhocWorkflowInstanceResponse
      */
     executeAdhocWorkflowInstance(request: $_model.ExecuteAdhocWorkflowInstanceRequest): Promise<$_model.ExecuteAdhocWorkflowInstanceResponse>;
+    /**
+     * 读取 Agent 详情
+     *
+     * @param request - GetAgentRequest
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns GetAgentResponse
+     */
+    getAgentWithOptions(request: $_model.GetAgentRequest, runtime: $dara.RuntimeOptions): Promise<$_model.GetAgentResponse>;
+    /**
+     * 读取 Agent 详情
+     *
+     * @param request - GetAgentRequest
+     * @returns GetAgentResponse
+     */
+    getAgent(request: $_model.GetAgentRequest): Promise<$_model.GetAgentResponse>;
     /**
      * Obtains the metadata and body content of an Artifact based on the session ID and file path.
      *
@@ -1891,6 +2056,21 @@ export default class Client extends OpenApi {
      * @returns GetCreateWorkflowInstancesResultResponse
      */
     getCreateWorkflowInstancesResult(request: $_model.GetCreateWorkflowInstancesResultRequest): Promise<$_model.GetCreateWorkflowInstancesResultResponse>;
+    /**
+     * Obtain custom property definition details
+     *
+     * @param request - GetCustomAttributeRequest
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns GetCustomAttributeResponse
+     */
+    getCustomAttributeWithOptions(request: $_model.GetCustomAttributeRequest, runtime: $dara.RuntimeOptions): Promise<$_model.GetCustomAttributeResponse>;
+    /**
+     * Obtain custom property definition details
+     *
+     * @param request - GetCustomAttributeRequest
+     * @returns GetCustomAttributeResponse
+     */
+    getCustomAttribute(request: $_model.GetCustomAttributeRequest): Promise<$_model.GetCustomAttributeResponse>;
     /**
      * Queries the information about a synchronization task.
      *
@@ -2346,6 +2526,36 @@ export default class Client extends OpenApi {
      * @returns GetMetaCollectionResponse
      */
     getMetaCollection(request: $_model.GetMetaCollectionRequest): Promise<$_model.GetMetaCollectionResponse>;
+    /**
+     * Obtains the details of a metadata entity. Currently, only pure custom types are supported.
+     *
+     * @param request - GetMetaEntityRequest
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns GetMetaEntityResponse
+     */
+    getMetaEntityWithOptions(request: $_model.GetMetaEntityRequest, runtime: $dara.RuntimeOptions): Promise<$_model.GetMetaEntityResponse>;
+    /**
+     * Obtains the details of a metadata entity. Currently, only pure custom types are supported.
+     *
+     * @param request - GetMetaEntityRequest
+     * @returns GetMetaEntityResponse
+     */
+    getMetaEntity(request: $_model.GetMetaEntityRequest): Promise<$_model.GetMetaEntityResponse>;
+    /**
+     * Queries the details of a custom entity definition
+     *
+     * @param request - GetMetaEntityDefRequest
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns GetMetaEntityDefResponse
+     */
+    getMetaEntityDefWithOptions(request: $_model.GetMetaEntityDefRequest, runtime: $dara.RuntimeOptions): Promise<$_model.GetMetaEntityDefResponse>;
+    /**
+     * Queries the details of a custom entity definition
+     *
+     * @param request - GetMetaEntityDefRequest
+     * @returns GetMetaEntityDefResponse
+     */
+    getMetaEntityDef(request: $_model.GetMetaEntityDefRequest): Promise<$_model.GetMetaEntityDefResponse>;
     /**
      * Queries the information about a network resource.
      *
@@ -2960,6 +3170,21 @@ export default class Client extends OpenApi {
      * @returns ListCrawlerTypesResponse
      */
     listCrawlerTypes(): Promise<$_model.ListCrawlerTypesResponse>;
+    /**
+     * Querying a Custom Attribute Definition List
+     *
+     * @param request - ListCustomAttributesRequest
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns ListCustomAttributesResponse
+     */
+    listCustomAttributesWithOptions(request: $_model.ListCustomAttributesRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ListCustomAttributesResponse>;
+    /**
+     * Querying a Custom Attribute Definition List
+     *
+     * @param request - ListCustomAttributesRequest
+     * @returns ListCustomAttributesResponse
+     */
+    listCustomAttributes(request: $_model.ListCustomAttributesRequest): Promise<$_model.ListCustomAttributesResponse>;
     /**
      * Views alert rules configured for a synchronization task.
      *
@@ -3630,6 +3855,36 @@ export default class Client extends OpenApi {
      * @returns ListMetaCollectionsResponse
      */
     listMetaCollections(request: $_model.ListMetaCollectionsRequest): Promise<$_model.ListMetaCollectionsResponse>;
+    /**
+     * Queries the list of metadata entities. Currently, only custom types are supported.
+     *
+     * @param tmpReq - ListMetaEntitiesRequest
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns ListMetaEntitiesResponse
+     */
+    listMetaEntitiesWithOptions(tmpReq: $_model.ListMetaEntitiesRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ListMetaEntitiesResponse>;
+    /**
+     * Queries the list of metadata entities. Currently, only custom types are supported.
+     *
+     * @param request - ListMetaEntitiesRequest
+     * @returns ListMetaEntitiesResponse
+     */
+    listMetaEntities(request: $_model.ListMetaEntitiesRequest): Promise<$_model.ListMetaEntitiesResponse>;
+    /**
+     * Queries a list of custom entity definitions (including custom entity types and extended table types).
+     *
+     * @param request - ListMetaEntityDefsRequest
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns ListMetaEntityDefsResponse
+     */
+    listMetaEntityDefsWithOptions(request: $_model.ListMetaEntityDefsRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ListMetaEntityDefsResponse>;
+    /**
+     * Queries a list of custom entity definitions (including custom entity types and extended table types).
+     *
+     * @param request - ListMetaEntityDefsRequest
+     * @returns ListMetaEntityDefsResponse
+     */
+    listMetaEntityDefs(request: $_model.ListMetaEntityDefsRequest): Promise<$_model.ListMetaEntityDefsResponse>;
     /**
      * Queries a list of network resources of a serverless resource group.
      *
@@ -4698,11 +4953,11 @@ export default class Client extends OpenApi {
     /**
      * Updates the business metadata of a column in a table in Data Map. Only the business description of a column can be updated.
      *
-     * @param request - UpdateColumnBusinessMetadataRequest
+     * @param tmpReq - UpdateColumnBusinessMetadataRequest
      * @param runtime - runtime options for this request RuntimeOptions
      * @returns UpdateColumnBusinessMetadataResponse
      */
-    updateColumnBusinessMetadataWithOptions(request: $_model.UpdateColumnBusinessMetadataRequest, runtime: $dara.RuntimeOptions): Promise<$_model.UpdateColumnBusinessMetadataResponse>;
+    updateColumnBusinessMetadataWithOptions(tmpReq: $_model.UpdateColumnBusinessMetadataRequest, runtime: $dara.RuntimeOptions): Promise<$_model.UpdateColumnBusinessMetadataResponse>;
     /**
      * Updates the business metadata of a column in a table in Data Map. Only the business description of a column can be updated.
      *
@@ -4746,6 +5001,21 @@ export default class Client extends OpenApi {
      * @returns UpdateComputeResourceResponse
      */
     updateComputeResource(request: $_model.UpdateComputeResourceRequest): Promise<$_model.UpdateComputeResourceResponse>;
+    /**
+     * Updates custom attribute definitions
+     *
+     * @param tmpReq - UpdateCustomAttributeRequest
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns UpdateCustomAttributeResponse
+     */
+    updateCustomAttributeWithOptions(tmpReq: $_model.UpdateCustomAttributeRequest, runtime: $dara.RuntimeOptions): Promise<$_model.UpdateCustomAttributeResponse>;
+    /**
+     * Updates custom attribute definitions
+     *
+     * @param request - UpdateCustomAttributeRequest
+     * @returns UpdateCustomAttributeResponse
+     */
+    updateCustomAttribute(request: $_model.UpdateCustomAttributeRequest): Promise<$_model.UpdateCustomAttributeResponse>;
     /**
      * Updates an alert rule configured for a synchronization task.
      *
@@ -5055,6 +5325,36 @@ export default class Client extends OpenApi {
      * @returns UpdateMetaCollectionResponse
      */
     updateMetaCollection(request: $_model.UpdateMetaCollectionRequest): Promise<$_model.UpdateMetaCollectionResponse>;
+    /**
+     * Updates metadata entities. You can update custom objects or extended table objects (Database, Table, and Column).
+     *
+     * @param tmpReq - UpdateMetaEntityRequest
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns UpdateMetaEntityResponse
+     */
+    updateMetaEntityWithOptions(tmpReq: $_model.UpdateMetaEntityRequest, runtime: $dara.RuntimeOptions): Promise<$_model.UpdateMetaEntityResponse>;
+    /**
+     * Updates metadata entities. You can update custom objects or extended table objects (Database, Table, and Column).
+     *
+     * @param request - UpdateMetaEntityRequest
+     * @returns UpdateMetaEntityResponse
+     */
+    updateMetaEntity(request: $_model.UpdateMetaEntityRequest): Promise<$_model.UpdateMetaEntityResponse>;
+    /**
+     * Updates metadata entity definitions (including pure custom types and extended table types)
+     *
+     * @param tmpReq - UpdateMetaEntityDefRequest
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns UpdateMetaEntityDefResponse
+     */
+    updateMetaEntityDefWithOptions(tmpReq: $_model.UpdateMetaEntityDefRequest, runtime: $dara.RuntimeOptions): Promise<$_model.UpdateMetaEntityDefResponse>;
+    /**
+     * Updates metadata entity definitions (including pure custom types and extended table types)
+     *
+     * @param request - UpdateMetaEntityDefRequest
+     * @returns UpdateMetaEntityDefResponse
+     */
+    updateMetaEntityDef(request: $_model.UpdateMetaEntityDefRequest): Promise<$_model.UpdateMetaEntityDefResponse>;
     /**
      * Updates the basic information about a node in DataStudio. This API operation performs an incremental update. The update information is described by using FlowSpec.
      *
@@ -5176,11 +5476,11 @@ export default class Client extends OpenApi {
     /**
      * Updates the business metadata of a table in Data Map. Currently, only the usage notes of a table can be updated.
      *
-     * @param request - UpdateTableBusinessMetadataRequest
+     * @param tmpReq - UpdateTableBusinessMetadataRequest
      * @param runtime - runtime options for this request RuntimeOptions
      * @returns UpdateTableBusinessMetadataResponse
      */
-    updateTableBusinessMetadataWithOptions(request: $_model.UpdateTableBusinessMetadataRequest, runtime: $dara.RuntimeOptions): Promise<$_model.UpdateTableBusinessMetadataResponse>;
+    updateTableBusinessMetadataWithOptions(tmpReq: $_model.UpdateTableBusinessMetadataRequest, runtime: $dara.RuntimeOptions): Promise<$_model.UpdateTableBusinessMetadataResponse>;
     /**
      * Updates the business metadata of a table in Data Map. Currently, only the usage notes of a table can be updated.
      *