@alicloud/dms20250414 4.1.0 → 4.2.0

package/src/models/SearchAgenticCatalogResponse.ts

@@ -0,0 +1,40 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+import { SearchAgenticCatalogResponseBody } from "./SearchAgenticCatalogResponseBody";
+
+
+export class SearchAgenticCatalogResponse extends $dara.Model {
+  headers?: { [key: string]: string };
+  statusCode?: number;
+  body?: SearchAgenticCatalogResponseBody;
+  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: SearchAgenticCatalogResponseBody,
+    };
+  }
+
+  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/SearchAgenticCatalogResponseBody.ts

@@ -0,0 +1,98 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+import { AgenticCatalog } from "./AgenticCatalog";
+
+
+export class SearchAgenticCatalogResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The list of catalogs.
+   */
+  data?: AgenticCatalog[];
+  /**
+   * @remarks
+   * The error code, which is returned when a request exception occurs.
+   * 
+   * @example
+   * UnknownError
+   */
+  errorCode?: string;
+  /**
+   * @remarks
+   * The error message, which is returned when the call fails.
+   * 
+   * @example
+   * UnknownError
+   */
+  errorMessage?: string;
+  /**
+   * @remarks
+   * The maximum number of entries returned per page in this query.
+   * 
+   * @example
+   * 20
+   */
+  maxResults?: number;
+  /**
+   * @remarks
+   * The token for the next query. An empty value indicates that no more data is available. If the value is not empty, set the NextToken parameter to this value in the next request to query the next page.
+   * 
+   * @example
+   * NesLoKLEdIZrKhDT7I2gS****
+   */
+  nextToken?: string;
+  /**
+   * @remarks
+   * The request ID.
+   * 
+   * @example
+   * 67E910F2-4B62-5B0C-ACA3-7547695C****
+   */
+  requestId?: string;
+  /**
+   * @remarks
+   * Indicates whether the request is successful. Valid values:
+   * 
+   * - **true**: The request is successful.
+   * - **false**: The request fails.
+   * 
+   * @example
+   * true
+   */
+  success?: boolean;
+  static names(): { [key: string]: string } {
+    return {
+      data: 'Data',
+      errorCode: 'ErrorCode',
+      errorMessage: 'ErrorMessage',
+      maxResults: 'MaxResults',
+      nextToken: 'NextToken',
+      requestId: 'RequestId',
+      success: 'Success',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      data: { 'type': 'array', 'itemType': AgenticCatalog },
+      errorCode: 'string',
+      errorMessage: 'string',
+      maxResults: 'number',
+      nextToken: 'string',
+      requestId: 'string',
+      success: 'boolean',
+    };
+  }
+
+  validate() {
+    if(Array.isArray(this.data)) {
+      $dara.Model.validateArray(this.data);
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/SearchAgenticDatabaseRequest.ts

@@ -0,0 +1,84 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class SearchAgenticDatabaseRequest extends $dara.Model {
+  /**
+   * @remarks
+   * The UUID of the catalog that limits the search scope. If you do not specify this parameter, the search is performed across all catalogs.
+   * 
+   * @example
+   * mc-HZ-OfjcNc2z***
+   */
+  catalogUuid?: string;
+  /**
+   * @remarks
+   * The database type. This parameter filters the results exactly by the database type of the data source associated with the catalog. The value is the uppercase name of the database type, such as MYSQL.
+   * 
+   * @example
+   * MYSQL
+   */
+  dbType?: string;
+  /**
+   * @remarks
+   * The environment type. This parameter filters the results exactly by the environment of the associated data source. Valid values: product, pre, dev, test, sit, uat, pet, and stag.
+   * 
+   * @example
+   * product
+   */
+  envType?: string;
+  /**
+   * @remarks
+   * The maximum number of entries to return per page.
+   * 
+   * @example
+   * 20
+   */
+  maxResults?: number;
+  /**
+   * @remarks
+   * The token for the next query. You do not need to specify this parameter for the first query. When you query the next page, set this parameter to the NextToken value returned from the previous query.
+   * 
+   * @example
+   * f056501ada12****
+   */
+  nextToken?: string;
+  /**
+   * @remarks
+   * The search keyword. It matches the name, fully qualified name, and search name of the database, as well as the name or data source alias of the associated catalog.
+   * 
+   * @example
+   * order
+   */
+  searchKey?: string;
+  static names(): { [key: string]: string } {
+    return {
+      catalogUuid: 'CatalogUuid',
+      dbType: 'DbType',
+      envType: 'EnvType',
+      maxResults: 'MaxResults',
+      nextToken: 'NextToken',
+      searchKey: 'SearchKey',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      catalogUuid: 'string',
+      dbType: 'string',
+      envType: 'string',
+      maxResults: 'number',
+      nextToken: 'string',
+      searchKey: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/SearchAgenticDatabaseResponse.ts

@@ -0,0 +1,40 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+import { SearchAgenticDatabaseResponseBody } from "./SearchAgenticDatabaseResponseBody";
+
+
+export class SearchAgenticDatabaseResponse extends $dara.Model {
+  headers?: { [key: string]: string };
+  statusCode?: number;
+  body?: SearchAgenticDatabaseResponseBody;
+  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: SearchAgenticDatabaseResponseBody,
+    };
+  }
+
+  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/SearchAgenticDatabaseResponseBody.ts

@@ -0,0 +1,98 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+import { AgenticDatabase } from "./AgenticDatabase";
+
+
+export class SearchAgenticDatabaseResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The list of databases.
+   */
+  data?: AgenticDatabase[];
+  /**
+   * @remarks
+   * The error code. This parameter is returned when a request exception occurs.
+   * 
+   * @example
+   * UnknownError
+   */
+  errorCode?: string;
+  /**
+   * @remarks
+   * The error message. This parameter is returned when the call fails.
+   * 
+   * @example
+   * UnknownError
+   */
+  errorMessage?: string;
+  /**
+   * @remarks
+   * The maximum number of entries returned per page in the current query.
+   * 
+   * @example
+   * 20
+   */
+  maxResults?: number;
+  /**
+   * @remarks
+   * The token for the next query. An empty value indicates that no more data is available. If the value is not empty, use it as the NextToken parameter in the next request to query the next page.
+   * 
+   * @example
+   * NesLoKLEdIZrKhDT7I2gS****
+   */
+  nextToken?: string;
+  /**
+   * @remarks
+   * The request ID.
+   * 
+   * @example
+   * 67E910F2-4B62-5B0C-ACA3-7547695C****
+   */
+  requestId?: string;
+  /**
+   * @remarks
+   * Indicates whether the request was successful. Valid values:
+   * 
+   * - **true**: The request was successful.
+   * - **false**: The request failed.
+   * 
+   * @example
+   * true
+   */
+  success?: boolean;
+  static names(): { [key: string]: string } {
+    return {
+      data: 'Data',
+      errorCode: 'ErrorCode',
+      errorMessage: 'ErrorMessage',
+      maxResults: 'MaxResults',
+      nextToken: 'NextToken',
+      requestId: 'RequestId',
+      success: 'Success',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      data: { 'type': 'array', 'itemType': AgenticDatabase },
+      errorCode: 'string',
+      errorMessage: 'string',
+      maxResults: 'number',
+      nextToken: 'string',
+      requestId: 'string',
+      success: 'boolean',
+    };
+  }
+
+  validate() {
+    if(Array.isArray(this.data)) {
+      $dara.Model.validateArray(this.data);
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/TestAgenticDataSourceConnectionRequest.ts

@@ -0,0 +1,257 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class TestAgenticDataSourceConnectionRequest extends $dara.Model {
+  /**
+   * @remarks
+   * The alias. You can leave this parameter empty when testing a connection. This parameter does not create or modify a data source.
+   * 
+   * @example
+   * demo_mysql
+   */
+  alias?: string;
+  /**
+   * @remarks
+   * The logon username. You can leave this parameter empty for authentication methods that do not require a username.
+   * 
+   * @example
+   * db_user
+   */
+  authAccount?: string;
+  /**
+   * @remarks
+   * The logon password. When testing an existing data source, you can leave this parameter empty to reuse the saved password. If a new value is passed, the new value takes precedence.
+   * 
+   * @example
+   * P@ss****
+   */
+  authPassword?: string;
+  /**
+   * @remarks
+   * The authentication type. This parameter is optional. Valid values: -1 (no authentication required), 0 (username and password), 1 (password only), and 2 (password-free).
+   * 
+   * @example
+   * 0
+   */
+  authType?: number;
+  /**
+   * @remarks
+   * The catalog name. You can leave this parameter empty when testing a connection. This parameter does not create a metadata catalog.
+   * 
+   * @example
+   * demo_catalog
+   */
+  catalogName?: string;
+  /**
+   * @remarks
+   * The UUID of the data source. This parameter is required when testing an existing data source. If no new password is passed, the saved password is reused. Leave this parameter empty when testing a new data source.
+   * 
+   * @example
+   * cn-hangzhou_a1b2c3d4e5f6
+   */
+  dataSourceUuid?: string;
+  /**
+   * @remarks
+   * The type of the data source. Use uppercase letters. Do not pass numbers. Valid values: MYSQL, POSTGRESQL, ORACLE, SQLSERVER, MARIADB, POLARDB, POLARDB_POSTGRESQL, POLARDB_ORACLE, OCEANBASEX, DRDS, ADB_MYSQL, ADB_POSTGRESQL, CLICKHOUSE, SELECTDB, STARROCKS, HOLOGRES, MAXCOMPUTE, ES_REST, and TRINO.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * MYSQL
+   */
+  dbType?: string;
+  /**
+   * @remarks
+   * The environment type. This parameter is optional when testing a connection. Valid values: product, pre, dev, test, sit, uat, pet, and stag.
+   * 
+   * @example
+   * product
+   */
+  envType?: string;
+  /**
+   * @remarks
+   * The domain name or IP address of the database. Do not include the protocol, path, or port. This parameter is optional. You can leave this parameter empty when you select an existing cloud instance and the endpoint is automatically populated.
+   * 
+   * @example
+   * mysql.example.com
+   */
+  host?: string;
+  /**
+   * @remarks
+   * The ID of the cloud resource instance. This parameter is required when you select an existing cloud instance. You can leave this parameter empty when you enter a connection endpoint.
+   * 
+   * @example
+   * rm-bp1234567890
+   */
+  instanceResourceId?: string;
+  /**
+   * @remarks
+   * The source of the data source. Valid values:
+   * - RDS: ApsaraDB instance.
+   * - PUBLIC_OWN: self-managed database connected over the Internet.
+   * - ECS_OWN: self-managed database hosted on an ECS instance.
+   * - GATEWAY: database connected through Database Gateway.
+   * - VPC_IDC: database connected over a VPC or data center.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * RDS
+   */
+  instanceSource?: string;
+  /**
+   * @remarks
+   * The name of the KMS secret. This parameter is required when you use KMS to manage database credentials. Leave this parameter empty in other scenarios.
+   * 
+   * @example
+   * datasource-secret
+   */
+  kmsSecret?: string;
+  /**
+   * @remarks
+   * The service port of the database. This parameter is optional. You can leave this parameter empty when you select an existing cloud instance and the port is automatically populated.
+   * 
+   * @example
+   * 3306
+   */
+  port?: number;
+  /**
+   * @remarks
+   * The complete ARN of the RAM role. This parameter is required when you use an Alibaba Cloud RAM role to access the data source. Leave this parameter empty in other scenarios.
+   * 
+   * @example
+   * acs:ram::123456789012****:role/DataSourceRole
+   */
+  roleArn?: string;
+  /**
+   * @remarks
+   * The schema name. This parameter is optional. For ADB_POSTGRESQL, DRDS, POSTGRESQL, and POLARDB_POSTGRESQL, enter the database name. For ORACLE, enter the SID or service name, and prefix the service name with a forward slash (/). For POLARDB_ORACLE, enter the SID. For MAXCOMPUTE, enter the project name. Leave this parameter empty for other types.
+   * 
+   * @example
+   * postgres
+   */
+  schema?: string;
+  /**
+   * @remarks
+   * The name of the Snowflake role. This parameter takes effect only when DbType is set to SNOWFLAKE.
+   * 
+   * @example
+   * ROLE
+   */
+  snowflakeRole?: string;
+  /**
+   * @remarks
+   * The name of the Snowflake compute warehouse. This parameter takes effect only when DbType is set to SNOWFLAKE.
+   * 
+   * @example
+   * WAREHOUSE
+   */
+  snowflakeWarehouse?: string;
+  /**
+   * @remarks
+   * Specifies whether to synchronize the alias. This parameter is optional when testing a connection. This parameter does not modify the data source name.
+   * 
+   * @example
+   * 0
+   */
+  syncAlias?: number;
+  /**
+   * @remarks
+   * Specifies whether to enable SSL. Valid values:
+   * - 1: Enable.
+   * - 0: Disable.
+   * - -1: Use the default setting.
+   * SSL is supported only for ADB_MYSQL, CLICKHOUSE, MARIADB, MYSQL, OCEANBASEX, POLARDB, SELECTDB, and STARROCKS. Leave this parameter empty for other types.
+   * 
+   * @example
+   * 1
+   */
+  useSsl?: number;
+  /**
+   * @remarks
+   * The ID of the vSwitch. This parameter is required when you access MaxCompute over a VPC. Leave this parameter empty in other scenarios.
+   * 
+   * @example
+   * vsw-bp1234567890
+   */
+  vSwitchId?: string;
+  /**
+   * @remarks
+   * The ID of the VPC. This parameter is required when you access MaxCompute over a VPC. Leave this parameter empty in other scenarios.
+   * 
+   * @example
+   * vpc-bp1234567890
+   */
+  vpcId?: string;
+  /**
+   * @remarks
+   * The zone ID. This parameter is required when you access MaxCompute over a VPC. Leave this parameter empty in other scenarios.
+   * 
+   * @example
+   * cn-hangzhou-h
+   */
+  zoneId?: string;
+  static names(): { [key: string]: string } {
+    return {
+      alias: 'Alias',
+      authAccount: 'AuthAccount',
+      authPassword: 'AuthPassword',
+      authType: 'AuthType',
+      catalogName: 'CatalogName',
+      dataSourceUuid: 'DataSourceUuid',
+      dbType: 'DbType',
+      envType: 'EnvType',
+      host: 'Host',
+      instanceResourceId: 'InstanceResourceId',
+      instanceSource: 'InstanceSource',
+      kmsSecret: 'KmsSecret',
+      port: 'Port',
+      roleArn: 'RoleArn',
+      schema: 'Schema',
+      snowflakeRole: 'SnowflakeRole',
+      snowflakeWarehouse: 'SnowflakeWarehouse',
+      syncAlias: 'SyncAlias',
+      useSsl: 'UseSsl',
+      vSwitchId: 'VSwitchId',
+      vpcId: 'VpcId',
+      zoneId: 'ZoneId',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      alias: 'string',
+      authAccount: 'string',
+      authPassword: 'string',
+      authType: 'number',
+      catalogName: 'string',
+      dataSourceUuid: 'string',
+      dbType: 'string',
+      envType: 'string',
+      host: 'string',
+      instanceResourceId: 'string',
+      instanceSource: 'string',
+      kmsSecret: 'string',
+      port: 'number',
+      roleArn: 'string',
+      schema: 'string',
+      snowflakeRole: 'string',
+      snowflakeWarehouse: 'string',
+      syncAlias: 'number',
+      useSsl: 'number',
+      vSwitchId: 'string',
+      vpcId: 'string',
+      zoneId: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/TestAgenticDataSourceConnectionResponse.ts

@@ -0,0 +1,40 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+import { TestAgenticDataSourceConnectionResponseBody } from "./TestAgenticDataSourceConnectionResponseBody";
+
+
+export class TestAgenticDataSourceConnectionResponse extends $dara.Model {
+  headers?: { [key: string]: string };
+  statusCode?: number;
+  body?: TestAgenticDataSourceConnectionResponseBody;
+  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: TestAgenticDataSourceConnectionResponseBody,
+    };
+  }
+
+  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);
+  }
+}
+