@alicloud/dts20200101 1.5.3 → 1.6.0

package/src/models/ConfigureSynchronizationJobRequest.ts

@@ -1,10 +1,341 @@
 // This file is auto-generated, don't edit it
 import * as $dara from '@darabonba/typescript';
-import { ConfigureSynchronizationJobRequestDestinationEndpoint } from "./ConfigureSynchronizationJobRequestDestinationEndpoint";
-import { ConfigureSynchronizationJobRequestPartitionKey } from "./ConfigureSynchronizationJobRequestPartitionKey";
-import { ConfigureSynchronizationJobRequestSourceEndpoint } from "./ConfigureSynchronizationJobRequestSourceEndpoint";
 
 
+export class ConfigureSynchronizationJobRequestDestinationEndpoint extends $dara.Model {
+  /**
+   * @remarks
+   * The name of the database to which the synchronization object in the destination instance belongs.
+   * 
+   * @example
+   * dtstestdata
+   */
+  dataBaseName?: string;
+  /**
+   * @remarks
+   * The IP address of the destination database.
+   * 
+   * >  You must specify this parameter only if the **DestinationEndpoint.InstanceType** parameter is set to **Express**, **dg**, or **cen**.
+   * 
+   * @example
+   * 172.16.88.***
+   */
+  IP?: string;
+  /**
+   * @remarks
+   * The ID of the destination instance.
+   * 
+   * >  If the **DestinationEndpoint.InstanceType** parameter is set to **MaxCompute** or **DataHub**, you must specify the name of the MaxCompute project or the DataHub project.
+   * 
+   * If the destination instance is an AnalyticDB for MySQL cluster, specify the ID of the AnalyticDB for MySQL cluster.
+   * 
+   * @example
+   * rm-bp1r46452ai50****
+   */
+  instanceId?: string;
+  /**
+   * @remarks
+   * The type of the destination instance. Valid values:
+   * 
+   * *   **Redis**: ApsaraDB for Redis instance
+   * *   **RDS**: ApsaraDB RDS instance
+   * *   **PolarDB**: PolarDB for MySQL cluster or PolarDB O Edition cluster
+   * *   **ECS**: self-managed database that is hosted on ECS
+   * *   **Express**: self-managed database that is connected over Express Connect
+   * *   **DataHub**: DataHub project
+   * *   **MaxCompute**: MaxCompute project
+   * *   **AnalyticDB**: AnalyticDB for MySQL cluster V3.0 or V2.0
+   * *   **Greenplum**: AnalyticDB for PostgreSQL instance
+   * 
+   * >  The default value is **RDS**.
+   * 
+   * @example
+   * RDS
+   */
+  instanceType?: string;
+  /**
+   * @remarks
+   * The password of the destination database account.
+   * 
+   * > 
+   * *   If the **DestinationEndpoint.InstanceType** parameter is set to **ECS**, **Express**, **dg**, or **cen**, you must specify the DestinationEndpoint.Password parameter.
+   * 
+   * @example
+   * Test654321
+   */
+  password?: string;
+  /**
+   * @remarks
+   * The service port number of the destination database.
+   * 
+   * >  You must specify this parameter only if the **DestinationEndpoint.InstanceType** parameter is set to **ECS**, **Express**, **dg**, or **cen**.
+   * 
+   * @example
+   * 3306
+   */
+  port?: string;
+  /**
+   * @remarks
+   * The database account of the destination database.
+   * 
+   * > 
+   * *   The permissions that are required for database accounts vary with the synchronization scenario. For more information, see [Overview of data synchronization scenarios](https://help.aliyun.com/document_detail/140954.html).
+   * *   If the **DestinationEndpoint.InstanceType** parameter is set to **ECS**, **Express**, **dg**, or **cen**, you must specify the DestinationEndpoint.UserName parameter.
+   * *   If the **DestinationEndpoint.InstanceType** parameter is set to RDS and the database version is MySQL 5.5 or MySQL 5.6, you do not need to specify the DestinationEndpoint.UserName and **DestinationEndpoint.Password** parameters.
+   * *   If the **DestinationEndpoint.InstanceType** parameter is set to **Redis**, you do not need to specify the DestinationEndpoint.UserName parameter.
+   * 
+   * @example
+   * dtstestaccount
+   */
+  userName?: string;
+  static names(): { [key: string]: string } {
+    return {
+      dataBaseName: 'DataBaseName',
+      IP: 'IP',
+      instanceId: 'InstanceId',
+      instanceType: 'InstanceType',
+      password: 'Password',
+      port: 'Port',
+      userName: 'UserName',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      dataBaseName: 'string',
+      IP: 'string',
+      instanceId: 'string',
+      instanceType: 'string',
+      password: 'string',
+      port: 'string',
+      userName: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
+export class ConfigureSynchronizationJobRequestPartitionKey extends $dara.Model {
+  /**
+   * @remarks
+   * Specifies whether the incremental data table contains partitions defined by the modifytime_day field. Valid values: **true** and **false**.
+   * 
+   * >  This parameter is available only if the **DestinationEndpoint.InstanceType** parameter is set to **MaxCompute**.
+   * 
+   * @example
+   * true
+   */
+  modifyTimeDay?: boolean;
+  /**
+   * @remarks
+   * Specifies whether the incremental data table contains partitions defined by the modifytime_hour field. Valid values: **true** and **false**.
+   * 
+   * >  This parameter is available only if the **DestinationEndpoint.InstanceType** parameter is set to **MaxCompute**.
+   * 
+   * @example
+   * true
+   */
+  modifyTimeHour?: boolean;
+  /**
+   * @remarks
+   * Specifies whether the incremental data table contains partitions defined by the modifytime_minute field. Valid values: **true** and **false**.
+   * 
+   * >  This parameter is available only if the **DestinationEndpoint.InstanceType** parameter is set to **MaxCompute**.
+   * 
+   * @example
+   * true
+   */
+  modifyTimeMinute?: boolean;
+  /**
+   * @remarks
+   * Specifies whether the incremental data table contains partitions defined by the modifytime_month field. Valid values: **true** and **false**.
+   * 
+   * >  This parameter is available only if the **DestinationEndpoint.InstanceType** parameter is set to **MaxCompute**.
+   * 
+   * @example
+   * true
+   */
+  modifyTimeMonth?: boolean;
+  /**
+   * @remarks
+   * Specifies whether the incremental data table contains partitions defined by the modifytime_year field. Valid values: **true** and **false**.
+   * 
+   * >  This parameter is available only if the **DestinationEndpoint.InstanceType** parameter is set to **MaxCompute**.
+   * 
+   * @example
+   * true
+   */
+  modifyTimeYear?: boolean;
+  static names(): { [key: string]: string } {
+    return {
+      modifyTimeDay: 'ModifyTime_Day',
+      modifyTimeHour: 'ModifyTime_Hour',
+      modifyTimeMinute: 'ModifyTime_Minute',
+      modifyTimeMonth: 'ModifyTime_Month',
+      modifyTimeYear: 'ModifyTime_Year',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      modifyTimeDay: 'boolean',
+      modifyTimeHour: 'boolean',
+      modifyTimeMinute: 'boolean',
+      modifyTimeMonth: 'boolean',
+      modifyTimeYear: 'boolean',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
+export class ConfigureSynchronizationJobRequestSourceEndpoint extends $dara.Model {
+  /**
+   * @remarks
+   * The name of the database to which the synchronization object in the source instance belongs.
+   * 
+   * @example
+   * dtstestdata
+   */
+  databaseName?: string;
+  /**
+   * @remarks
+   * The IP address of the source database.
+   * 
+   * >  You must specify this parameter only if the **SourceEndpoint.InstanceType** parameter is set to **ECS**, **Express**, **dg**, or **cen**.
+   * 
+   * @example
+   * 172.16.88.***
+   */
+  IP?: string;
+  /**
+   * @remarks
+   * The ID of the source instance.
+   * 
+   * @example
+   * rm-bp1i99e8l7913****
+   */
+  instanceId?: string;
+  /**
+   * @remarks
+   * The type of the source instance. Valid values:
+   * 
+   * *   **RDS**: ApsaraDB RDS instance
+   * *   **Redis**: ApsaraDB for Redis instance
+   * *   **PolarDB**: PolarDB for MySQL cluster or PolarDB O Edition cluster
+   * *   **ECS**: self-managed database that is hosted on Elastic Compute Service (ECS)
+   * *   **Express**: self-managed database that is connected over Express Connect
+   * *   **dg**: self-managed database that is connected over Database Gateway
+   * *   **cen**: self-managed database that is connected over Cloud Enterprise Network (CEN)
+   * 
+   * >  The default value is **RDS**.
+   * 
+   * @example
+   * RDS
+   */
+  instanceType?: string;
+  /**
+   * @remarks
+   * The ID of the Alibaba Cloud account that owns the source RDS instance.
+   * 
+   * >  You can specify this parameter to synchronize data across different Alibaba Cloud accounts. In this case, you also need to specify the **SourceEndpoint.Role** parameter.
+   * 
+   * @example
+   * 140692647406****
+   */
+  ownerID?: string;
+  /**
+   * @remarks
+   * The password of the source database account.
+   * 
+   * >  You must specify this parameter only if the **SourceEndpoint.InstanceType** parameter is set to **ECS**, **Express**, **dg**, or **cen**.
+   * 
+   * @example
+   * Test123456
+   */
+  password?: string;
+  /**
+   * @remarks
+   * The service port number of the source database.
+   * 
+   * >  You must specify this parameter only if the **SourceEndpoint.InstanceType** parameter is set to **ECS**, **Express**, **dg**, or **cen**.
+   * 
+   * @example
+   * 3306
+   */
+  port?: string;
+  /**
+   * @remarks
+   * The name of the RAM role configured for the Alibaba Cloud account that owns the source instance.
+   * 
+   * >  You must specify this parameter when you synchronize data across different Alibaba Cloud accounts. For information about the permissions and authorization methods of the RAM role, see [Configure RAM authorization for cross-account data migration and synchronization](https://help.aliyun.com/document_detail/48468.html).
+   * 
+   * @example
+   * ram-for-dts
+   */
+  role?: string;
+  /**
+   * @remarks
+   * The database account of the source database.
+   * 
+   * > 
+   * *   You must specify this parameter only if the **SourceEndpoint.InstanceType** parameter is set to **ECS**, **Express**, **dg**, or **cen**.
+   * *   If the **SourceEndpoint.InstanceType** parameter is set to **Redis**, you do not need to specify the database account.
+   * *   The permissions that are required for database accounts vary with the synchronization scenario. For more information, see [Overview of data synchronization scenarios](https://help.aliyun.com/document_detail/140954.html).
+   * 
+   * @example
+   * dtstestaccount
+   */
+  userName?: string;
+  static names(): { [key: string]: string } {
+    return {
+      databaseName: 'DatabaseName',
+      IP: 'IP',
+      instanceId: 'InstanceId',
+      instanceType: 'InstanceType',
+      ownerID: 'OwnerID',
+      password: 'Password',
+      port: 'Port',
+      role: 'Role',
+      userName: 'UserName',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      databaseName: 'string',
+      IP: 'string',
+      instanceId: 'string',
+      instanceType: 'string',
+      ownerID: 'string',
+      password: 'string',
+      port: 'string',
+      role: 'string',
+      userName: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
 export class ConfigureSynchronizationJobRequest extends $dara.Model {
   destinationEndpoint?: ConfigureSynchronizationJobRequestDestinationEndpoint;
   partitionKey?: ConfigureSynchronizationJobRequestPartitionKey;

package/src/models/CreateDocParserJobAdvanceRequest.ts

@@ -0,0 +1,60 @@
+// This file is auto-generated, don't edit it
+import { Readable } from 'stream';
+import * as $dara from '@darabonba/typescript';
+
+
+export class CreateDocParserJobAdvanceRequest extends $dara.Model {
+  /**
+   * @example
+   * 2.pdf
+   */
+  fileName?: string;
+  /**
+   * @example
+   * https://oss-cn-hangzhou.aliyuncs.com/storage/pdf/40184458-fbb0-44cf-a391-350628ceccdd17375122****
+   */
+  fileUrlObject?: Readable;
+  /**
+   * @example
+   * cn-hangzhou
+   */
+  regionId?: string;
+  /**
+   * @example
+   * rg-acfmzawhxxc****
+   */
+  resourceGroupId?: string;
+  /**
+   * @example
+   * zip
+   */
+  resultType?: string;
+  static names(): { [key: string]: string } {
+    return {
+      fileName: 'FileName',
+      fileUrlObject: 'FileUrl',
+      regionId: 'RegionId',
+      resourceGroupId: 'ResourceGroupId',
+      resultType: 'ResultType',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      fileName: 'string',
+      fileUrlObject: 'Readable',
+      regionId: 'string',
+      resourceGroupId: 'string',
+      resultType: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/CreateDocParserJobRequest.ts

@@ -0,0 +1,59 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class CreateDocParserJobRequest extends $dara.Model {
+  /**
+   * @example
+   * 2.pdf
+   */
+  fileName?: string;
+  /**
+   * @example
+   * https://oss-cn-hangzhou.aliyuncs.com/storage/pdf/40184458-fbb0-44cf-a391-350628ceccdd17375122****
+   */
+  fileUrl?: string;
+  /**
+   * @example
+   * cn-hangzhou
+   */
+  regionId?: string;
+  /**
+   * @example
+   * rg-acfmzawhxxc****
+   */
+  resourceGroupId?: string;
+  /**
+   * @example
+   * zip
+   */
+  resultType?: string;
+  static names(): { [key: string]: string } {
+    return {
+      fileName: 'FileName',
+      fileUrl: 'FileUrl',
+      regionId: 'RegionId',
+      resourceGroupId: 'ResourceGroupId',
+      resultType: 'ResultType',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      fileName: 'string',
+      fileUrl: 'string',
+      regionId: 'string',
+      resourceGroupId: 'string',
+      resultType: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/CreateDocParserJobResponse.ts

@@ -0,0 +1,40 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+import { CreateDocParserJobResponseBody } from "./CreateDocParserJobResponseBody";
+
+
+export class CreateDocParserJobResponse extends $dara.Model {
+  headers?: { [key: string]: string };
+  statusCode?: number;
+  body?: CreateDocParserJobResponseBody;
+  static names(): { [key: string]: string } {
+    return {
+      headers: 'headers',
+      statusCode: 'statusCode',
+      body: 'body',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      headers: { 'type': 'map', 'keyType': 'string', 'valueType': 'string' },
+      statusCode: 'number',
+      body: CreateDocParserJobResponseBody,
+    };
+  }
+
+  validate() {
+    if(this.headers) {
+      $dara.Model.validateMap(this.headers);
+    }
+    if(this.body && typeof (this.body as any).validate === 'function') {
+      (this.body as any).validate();
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/CreateDocParserJobResponseBody.ts

@@ -0,0 +1,80 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class CreateDocParserJobResponseBody extends $dara.Model {
+  /**
+   * @example
+   * dts-20250729-boss6pn1w******
+   */
+  dtsJobId?: string;
+  /**
+   * @example
+   * 403
+   */
+  dynamicCode?: string;
+  /**
+   * @example
+   * present environment is not support, so skip
+   */
+  dynamicMessage?: string;
+  /**
+   * @example
+   * InternalError
+   */
+  errCode?: string;
+  /**
+   * @example
+   * The request processing has failed due to some unknown error.
+   */
+  errMessage?: string;
+  /**
+   * @example
+   * 200
+   */
+  httpStatusCode?: number;
+  /**
+   * @example
+   * FDC111B1-ACBF-457D-9656-247FDEE9****
+   */
+  requestId?: string;
+  /**
+   * @example
+   * true
+   */
+  success?: boolean;
+  static names(): { [key: string]: string } {
+    return {
+      dtsJobId: 'DtsJobId',
+      dynamicCode: 'DynamicCode',
+      dynamicMessage: 'DynamicMessage',
+      errCode: 'ErrCode',
+      errMessage: 'ErrMessage',
+      httpStatusCode: 'HttpStatusCode',
+      requestId: 'RequestId',
+      success: 'Success',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      dtsJobId: 'string',
+      dynamicCode: 'string',
+      dynamicMessage: 'string',
+      errCode: 'string',
+      errMessage: 'string',
+      httpStatusCode: 'number',
+      requestId: 'string',
+      success: 'boolean',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/CreateSubscriptionInstanceRequest.ts

@@ -1,8 +1,39 @@
 // This file is auto-generated, don't edit it
 import * as $dara from '@darabonba/typescript';
-import { CreateSubscriptionInstanceRequestSourceEndpoint } from "./CreateSubscriptionInstanceRequestSourceEndpoint";
 
 
+export class CreateSubscriptionInstanceRequestSourceEndpoint extends $dara.Model {
+  /**
+   * @remarks
+   * The type of the source instance. Valid values: **MySQL**, **PolarDB**, **DRDS**, and **Oracle**.
+   * 
+   * >  Default value: **MySQL**.
+   * 
+   * @example
+   * MySQL
+   */
+  instanceType?: string;
+  static names(): { [key: string]: string } {
+    return {
+      instanceType: 'InstanceType',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      instanceType: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
 export class CreateSubscriptionInstanceRequest extends $dara.Model {
   sourceEndpoint?: CreateSubscriptionInstanceRequestSourceEndpoint;
   /**

package/src/models/CreateSynchronizationJobRequest.ts

@@ -1,9 +1,85 @@
 // This file is auto-generated, don't edit it
 import * as $dara from '@darabonba/typescript';
-import { CreateSynchronizationJobRequestDestinationEndpoint } from "./CreateSynchronizationJobRequestDestinationEndpoint";
-import { CreateSynchronizationJobRequestSourceEndpoint } from "./CreateSynchronizationJobRequestSourceEndpoint";
 
 
+export class CreateSynchronizationJobRequestDestinationEndpoint extends $dara.Model {
+  /**
+   * @remarks
+   * The instance type of the destination database. Valid values:
+   * 
+   * *   **MySQL**: ApsaraDB RDS for MySQL instance or self-managed MySQL database
+   * *   **PolarDB**: PolarDB for MySQL cluster or PolarDB O Edition cluster
+   * *   **Redis**: Redis database
+   * *   **MaxCompute**: MaxCompute project
+   * 
+   * > 
+   * *   Default value: **MySQL**.
+   * *   For more information about the supported source and destination databases, see [Database types, initial synchronization types, and synchronization topologies](https://help.aliyun.com/document_detail/130744.html).
+   * 
+   * @example
+   * MySQL
+   */
+  instanceType?: string;
+  static names(): { [key: string]: string } {
+    return {
+      instanceType: 'InstanceType',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      instanceType: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
+export class CreateSynchronizationJobRequestSourceEndpoint extends $dara.Model {
+  /**
+   * @remarks
+   * The instance type of the source database. Valid values:
+   * 
+   * *   **MySQL**: ApsaraDB RDS for MySQL instance or self-managed MySQL database
+   * *   **PolarDB**: PolarDB for MySQL cluster or PolarDB O Edition cluster
+   * *   **Redis**: Redis database
+   * *   **DRDS**: PolarDB-X instance V1.0
+   * 
+   * > 
+   * *   Default value: **MySQL**.
+   * *   For more information about the supported source and destination databases, see [Database types, initial synchronization types, and synchronization topologies](https://help.aliyun.com/document_detail/130744.html).
+   * 
+   * @example
+   * MySQL
+   */
+  instanceType?: string;
+  static names(): { [key: string]: string } {
+    return {
+      instanceType: 'InstanceType',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      instanceType: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
 export class CreateSynchronizationJobRequest extends $dara.Model {
   destinationEndpoint?: CreateSynchronizationJobRequestDestinationEndpoint;
   sourceEndpoint?: CreateSynchronizationJobRequestSourceEndpoint;