@alicloud/dataworks-public20240518 7.2.0 → 7.2.2

package/src/models/ListLineageRelationshipsRequest.ts

@@ -5,6 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class ListLineageRelationshipsRequest extends $dara.Model {
   /**
    * @remarks
+   * The destination entity ID. For more information, see the table ID or field ID in the response returned by the ListTables or ListColumns operation. You can also specify a custom entity ID.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -43,6 +45,8 @@ export class ListLineageRelationshipsRequest extends $dara.Model {
   sortBy?: string;
   /**
    * @remarks
+   * The source entity ID. For more information, see the table ID or field ID in the response returned by the ListTables or ListColumns operation. You can also specify a custom entity ID.
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/ListLineagesRequest.ts

@@ -4,6 +4,9 @@ import * as $dara from '@darabonba/typescript';
 
 export class ListLineagesRequest extends $dara.Model {
   /**
+   * @remarks
+   * The destination entity ID. For more information, see the table ID or field ID in the response returned by the ListTables or ListColumns operation. You can also specify a custom entity ID.
+   * 
    * @example
    * maxcompute-table:123456XXX::test_project::test_tbl
    * dlf-table:123456XXX:test_catalog:test_db::test_tbl
@@ -44,6 +47,9 @@ export class ListLineagesRequest extends $dara.Model {
    */
   sortBy?: string;
   /**
+   * @remarks
+   * The source entity ID. For more information, see the table ID or field ID in the response returned by the ListTables or ListColumns operation. You can also specify a custom entity ID.
+   * 
    * @example
    * maxcompute-table:123456XXX::test_project::test_tbl
    * dlf-table:123456XXX:test_catalog:test_db::test_tbl

package/src/models/ListMetaCollectionsRequest.ts

@@ -35,6 +35,9 @@ export class ListMetaCollectionsRequest extends $dara.Model {
    */
   pageSize?: number;
   /**
+   * @remarks
+   * The ID of the collection of an ancestor node.
+   * 
    * @example
    * category.123
    */
@@ -46,6 +49,12 @@ export class ListMetaCollectionsRequest extends $dara.Model {
   sortBy?: string;
   /**
    * @remarks
+   * The type of the collection. Valid values:
+   * 
+   * *   Category
+   * *   Album
+   * *   AlbumCategory
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/ListMetaCollectionsResponseBody.ts

@@ -4,6 +4,10 @@ import { ListMetaCollectionsResponseBodyData } from "./ListMetaCollectionsRespon
 
 
 export class ListMetaCollectionsResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The data.
+   */
   data?: ListMetaCollectionsResponseBodyData;
   /**
    * @remarks

package/src/models/ListMetaCollectionsResponseBodyData.ts

@@ -4,6 +4,10 @@ import { ListMetaCollectionsResponseBodyDataMetaCollections } from "./ListMetaCo
 
 
 export class ListMetaCollectionsResponseBodyData extends $dara.Model {
+  /**
+   * @remarks
+   * The collections.
+   */
   metaCollections?: ListMetaCollectionsResponseBodyDataMetaCollections[];
   /**
    * @example

package/src/models/ListMetaCollectionsResponseBodyDataMetaCollections.ts

@@ -5,6 +5,9 @@ import * as $dara from '@darabonba/typescript';
 export class ListMetaCollectionsResponseBodyDataMetaCollections extends $dara.Model {
   administrators?: string[];
   /**
+   * @remarks
+   * The time when the collection was created. The value is a UNIX timestamp. Unit: milliseconds.
+   * 
    * @example
    * 1668568601000
    */
@@ -16,11 +19,17 @@ export class ListMetaCollectionsResponseBodyDataMetaCollections extends $dara.Mo
   createUser?: string;
   description?: string;
   /**
+   * @remarks
+   * The ID of the collection.
+   * 
    * @example
    * category.123
    */
   id?: string;
   /**
+   * @remarks
+   * The time when the collection was modified. The value is a UNIX timestamp. Unit: milliseconds.
+   * 
    * @example
    * 1668568601000
    */
@@ -31,6 +40,9 @@ export class ListMetaCollectionsResponseBodyDataMetaCollections extends $dara.Mo
    */
   name?: string;
   /**
+   * @remarks
+   * The ID of the collection of the ancestor node. This parameter can be left empty.
+   * 
    * @example
    * category.1
    */

package/src/models/ListPartitionsRequest.ts

@@ -30,6 +30,8 @@ export class ListPartitionsRequest extends $dara.Model {
   sortBy?: string;
   /**
    * @remarks
+   * The ID of the table to which the partitions 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/ListSchemasRequest.ts

@@ -4,32 +4,56 @@ import * as $dara from '@darabonba/typescript';
 
 export class ListSchemasRequest extends $dara.Model {
   /**
+   * @remarks
+   * The comment. Fuzzy match is supported.
+   * 
    * @example
    * test comment
    */
   comment?: string;
   /**
+   * @remarks
+   * The name. Fuzzy match is supported.
+   * 
    * @example
    * abc
    */
   name?: string;
   /**
+   * @remarks
+   * The order in which schemas are sorted. Default value: Asc. Valid values:
+   * 
+   * *   Asc: ascending order
+   * *   Desc: descending order
+   * 
    * @example
    * Asc
    */
   order?: string;
   /**
+   * @remarks
+   * The page number. Default value: 1.
+   * 
    * @example
    * 1
    */
   pageNumber?: number;
   /**
+   * @remarks
+   * The number of entries per page. Default value: 10. Maximum value: 100.
+   * 
    * @example
    * 10
    */
   pageSize?: number;
   /**
    * @remarks
+   * The parent entity ID. For more information, see [Concepts related to metadata entities](https://help.aliyun.com/document_detail/2880092.html). For the Hologres metadata crawler type, you can call the ListDatabases operation to query the settings of the `ParentMetaEntityId` parameter.
+   * 
+   * Configure the `ParentMetaEntityId` parameter in the `${EntityType}:${Instance ID or escaped URL}:${Catalog identifier}:${Database name}` format. If a level does not exist, leave the level empty.
+   * 
+   * >  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.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -38,10 +62,22 @@ export class ListSchemasRequest extends $dara.Model {
    */
   parentMetaEntityId?: string;
   /**
+   * @remarks
+   * The field used for sorting. Default value: CreateTime. Valid values:
+   * 
+   * *   CreateTime
+   * *   ModifyTime
+   * *   Name
+   * *   Type
+   * 
    * @example
    * CreateTime
    */
   sortBy?: string;
+  /**
+   * @remarks
+   * The types. Exact match is supported. If this parameter is left empty, all types are queried.
+   */
   types?: string[];
   static names(): { [key: string]: string } {
     return {

package/src/models/ListSchemasResponseBody.ts

@@ -4,13 +4,23 @@ import { ListSchemasResponseBodyPagingInfo } from "./ListSchemasResponseBodyPagi
 
 
 export class ListSchemasResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The pagination information.
+   */
   pagingInfo?: ListSchemasResponseBodyPagingInfo;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * 235BBA5E-3428-XXXXXX
    */
   requestId?: string;
   /**
+   * @remarks
+   * Indicates whether the request was successful.
+   * 
    * @example
    * true
    */

package/src/models/ListSchemasResponseBodyPagingInfo.ts

@@ -10,10 +10,17 @@ export class ListSchemasResponseBodyPagingInfo extends $dara.Model {
    */
   pageNumber?: number;
   /**
+   * @remarks
+   * The number of entries per page.
+   * 
    * @example
    * 10
    */
   pageSize?: number;
+  /**
+   * @remarks
+   * The schemas.
+   */
   schemas?: Schema[];
   /**
    * @example

package/src/models/ListSchemasShrinkRequest.ts

@@ -4,32 +4,56 @@ import * as $dara from '@darabonba/typescript';
 
 export class ListSchemasShrinkRequest extends $dara.Model {
   /**
+   * @remarks
+   * The comment. Fuzzy match is supported.
+   * 
    * @example
    * test comment
    */
   comment?: string;
   /**
+   * @remarks
+   * The name. Fuzzy match is supported.
+   * 
    * @example
    * abc
    */
   name?: string;
   /**
+   * @remarks
+   * The order in which schemas are sorted. Default value: Asc. Valid values:
+   * 
+   * *   Asc: ascending order
+   * *   Desc: descending order
+   * 
    * @example
    * Asc
    */
   order?: string;
   /**
+   * @remarks
+   * The page number. Default value: 1.
+   * 
    * @example
    * 1
    */
   pageNumber?: number;
   /**
+   * @remarks
+   * The number of entries per page. Default value: 10. Maximum value: 100.
+   * 
    * @example
    * 10
    */
   pageSize?: number;
   /**
    * @remarks
+   * The parent entity ID. For more information, see [Concepts related to metadata entities](https://help.aliyun.com/document_detail/2880092.html). For the Hologres metadata crawler type, you can call the ListDatabases operation to query the settings of the `ParentMetaEntityId` parameter.
+   * 
+   * Configure the `ParentMetaEntityId` parameter in the `${EntityType}:${Instance ID or escaped URL}:${Catalog identifier}:${Database name}` format. If a level does not exist, leave the level empty.
+   * 
+   * >  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.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -38,10 +62,22 @@ export class ListSchemasShrinkRequest extends $dara.Model {
    */
   parentMetaEntityId?: string;
   /**
+   * @remarks
+   * The field used for sorting. Default value: CreateTime. Valid values:
+   * 
+   * *   CreateTime
+   * *   ModifyTime
+   * *   Name
+   * *   Type
+   * 
    * @example
    * CreateTime
    */
   sortBy?: string;
+  /**
+   * @remarks
+   * The types. Exact match is supported. If this parameter is left empty, all types are queried.
+   */
   typesShrink?: string;
   static names(): { [key: string]: string } {
     return {

package/src/models/ListTablesRequest.ts

@@ -30,6 +30,39 @@ export class ListTablesRequest extends $dara.Model {
   pageSize?: number;
   /**
    * @remarks
+   * The parent metadata entity ID. You can refer to the responses of the ListDatabases or ListSchemas operation and [Description of concepts related to metadata entities.](https://help.aliyun.com/document_detail/2880092.html)
+   * 
+   * *   The parent metadata entity is a database: The format of `ParentMetaEntityId` is `${EntityType}:${Instance ID or encoded URL}:${Catalog Identifier}:${Database Name}`. Use an empty string (\\`""\\`) as a placeholder for any non-existent level.
+   * *   The parent metadata entity is a database schema:. The format of `ParentMetaEntityId` is `${EntityType}:${Instance ID or encoded URL}:${Catalog Identifier}:${Database Name}:${Schema Name}`. Use an empty string (\\`""\\`) as a placeholder for any non-existent level.
+   * 
+   * >  The schema level in `ParentMetaEntityId` is supported only for database types that support schemas, such as MaxCompute (with schema enabled), Hologres, PostgreSQL, SQL Server, HybridDB for PostgreSQL, and Oracle.``
+   * 
+   * >  For MaxCompute and DLF types, use empty strings as the instance ID. For MaxCompute, the database name is the same as the project name.
+   * 
+   * >  For the StarRocks type, the catalog identifier is the catalog name. For the DLF type, it refers to the catalog ID. Other types do not support a catalog-level hierarchy and the catalog identifier must be replaced with an empty string as a placeholder.
+   * 
+   * Examples of common ParentMetaEntityId formats
+   * 
+   * `maxcompute-project:::project_name`
+   * 
+   * `maxcompute-schema:::project_name:schema_name` (for MaxCompute projects with schema enabled)
+   * 
+   * `dlf-database::catalog_id:database_name`
+   * 
+   * `hms-database:instance_id::database_name`
+   * 
+   * `holo-schema:instance_id::database_name:schema_name`
+   * 
+   * `mysql-database:(instance_id|encoded_jdbc_url)::database_name`
+   * 
+   * > \\
+   * `instance_id`: The instance ID, required when the data source is 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_id`: The DLF catalog ID.\\
+   * `project_name`: The MaxCompute project name.\\
+   * `database_name`: The database name.\\
+   * `schema_name`: The schema name.
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/ListTablesShrinkRequest.ts

@@ -30,6 +30,39 @@ export class ListTablesShrinkRequest extends $dara.Model {
   pageSize?: number;
   /**
    * @remarks
+   * The parent metadata entity ID. You can refer to the responses of the ListDatabases or ListSchemas operation and [Description of concepts related to metadata entities.](https://help.aliyun.com/document_detail/2880092.html)
+   * 
+   * *   The parent metadata entity is a database: The format of `ParentMetaEntityId` is `${EntityType}:${Instance ID or encoded URL}:${Catalog Identifier}:${Database Name}`. Use an empty string (\\`""\\`) as a placeholder for any non-existent level.
+   * *   The parent metadata entity is a database schema:. The format of `ParentMetaEntityId` is `${EntityType}:${Instance ID or encoded URL}:${Catalog Identifier}:${Database Name}:${Schema Name}`. Use an empty string (\\`""\\`) as a placeholder for any non-existent level.
+   * 
+   * >  The schema level in `ParentMetaEntityId` is supported only for database types that support schemas, such as MaxCompute (with schema enabled), Hologres, PostgreSQL, SQL Server, HybridDB for PostgreSQL, and Oracle.``
+   * 
+   * >  For MaxCompute and DLF types, use empty strings as the instance ID. For MaxCompute, the database name is the same as the project name.
+   * 
+   * >  For the StarRocks type, the catalog identifier is the catalog name. For the DLF type, it refers to the catalog ID. Other types do not support a catalog-level hierarchy and the catalog identifier must be replaced with an empty string as a placeholder.
+   * 
+   * Examples of common ParentMetaEntityId formats
+   * 
+   * `maxcompute-project:::project_name`
+   * 
+   * `maxcompute-schema:::project_name:schema_name` (for MaxCompute projects with schema enabled)
+   * 
+   * `dlf-database::catalog_id:database_name`
+   * 
+   * `hms-database:instance_id::database_name`
+   * 
+   * `holo-schema:instance_id::database_name:schema_name`
+   * 
+   * `mysql-database:(instance_id|encoded_jdbc_url)::database_name`
+   * 
+   * > \\
+   * `instance_id`: The instance ID, required when the data source is 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_id`: The DLF catalog ID.\\
+   * `project_name`: The MaxCompute project name.\\
+   * `database_name`: The database name.\\
+   * `schema_name`: The schema name.
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/ListTaskInstancesRequest.ts

@@ -99,6 +99,10 @@ export class ListTaskInstancesRequest extends $dara.Model {
    * Id Desc
    */
   sortBy?: string;
+  /**
+   * @example
+   * Success
+   */
   status?: string;
   /**
    * @remarks

package/src/models/ListTaskInstancesResponseBody.ts

@@ -6,7 +6,7 @@ import { ListTaskInstancesResponseBodyPagingInfo } from "./ListTaskInstancesResp
 export class ListTaskInstancesResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The pagination information.
+   * The pagination details.
    */
   pagingInfo?: ListTaskInstancesResponseBodyPagingInfo;
   /**

package/src/models/ListTaskInstancesResponseBodyPagingInfo.ts

@@ -22,7 +22,7 @@ export class ListTaskInstancesResponseBodyPagingInfo extends $dara.Model {
   pageSize?: number;
   /**
    * @remarks
-   * The instances.
+   * The list of task instances.
    */
   taskInstances?: ListTaskInstancesResponseBodyPagingInfoTaskInstances[];
   /**

package/src/models/ListTaskInstancesResponseBodyPagingInfoTaskInstances.ts

@@ -160,6 +160,10 @@ export class ListTaskInstancesResponseBodyPagingInfoTaskInstances extends $dara.
    * The information about the resource group with which the instance is associated.
    */
   runtimeResource?: ListTaskInstancesResponseBodyPagingInfoTaskInstancesRuntimeResource;
+  /**
+   * @example
+   * para1=val1 para2=val2
+   */
   scriptParameters?: string;
   /**
    * @remarks
@@ -257,7 +261,15 @@ export class ListTaskInstancesResponseBodyPagingInfoTaskInstances extends $dara.
    * Scheduler
    */
   triggerType?: string;
+  /**
+   * @example
+   * 1710239005403
+   */
   waitingResourceTime?: number;
+  /**
+   * @example
+   * 1710239005403
+   */
   waitingTriggerTime?: number;
   /**
    * @remarks

package/src/models/ListTaskInstancesShrinkRequest.ts

@@ -99,6 +99,10 @@ export class ListTaskInstancesShrinkRequest extends $dara.Model {
    * Id Desc
    */
   sortBy?: string;
+  /**
+   * @example
+   * Success
+   */
   status?: string;
   /**
    * @remarks

package/src/models/RemoveEntityFromMetaCollectionRequest.ts

@@ -4,11 +4,17 @@ import * as $dara from '@darabonba/typescript';
 
 export class RemoveEntityFromMetaCollectionRequest extends $dara.Model {
   /**
+   * @remarks
+   * The entity ID. Currently, entities can only be tables. You can call the ListTables operation to query the ID.
+   * 
    * @example
    * dlf-table:123456789:test_catalog:test_database::test_table
    */
   id?: string;
   /**
+   * @remarks
+   * The collection ID. You can call the ListMetaCollections operation to query the ID.
+   * 
    * @example
    * category.123
    */

package/src/models/RerunWorkflowInstancesRequest.ts

@@ -5,44 +5,86 @@ import { RerunWorkflowInstancesRequestFilter } from "./RerunWorkflowInstancesReq
 
 export class RerunWorkflowInstancesRequest extends $dara.Model {
   /**
+   * @remarks
+   * The business date used for matching manual workflow instances.
+   * 
    * @example
    * 1710239005403
    */
   bizdate?: number;
   /**
+   * @remarks
+   * The end trigger time of the manual workflow instance used for matching. This parameter must be used together with the StartTriggerTime.
+   * 
    * @example
    * 1710239005403
    */
   endTriggerTime?: number;
   /**
+   * @remarks
+   * The environment of the workspace. Valid values:
+   * 
+   * Prod Dev
+   * 
    * @example
    * Prod
    */
   envType?: string;
+  /**
+   * @remarks
+   * The match conditions for internal instances of manual workflow instances.
+   */
   filter?: RerunWorkflowInstancesRequestFilter;
+  /**
+   * @remarks
+   * The instance IDs used for matching manual workflow instances.
+   */
   ids?: number[];
   /**
+   * @remarks
+   * The manual workflow name, used for fuzzy matching.
+   * 
    * @example
    * test
    */
   name?: string;
   /**
    * @remarks
+   * The project ID.
+   * 
    * This parameter is required.
+   * 
+   * @example
+   * 123
    */
   projectId?: number;
   /**
+   * @remarks
+   * The start trigger time (creation time) of the manual workflow instance used for matching. This parameter must be used together with EndTriggerTime.
+   * 
    * @example
    * 1710239005403
    */
   startTriggerTime?: number;
   /**
+   * @remarks
+   * The status used for matching manual workflow instances.
+   * 
+   * Valid values:
+   * 
+   * *   Success
+   * *   Failure
+   * 
    * @example
    * Failure
    */
   status?: string;
   /**
    * @remarks
+   * The type of the workflow instance. Valid values:
+   * 
+   * ManualWorkflow.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -51,6 +93,8 @@ export class RerunWorkflowInstancesRequest extends $dara.Model {
   type?: string;
   /**
    * @remarks
+   * The workflow ID.
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/RerunWorkflowInstancesRequestFilter.ts

@@ -4,17 +4,35 @@ import * as $dara from '@darabonba/typescript';
 
 export class RerunWorkflowInstancesRequestFilter extends $dara.Model {
   /**
+   * @remarks
+   * Specifies whether to rerun the matched instances and all downstream instances.
+   * 
    * @example
    * false
    */
   rerunDownstreamEnabled?: boolean;
+  /**
+   * @remarks
+   * The internal task IDs used for matching manual workflow instances.
+   */
   taskIds?: number[];
+  /**
+   * @remarks
+   * The statuses of internal tasks used for matching manual workflow instances.
+   */
   taskInstanceStatuses?: string[];
   /**
+   * @remarks
+   * The internal task name used for matching the manual workflow instance.
+   * 
    * @example
    * test
    */
   taskName?: string;
+  /**
+   * @remarks
+   * Match internal tasks within the manual workflow by type.
+   */
   taskTypes?: string[];
   static names(): { [key: string]: string } {
     return {

package/src/models/RerunWorkflowInstancesResponseBody.ts

@@ -4,11 +4,17 @@ import * as $dara from '@darabonba/typescript';
 
 export class RerunWorkflowInstancesResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The operation ID. You can use this value to query the creation result via the GetRerunWorkflowInstancesResult operation.
+   * 
    * @example
    * e15ad21c-b0e9-4792-8f55-b037xxxxxxxx
    */
   operationId?: string;
   /**
+   * @remarks
+   * The request ID. Used for troubleshooting and log tracking.
+   * 
    * @example
    * 22C97E95-F023-56B5-8852-B1A77A17XXXX
    */