@alicloud/dataworks-public20240518 7.2.0 → 7.2.2

package/src/models/CreateDijobShrinkRequest.ts

@@ -3,131 +3,50 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class CreateDIJobShrinkRequest extends $dara.Model {
-  /**
-   * @remarks
-   * The description of the synchronization task.
-   * 
-   * @example
-   * The description of the synchronization task.
-   */
   description?: string;
   /**
    * @remarks
-   * The settings of the destination. Only a single destination is supported.
-   * 
    * This parameter is required.
    */
   destinationDataSourceSettingsShrink?: string;
   /**
    * @remarks
-   * The destination type. Valid values: Hologres, OSS-HDFS, OSS, MaxCompute, LogHub, StarRocks, DataHub, AnalyticDB for MySQL, Kafka, and Hive.
-   * 
    * This parameter is required.
-   * 
-   * @example
-   * Hologres
    */
   destinationDataSourceType?: string;
   /**
-   * @remarks
-   * This parameter is deprecated and is replaced by the Name parameter.
-   * 
-   * @example
-   * mysql_to_holo_sync_8772
-   * 
    * @deprecated
    */
   jobName?: string;
-  /**
-   * @remarks
-   * The settings for the dimension of the synchronization task. The settings include processing policies for DDL messages, policies for data type mappings between source fields and destination fields, and runtime parameters of the synchronization task.
-   */
   jobSettingsShrink?: string;
-  /**
-   * @remarks
-   * The type of the task. This parameter is optional. Valid values:
-   * 
-   * *   DatabaseRealtimeMigration: A real-time synchronization task used to synchronize only full data, only incremental data, or full and incremental data in multiple tables of multiple databases at the source.
-   * *   DatabaseOfflineMigration: A batch synchronization task used to synchronize only full data, only incremental data, or full and incremental data in multiple tables of multiple databases at the source.
-   * *   SingleTableRealtimeMigration: A real-time synchronization task used to synchronize only data in single table at the source.
-   * 
-   * @example
-   * DatabaseRealtimeMigration
-   */
   jobType?: string;
   /**
    * @remarks
-   * The synchronization type. Valid values:
-   * 
-   * *   FullAndRealtimeIncremental: full synchronization and real-time incremental synchronization of data in an entire database
-   * *   RealtimeIncremental: real-time incremental synchronization of data in a single table
-   * *   Full: full batch synchronization of data in an entire database
-   * *   OfflineIncremental: batch incremental synchronization of data in an entire database
-   * *   FullAndOfflineIncremental: full synchronization and batch incremental synchronization of data in an entire database
-   * 
    * This parameter is required.
-   * 
-   * @example
-   * FullAndRealtimeIncremental
    */
   migrationType?: string;
-  /**
-   * @remarks
-   * The name of the synchronization task.
-   * 
-   * @example
-   * mysql_to_holo_sync_8772
-   */
   name?: string;
-  /**
-   * @remarks
-   * The DataWorks workspace ID. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the Workspace page to query the ID.
-   * 
-   * You must configure this parameter to specify the DataWorks workspace to which the API operation is applied.
-   * 
-   * @example
-   * 10000
-   */
   projectId?: number;
   /**
    * @remarks
-   * The resource settings.
-   * 
    * This parameter is required.
    */
   resourceSettingsShrink?: string;
   /**
    * @remarks
-   * The settings of the source. Only a single source is supported.
-   * 
    * This parameter is required.
    */
   sourceDataSourceSettingsShrink?: string;
   /**
    * @remarks
-   * The source type. Valid values: PolarDB, MySQL, Kafka, LogHub, Hologres, Oracle, OceanBase, MongoDB, Redshift, Hive, SQL Server, Doris, and ClickHouse.
-   * 
    * This parameter is required.
-   * 
-   * @example
-   * MySQL
    */
   sourceDataSourceType?: string;
   /**
    * @remarks
-   * The list of mappings between rules used to select synchronization objects in the source and transformation rules applied to the selected synchronization objects. Each entry in the list displays a mapping between a rule used to select synchronization objects and a transformation rule applied to the selected synchronization objects.
-   * 
-   * >  [ { "SourceObjectSelectionRules":[ { "ObjectType":"Database", "Action":"Include", "ExpressionType":"Exact", "Expression":"biz_db" }, { "ObjectType":"Schema", "Action":"Include", "ExpressionType":"Exact", "Expression":"s1" }, { "ObjectType":"Table", "Action":"Include", "ExpressionType":"Exact", "Expression":"table1" } ], "TransformationRuleNames":[ { "RuleName":"my_database_rename_rule", "RuleActionType":"Rename", "RuleTargetType":"Schema" } ] } ]
-   * 
    * This parameter is required.
    */
   tableMappingsShrink?: string;
-  /**
-   * @remarks
-   * The list of transformation rules for objects involved in the synchronization task.
-   * 
-   * >  [ { "RuleName":"my_database_rename_rule", "RuleActionType":"Rename", "RuleTargetType":"Schema", "RuleExpression":"{"expression":"${srcDatasoureName}_${srcDatabaseName}"}" } ]
-   */
   transformationRulesShrink?: string;
   static names(): { [key: string]: string } {
     return {

package/src/models/CreateLineageRelationshipRequest.ts

@@ -7,6 +7,10 @@ import { LineageTask } from "./LineageTask";
 export class CreateLineageRelationshipRequest extends $dara.Model {
   dstEntity?: LineageEntity;
   srcEntity?: LineageEntity;
+  /**
+   * @remarks
+   * The task information.
+   */
   task?: LineageTask;
   static names(): { [key: string]: string } {
     return {

package/src/models/CreateLineageRelationshipResponseBody.ts

@@ -4,6 +4,9 @@ import * as $dara from '@darabonba/typescript';
 
 export class CreateLineageRelationshipResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The lineage ID.
+   * 
    * @example
    * 110xxxx:custom-table.xxxxx:maxcompute-table.project.test_big_lineage_080901:custom-sqlxx.00001
    */

package/src/models/CreateLineageRelationshipShrinkRequest.ts

@@ -5,6 +5,10 @@ import * as $dara from '@darabonba/typescript';
 export class CreateLineageRelationshipShrinkRequest extends $dara.Model {
   dstEntityShrink?: string;
   srcEntityShrink?: string;
+  /**
+   * @remarks
+   * The task information.
+   */
   taskShrink?: string;
   static names(): { [key: string]: string } {
     return {

package/src/models/CreateMetaCollectionRequest.ts

@@ -17,6 +17,9 @@ export class CreateMetaCollectionRequest extends $dara.Model {
    */
   name?: string;
   /**
+   * @remarks
+   * The ID of the collection of an ancestor node.
+   * 
    * @example
    * category.123
    */

package/src/models/CreateMetaCollectionResponseBody.ts

@@ -4,6 +4,9 @@ import * as $dara from '@darabonba/typescript';
 
 export class CreateMetaCollectionResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The ID of the created collection.
+   * 
    * @example
    * category.123
    */

package/src/models/CreateWorkflowInstancesRequestDefaultRunProperties.ts

@@ -69,6 +69,7 @@ export class CreateWorkflowInstancesRequestDefaultRunProperties extends $dara.Mo
    */
   parallelism?: number;
   priority?: number;
+  priorityWeightStrategy?: string;
   /**
    * @remarks
    * The root task IDs.
@@ -104,6 +105,7 @@ export class CreateWorkflowInstancesRequestDefaultRunProperties extends $dara.Mo
       order: 'Order',
       parallelism: 'Parallelism',
       priority: 'Priority',
+      priorityWeightStrategy: 'PriorityWeightStrategy',
       rootTaskIds: 'RootTaskIds',
       runPolicy: 'RunPolicy',
       runtimeResource: 'RuntimeResource',
@@ -122,6 +124,7 @@ export class CreateWorkflowInstancesRequestDefaultRunProperties extends $dara.Mo
       order: 'string',
       parallelism: 'number',
       priority: 'number',
+      priorityWeightStrategy: 'string',
       rootTaskIds: { 'type': 'array', 'itemType': 'number' },
       runPolicy: CreateWorkflowInstancesRequestDefaultRunPropertiesRunPolicy,
       runtimeResource: 'string',

package/src/models/DeleteLineageRelationshipRequest.ts

@@ -5,6 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class DeleteLineageRelationshipRequest extends $dara.Model {
   /**
    * @remarks
+   * The lineage ID. For more information, see the response returned by the ListLineageRelationships operation.
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/DeleteMetaCollectionRequest.ts

@@ -5,6 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class DeleteMetaCollectionRequest extends $dara.Model {
   /**
    * @remarks
+   * The collection ID.
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/GetCatalogRequest.ts

@@ -5,6 +5,17 @@ import * as $dara from '@darabonba/typescript';
 export class GetCatalogRequest extends $dara.Model {
   /**
    * @remarks
+   * Data catalog entity ID. Currently, only DLF and StarRocks types are supported. You can refer to the response of the ListCatalogs operation and [the description of metadata entity concepts.](https://help.aliyun.com/document_detail/2880092.html)
+   * 
+   * *   For the DLF type, the format is `dlf-catalog::catalog_id`.
+   * *   For the StarRocks type, the format is `starrocks-catalog:(instance_id|encoded_jdbc_url):catalog_name`.
+   * 
+   * >  Parameter descriptions:\\
+   * `catalog_id`: The DLF catalog ID.\\
+   * `instance_id`: The instance ID, required for the data source registered in instance mode.\\
+   * `encoded_jdbc_url`: The JDBC connection string that has been URL encoded, required for the data source registered via a connection string.\\
+   * `catalog_name`: The name of the StarRocks catalog.
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/GetColumnRequest.ts

@@ -5,6 +5,36 @@ import * as $dara from '@darabonba/typescript';
 export class GetColumnRequest extends $dara.Model {
   /**
    * @remarks
+   * The ID. You can refer to the response of the ListColumns operation and the [description of concepts related to metadata entities.](https://help.aliyun.com/document_detail/2880092.html)
+   * 
+   * The format: `${EntityType}:${Instance ID or escaped URL}:${Catalog name}:${Database name}`. Use empty strings as placeholders for levels that do not exist.
+   * 
+   * >  For the MaxCompute and DLF types, the instance ID level must be left empty. For the MaxCompute type, the instance ID level is represented by an empty string. The database name is the name of the MaxCompute project with schema enabled.
+   * 
+   * >  The catalog identifier of the StarRocks is the catalog name, and the catalog identifier of the DLF type is the catalog ID. Other types do not support catalog levels and can use empty strings as placeholders.
+   * 
+   * Examples of common ID formats
+   * 
+   * `maxcompute-column:::project_name:[schema_name]:table_name:column_name`
+   * 
+   * `dlf-column::catalog_id:database_name::table_name:column_name`
+   * 
+   * `hms-column:instance_id::database_name::table_name:column_name`
+   * 
+   * `holo-column:instance_id::database_name:schema_name:table_name:column_name`
+   * 
+   * `mysql-column:(instance_id|encoded_jdbc_url)::database_name::table_name:column_name`
+   * 
+   * > \\
+   * `instance_id`: the ID of the instance, which is required when the data source is registered in instance mode.\\
+   * `encoded_jdbc_url`: the URL-encoded JDBC connection string, which is required when the data source is registered via a connection string.\\
+   * `catalog_id`: The DLF catalog ID.\\
+   * `project_name`: The MaxCompute project name.\\
+   * `database_name`: The database name.\\
+   * `schema_name`: The schema name. For the MaxCompute type, this is required only if the project has enabled schema; otherwise, use an empty string as a placeholder.\\
+   * `table_name`: The table name.\\
+   * `column_name`: The field name.
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/GetDatabaseRequest.ts

@@ -5,6 +5,26 @@ import * as $dara from '@darabonba/typescript';
 export class GetDatabaseRequest extends $dara.Model {
   /**
    * @remarks
+   * Database entity ID. You can refer to the response of the ListDatabases operation and [the description of metadata entity concepts.](https://help.aliyun.com/document_detail/2880092.html)
+   * 
+   * The format is `${EntityType}:${Instance ID or encoded URL}:${Catalog identifier}:${Database name}`. Use empty strings as placeholders for non-existent levels.
+   * 
+   * >  For StarRocks, the catalog identifier is the catalog name. For DLF, the catalog identifier is the catalog ID. For other types, catalog hierarchy is not supported, and an empty string can be used as a placeholder.
+   * 
+   * Examples of common ID formats
+   * 
+   * `dlf-database::catalog_id:database_name`
+   * 
+   * `holo-database:instance_id::database_name`
+   * 
+   * `mysql-database:(instance_id|encoded_jdbc_url)::database_name`
+   * 
+   * >  Parameter descriptions\\
+   * `catalog_id`: The DLF catalog ID.\\
+   * `instance_id`: The instance ID, required for a data source registered in instance mode.\\
+   * `encoded_jdbc_url`: The JDBC connection string that has been URL encoded. This parameter is required for the data source registered via a connection string.\\
+   * `database_name`: The database name.
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/GetLineageRelationshipRequest.ts

@@ -5,6 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class GetLineageRelationshipRequest extends $dara.Model {
   /**
    * @remarks
+   * The lineage ID. For more information, see the response returned by the ListLineageRelationships operation.
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/GetMetaCollectionRequest.ts

@@ -5,6 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class GetMetaCollectionRequest extends $dara.Model {
   /**
    * @remarks
+   * The collection ID.
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/GetMetaCollectionResponseBody.ts

@@ -4,6 +4,10 @@ import { GetMetaCollectionResponseBodyMetaCollection } from "./GetMetaCollection
 
 
 export class GetMetaCollectionResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The information about the collection.
+   */
   metaCollection?: GetMetaCollectionResponseBodyMetaCollection;
   /**
    * @remarks

package/src/models/GetMetaCollectionResponseBodyMetaCollection.ts

@@ -16,6 +16,9 @@ export class GetMetaCollectionResponseBodyMetaCollection extends $dara.Model {
   createUser?: string;
   description?: string;
   /**
+   * @remarks
+   * The collection ID.
+   * 
    * @example
    * category.123
    */
@@ -31,6 +34,9 @@ export class GetMetaCollectionResponseBodyMetaCollection extends $dara.Model {
    */
   name?: string;
   /**
+   * @remarks
+   * The ID of the collection of the ancestor node. This parameter can be left empty.
+   * 
    * @example
    * category.12
    */

package/src/models/GetPartitionRequest.ts

@@ -13,6 +13,8 @@ export class GetPartitionRequest extends $dara.Model {
   name?: string;
   /**
    * @remarks
+   * The table ID. For more details, refer to the response of the ListTables operation and [description of concepts related to metadata entities.](https://help.aliyun.com/document_detail/2880092.html)
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/GetRerunWorkflowInstancesResultRequest.ts

@@ -5,6 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class GetRerunWorkflowInstancesResultRequest extends $dara.Model {
   /**
    * @remarks
+   * The operation ID used to asynchronously query the result of the workflow instance rerun. This value is obtained from the RerunWorkflowInstances operation.
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/GetRerunWorkflowInstancesResultResponseBody.ts

@@ -5,10 +5,17 @@ import { GetRerunWorkflowInstancesResultResponseBodyResult } from "./GetRerunWor
 
 export class GetRerunWorkflowInstancesResultResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The request ID, used for log tracing and troubleshooting.
+   * 
    * @example
    * 22C97E95-F023-56B5-8852-B1A77A17XXXX
    */
   requestId?: string;
+  /**
+   * @remarks
+   * The result of the workflow instance rerun.
+   */
   result?: GetRerunWorkflowInstancesResultResponseBodyResult;
   static names(): { [key: string]: string } {
     return {

package/src/models/GetRerunWorkflowInstancesResultResponseBodyResult.ts

@@ -3,8 +3,18 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class GetRerunWorkflowInstancesResultResponseBodyResult extends $dara.Model {
+  /**
+   * @remarks
+   * The failure message. Returned if the rerun fails.
+   * 
+   * @example
+   * Invalid Param xxx
+   */
   failureMessage?: string;
   /**
+   * @remarks
+   * The status. NotRun Success Failure
+   * 
    * @example
    * Success
    */

package/src/models/GetSchemaRequest.ts

@@ -5,11 +5,23 @@ import * as $dara from '@darabonba/typescript';
 export class GetSchemaRequest extends $dara.Model {
   /**
    * @remarks
-   * The schema ID. You can call the ListSchemas operation to query schema IDs. For more information, see [Concepts related to metadata entities](https://help.aliyun.com/document_detail/2880092.html).
+   * The schema ID. You can call the ListSchemas operation to query the ID. For more information, see [Concepts related to metadata entities](https://help.aliyun.com/document_detail/2880092.html).
    * 
-   * Configure this parameter in the `${Entity type}:${Instance ID or escaped URL}:${Catalog identifier}:${Database name}:${Schema name}` format. If a level does not exist, leave the level empty.
+   * The common format of this parameter is `${Entity type}:${Instance ID or escaped URL}:${Catalog identifier}:${Database name}:${Schema name}`. If a level does not exist, specify an empty string as a placeholder.
    * 
-   * >  If you want to query the information about a MaxCompute schema, specify an empty string at the Instance ID level as a placeholder and a MaxCompute project name at the Database name level. Make sure that the schema feature is enabled for the MaxCompute project.
+   * >  For MaxCompute tables, specify an empty string at the Instance ID level and a MaxCompute project name at the Database name level. Make sure that the three-layer model is enabled for the MaxCompute project.
+   * 
+   * You can configure this parameter in one of the following formats based on your data source type:
+   * 
+   * `maxcompute-schema:::project_name:schema_name` (Three-layer model is enabled for the MaxCompute project.)
+   * 
+   * `holo-schema:instance_id::database_name:schema_name`
+   * 
+   * > \\
+   * `instance_id`: the ID of a Hologres instance\\
+   * `database_name`: the name of a database\\
+   * `project_name`: the name of a MaxCompute project\\
+   * `schema_name`: the name of a schema
    * 
    * This parameter is required.
    * 

package/src/models/GetTableRequest.ts

@@ -5,6 +5,37 @@ import * as $dara from '@darabonba/typescript';
 export class GetTableRequest extends $dara.Model {
   /**
    * @remarks
+   * The table ID. For more information, see [Concepts related to metadata entities](https://help.aliyun.com/document_detail/2880092.html).
+   * 
+   * The common format of this parameter is `${Entity type}:${Instance ID or escaped URL}:${Catalog identifier}:${Database name}:${Schema name}:${Table name}`. If a level does not exist, specify an empty string as a placeholder.
+   * 
+   * >  For MaxCompute and DLF data sources, specify an empty string at the Instance ID level.
+   * 
+   * >  For StarRocks data sources, specify a catalog name at the Catalog identifier level. For DLF data sources, specify a catalog ID at the Catalog identifier level. Other types of data sources do not support the Catalog identifier level. You can specify an empty string as a placeholder.
+   * 
+   * >  For MaxCompute data sources, specify a MaxCompute project name at the Database name level. If the three-layer model is enabled for your MaxCompute project, you must specify a schema name at the Schema name level. Otherwise, you can specify an empty string as a placeholder.
+   * 
+   * You can configure this parameter in one of the following formats based on your data source type:
+   * 
+   * `maxcompute-table:::project_name:[schema_name]:table_name`
+   * 
+   * `dlf-table::catalog_id:database_name::table_name`
+   * 
+   * `hms-table:instance_id::database_name::table_name`
+   * 
+   * `holo-table:instance_id::database_name:schema_name:table_name`
+   * 
+   * `mysql-table:(instance_id|encoded_jdbc_url)::database_name::table_name`
+   * 
+   * > \\
+   * `instance_id`: the ID of an instance. If the related data source is added to DataWorks in Alibaba Cloud instance mode, you must configure this parameter.\\
+   * `encoded_jdbc_url`: the JDBC connection string that is URL-encoded. If the related data source is added to DataWorks in connection string mode, you must configure this parameter.\\
+   * `catalog_id`: the ID of a DLF catalog.\\
+   * `project_name`: the name of a MaxCompute project.\\
+   * `database_name`: the name of a database.\\
+   * `schema_name`: the name of a schema. For a MaxCompute table, if the three-layer model is enabled for the MaxCompute project to which the table belongs, you must configure this parameter. Otherwise, you can specify an empty string for schema_name as a placeholder.\\
+   * `table_name`: the name of a table.
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/GetTaskInstanceResponseBody.ts

@@ -14,7 +14,7 @@ export class GetTaskInstanceResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * The details of the instance.
+   * The details of the task instance.
    */
   taskInstance?: GetTaskInstanceResponseBodyTaskInstance;
   static names(): { [key: string]: string } {

package/src/models/GetTaskInstanceResponseBodyTaskInstance.ts

@@ -270,7 +270,15 @@ export class GetTaskInstanceResponseBodyTaskInstance extends $dara.Model {
    * Scheduler
    */
   triggerType?: string;
+  /**
+   * @example
+   * 1710239005403
+   */
   waitingResourceTime?: number;
+  /**
+   * @example
+   * 1710239005403
+   */
   waitingTriggerTime?: number;
   /**
    * @remarks

package/src/models/ListCatalogsRequest.ts

@@ -30,6 +30,17 @@ export class ListCatalogsRequest extends $dara.Model {
   pageSize?: number;
   /**
    * @remarks
+   * The parent entity ID. For more information, see [Concepts related to metadata entities](https://help.aliyun.com/document_detail/2880092.html).
+   * 
+   * Only DLF and StarRocks data sources support this parameter.
+   * 
+   * *   For DLF data sources, you can call this API operation to query all catalogs. In this case, you must set the `ParentMetaEntityId` parameter to `dlf`.
+   * *   For StarRocks data sources, you can call this API operation to query the catalogs in a specific instance. In this case, you can configure the `ParentMetaEntityId` parameter in the `starrocks:(instance_id|encoded_jdbc_url)` format.
+   * 
+   * > \\
+   * `instance_id`: the ID of an instance. If the related data source is added to DataWorks in Alibaba Cloud instance mode, you must configure this parameter.\\
+   * `encoded_jdbc_url`: the JDBC connection string that is URL-encoded. If the related data source is added to DataWorks in connection string mode, you must configure this parameter.
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/ListCatalogsShrinkRequest.ts

@@ -30,6 +30,17 @@ export class ListCatalogsShrinkRequest extends $dara.Model {
   pageSize?: number;
   /**
    * @remarks
+   * The parent entity ID. For more information, see [Concepts related to metadata entities](https://help.aliyun.com/document_detail/2880092.html).
+   * 
+   * Only DLF and StarRocks data sources support this parameter.
+   * 
+   * *   For DLF data sources, you can call this API operation to query all catalogs. In this case, you must set the `ParentMetaEntityId` parameter to `dlf`.
+   * *   For StarRocks data sources, you can call this API operation to query the catalogs in a specific instance. In this case, you can configure the `ParentMetaEntityId` parameter in the `starrocks:(instance_id|encoded_jdbc_url)` format.
+   * 
+   * > \\
+   * `instance_id`: the ID of an instance. If the related data source is added to DataWorks in Alibaba Cloud instance mode, you must configure this parameter.\\
+   * `encoded_jdbc_url`: the JDBC connection string that is URL-encoded. If the related data source is added to DataWorks in connection string mode, you must configure this parameter.
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/ListColumnsRequest.ts

@@ -35,6 +35,8 @@ export class ListColumnsRequest extends $dara.Model {
   sortBy?: string;
   /**
    * @remarks
+   * The ID of the table to which the columns belong. You can call the ListTables operation to query the ID. For more information, see [Concepts related to metadata entities](https://help.aliyun.com/document_detail/2880092.html).
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/ListDatabasesRequest.ts

@@ -30,6 +30,26 @@ export class ListDatabasesRequest extends $dara.Model {
   pageSize?: number;
   /**
    * @remarks
+   * The parent entity ID. For more information, see [description of concepts related to metadata entities.](https://help.aliyun.com/document_detail/2880092.html)
+   * 
+   * The type of the parent entity can be found in the response of the ListCrawlerTypes operation.
+   * 
+   * *   If the parent entity is a catalog, the format of `ParentMetaEntityId` follows the response of the ListCatalogs API.
+   * *   If the parent entity is a metadata crawler, the format of `ParentMetaEntityId` is `${CrawlerType}:${Instance ID or encoded URL}.`
+   * 
+   * ParentMetaEntityId format examples
+   * 
+   * `dlf-catalog::catalog_id`
+   * 
+   * `holo:instance_id`
+   * 
+   * `mysql:(instance_id|encoded_jdbc_url)`
+   * 
+   * > \\
+   * `catalog_id`: The DLF catalog ID.\\
+   * `instance_id`: The instance ID, required for the data source registered in instance mode.\\
+   * `encoded_jdbc_url`: The JDBC connection string that has been URL encoded, required for the data source registered via a connection string.
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/ListEntitiesInMetaCollectionRequest.ts

@@ -16,6 +16,8 @@ export class ListEntitiesInMetaCollectionRequest extends $dara.Model {
   entityType?: string;
   /**
    * @remarks
+   * The collection ID.
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/ListEntitiesInMetaCollectionResponseBody.ts

@@ -4,6 +4,10 @@ import { ListEntitiesInMetaCollectionResponseBodyPagingInfo } from "./ListEntiti
 
 
 export class ListEntitiesInMetaCollectionResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The pagination information.
+   */
   pagingInfo?: ListEntitiesInMetaCollectionResponseBodyPagingInfo;
   /**
    * @remarks

package/src/models/ListEntitiesInMetaCollectionResponseBodyPagingInfo.ts

@@ -4,6 +4,10 @@ import { ListEntitiesInMetaCollectionResponseBodyPagingInfoEntities } from "./Li
 
 
 export class ListEntitiesInMetaCollectionResponseBodyPagingInfo extends $dara.Model {
+  /**
+   * @remarks
+   * The entities in the collection.
+   */
   entities?: ListEntitiesInMetaCollectionResponseBodyPagingInfoEntities[];
   /**
    * @example

package/src/models/ListEntitiesInMetaCollectionResponseBodyPagingInfoEntities.ts

@@ -11,6 +11,9 @@ export class ListEntitiesInMetaCollectionResponseBodyPagingInfoEntities extends
   createTime?: number;
   description?: string;
   /**
+   * @remarks
+   * The entity ID. Entities can only be tables. This parameter is left empty if the entity is deleted.
+   * 
    * @example
    * dlf-table:123456789:test_catalog:test_database::test_table
    */
@@ -26,6 +29,9 @@ export class ListEntitiesInMetaCollectionResponseBodyPagingInfoEntities extends
    */
   name?: string;
   /**
+   * @remarks
+   * The type of the entity.
+   * 
    * @example
    * dlf-table
    */