@alicloud/polardb20170801 8.2.4 → 8.3.0

package/dist/models/ModifyBackupPolicyShrinkRequest.d.ts

@@ -2,32 +2,24 @@ import * as $dara from '@darabonba/typescript';
 export declare class ModifyBackupPolicyShrinkRequest extends $dara.Model {
     /**
      * @remarks
-     * The advanced backup policies.
-     *
-     * > - - This parameter is not supported for PolarDB for PostgreSQL (compatible with Oracle) and PolarDB for PostgreSQL.
-     * >
-     * > - - This parameter is supported only for clusters for which `BackupPolicyLevel` is set to `Advanced`.
+     * The advanced backup policy.
+     * > * * PolarDB for PostgreSQL (Compatible with Oracle) and PolarDB for PostgreSQL do not support this parameter.
+     * > * * Only clusters with BackupPolicyLevel set to Advanced support this parameter.
      */
     advancedDataPoliciesShrink?: string;
     /**
      * @remarks
      * The backup frequency. Valid values:
      *
-     * - **Normal** (default): standard backup. The cluster is backed up once a day.
-     *
-     * - **2/24H**: high-frequency backup. The cluster is backed up every 2 hours.
-     *
-     * - **3/24H**: high-frequency backup. The cluster is backed up every 3 hours.
+     * - **Normal** (default): regular backup. Automatic backup is performed once a day at a scheduled time.
+     * - **2/24H**: high-frequency backup. Backup is performed every 2 hours.
+     * - **3/24H**: high-frequency backup. Backup is performed every 3 hours.
+     * - **4/24H**: high-frequency backup. Backup is performed every 4 hours.
      *
-     * - **4/24H**: high-frequency backup. The cluster is backed up every 4 hours.
-     *
-     * > * * If you enable high-frequency backup, all backups completed within the last 24 hours are retained. For backups older than 24 hours, the system retains only the first backup completed after 00:00 each day and deletes the rest.
-     * >
-     * > * - If you enable high-frequency backup, the **PreferredBackupPeriod** parameter is automatically set to all days of the week (from Monday to Sunday).
-     * >
-     * > * - This parameter is not supported if your PolarDB for MySQL cluster is in a region that supports the cross-region backup feature. For more information about the regions that support cross-region backup, see [Overview](https://help.aliyun.com/document_detail/72672.html).
-     * >
-     * > * - After you enable advanced backup, this parameter is no longer effective. Use the `AdvancedDataPolicies` parameter instead.
+     * > * * After high-frequency backup is enabled, all backups completed within 24 hours are retained. For backups older than 24 hours, only the first backup completed after 00:00 each day is retained, and all others are deleted.
+     * > * * After high-frequency backup is enabled, the backup cycle parameter PreferredBackupPeriod defaults to all days of the week (Monday through Sunday).
+     * > * * If the region of your PolarDB for MySQL cluster supports the cross-region backup feature, this parameter is not supported. For regions that support cross-region backup, see [Overview](https://help.aliyun.com/document_detail/72672.html).
+     * > * * After advanced backup is enabled, this parameter no longer takes effect. Use the AdvancedDataPolicies parameter instead.
      *
      * @example
      * Normal
@@ -35,17 +27,12 @@ export declare class ModifyBackupPolicyShrinkRequest extends $dara.Model {
     backupFrequency?: string;
     /**
      * @remarks
-     * The level of the backup policy. Valid values:
-     *
-     * - **Normal**: standard backup
-     *
-     * - **Advanced**: advanced backup
-     *
-     * > * * This parameter is not supported for PolarDB for PostgreSQL (compatible with Oracle) and PolarDB for PostgreSQL.
-     * >
-     * > * - Check the `AdvancedPolicyOption` parameter in the response of the [DescribeBackupPolicy](https://help.aliyun.com/document_detail/2319231.html) operation to determine whether the cluster supports advanced backup. If the cluster supports advanced backup, you can request this feature in [Advanced backup settings](~611727~~).
-     * >
-     * > * - After you enable advanced backup, you **cannot** switch back to standard backup.
+     * The backup policy level. Valid values:
+     * * **Normal**: regular backup.
+     * * **Advanced**: advanced backup.
+     * > * * PolarDB for PostgreSQL (Compatible with Oracle) and PolarDB for PostgreSQL do not support this parameter.
+     * > * * You can check the AdvancedPolicyOption response parameter of the [DescribeBackupPolicy](https://help.aliyun.com/document_detail/2319231.html) operation to determine whether the cluster supports advanced backup. If the cluster supports advanced backup, you can apply to use this feature through [Advanced backup settings](~611727~~).
+     * > * * After advanced backup is enabled, rollback to regular backup is **not supported**.
      *
      * @example
      * Normal
@@ -53,15 +40,15 @@ export declare class ModifyBackupPolicyShrinkRequest extends $dara.Model {
     backupPolicyLevel?: string;
     /**
      * @remarks
-     * Specifies whether to retain backups when you delete the cluster. Valid values:
+     * Specifies whether to retain backups when the cluster is deleted. Valid values:
      *
-     * - **ALL**: Permanently retains all backups.
+     * - **ALL**: Long-term retention (LTR) of all backups.
      *
-     * - **LATEST**: Permanently retains the last backup.
+     * - **LATEST**: Long-term retention (LTR) of only the last backup.
      *
-     * - **NONE**: Does not retain backup sets.
+     * - **NONE**: Does not retain any backups.
      *
-     * > The default value is `NONE`.
+     * > Default value: NONE.
      *
      * @example
      * NONE
@@ -71,7 +58,7 @@ export declare class ModifyBackupPolicyShrinkRequest extends $dara.Model {
      * @remarks
      * The cluster ID.
      *
-     * > You can call the [DescribeDBClusters](https://help.aliyun.com/document_detail/98094.html) operation to query the details of all clusters in a specified region, including the cluster IDs.
+     * > You can call the [DescribeDBClusters](https://help.aliyun.com/document_detail/98094.html) operation to query information about all clusters in a specific region, including cluster IDs.
      *
      * This parameter is required.
      *
@@ -83,19 +70,14 @@ export declare class ModifyBackupPolicyShrinkRequest extends $dara.Model {
      * @remarks
      * The backup frequency. Valid values:
      *
-     * - **Normal** (default): standard backup. The cluster is backed up once a day.
-     *
-     * - **2/24H**: high-frequency backup. The cluster is backed up every 2 hours.
-     *
-     * - **3/24H**: high-frequency backup. The cluster is backed up every 3 hours.
+     * - **Normal** (default): regular backup. Automatic backup is performed once a day at a scheduled time.
+     * - **2/24H**: high-frequency backup. Backup is performed every 2 hours.
+     * - **3/24H**: high-frequency backup. Backup is performed every 3 hours.
+     * - **4/24H**: high-frequency backup. Backup is performed every 4 hours.
      *
-     * - **4/24H**: high-frequency backup. The cluster is backed up every 4 hours.
-     *
-     * > * * This parameter is not supported for PolarDB for PostgreSQL (compatible with Oracle) and PolarDB for PostgreSQL.
-     * >
-     * > * - This parameter is not supported if your PolarDB for MySQL cluster is in a region that supports the cross-region backup feature. For more information about the regions that support cross-region backup, see [Overview](https://help.aliyun.com/document_detail/72672.html).
-     * >
-     * > * - After you enable advanced backup, this parameter is no longer effective. Use the `AdvancedDataPolicies` parameter instead.
+     * > * * PolarDB for PostgreSQL (Compatible with Oracle) and PolarDB for PostgreSQL do not support this parameter.
+     * > * * If the region of your PolarDB for MySQL cluster does not support the cross-region backup feature, this parameter is not supported. For regions that support cross-region backup, see [Overview](https://help.aliyun.com/document_detail/72672.html).
+     * > * * After advanced backup is enabled, this parameter no longer takes effect. Use the AdvancedDataPolicies parameter instead.
      *
      * @example
      * Normal
@@ -104,28 +86,18 @@ export declare class ModifyBackupPolicyShrinkRequest extends $dara.Model {
     /**
      * @remarks
      * The level-1 backup cycle. Valid values:
-     *
-     * - **Monday**
-     *
-     * - **Tuesday**
-     *
-     * - **Wednesday**
-     *
-     * - **Thursday**
-     *
-     * - **Friday**
-     *
-     * - **Saturday**
-     *
-     * - **Sunday**
-     *
-     * > * * You must select at least two days. Separate multiple values with commas.
-     * >
-     * > * - This parameter is not supported for PolarDB for PostgreSQL (compatible with Oracle) and PolarDB for PostgreSQL.
-     * >
-     * > * - This parameter is not supported if your PolarDB for MySQL cluster is in a region that supports the cross-region backup feature. For more information about the regions that support cross-region backup, see [Overview](https://help.aliyun.com/document_detail/72672.html).
-     * >
-     * > * - After you enable advanced backup, this parameter is no longer effective. Use the `AdvancedDataPolicies` parameter instead.
+     * * **Monday**
+     * * **Tuesday**
+     * * **Wednesday**
+     * * **Thursday**
+     * * **Friday**
+     * * **Saturday**
+     * * **Sunday**
+     *
+     * > * * Select at least 2 days. Separate multiple values with commas (,).
+     * > * * PolarDB for PostgreSQL (Compatible with Oracle) and PolarDB for PostgreSQL do not support this parameter.
+     * > * * If the region of your PolarDB for MySQL cluster does not support the cross-region backup feature, this parameter is not supported. For regions that support cross-region backup, see [Overview](https://help.aliyun.com/document_detail/72672.html).
+     * > * * After advanced backup is enabled, this parameter no longer takes effect. Use the AdvancedDataPolicies parameter instead.
      *
      * @example
      * Monday,Tuesday
@@ -133,9 +105,9 @@ export declare class ModifyBackupPolicyShrinkRequest extends $dara.Model {
     dataLevel1BackupPeriod?: string;
     /**
      * @remarks
-     * The retention period for level-1 backups, in days. Valid values: 3 to 14.
+     * The retention period of level-1 backups. Valid values: 3 to 14. Unit: days.
      *
-     * > - After you enable advanced backup, this parameter is no longer effective. Use the `AdvancedDataPolicies` parameter instead.
+     * > * After advanced backup is enabled, this parameter no longer takes effect. Use the AdvancedDataPolicies parameter instead.
      *
      * @example
      * 3
@@ -143,11 +115,10 @@ export declare class ModifyBackupPolicyShrinkRequest extends $dara.Model {
     dataLevel1BackupRetentionPeriod?: string;
     /**
      * @remarks
-     * The time window for automatic backups. Specify the time in UTC and in the `hh:mmZ-hh:mmZ` format. The time window must be a one-hour period that starts on the hour. For example, `14:00Z-15:00Z`.
+     * The time period during which automatic backup is performed. Specify the time period in the `hh:mmZ-hh:mmZ` format in UTC. The values must be on the hour with an interval of 1 hour, such as `14:00Z-15:00Z`.
      *
-     * > - This parameter is not supported for PolarDB for PostgreSQL (compatible with Oracle) and PolarDB for PostgreSQL.
-     * >
-     * > - This parameter is not supported if your PolarDB for MySQL cluster is in a region that supports the cross-region backup feature. For more information about the regions that support cross-region backup, see [Overview](https://help.aliyun.com/document_detail/72672.html).
+     * > * PolarDB for PostgreSQL (Compatible with Oracle) and PolarDB for PostgreSQL do not support this parameter.
+     * > * If the region of your PolarDB for MySQL cluster does not support the cross-region backup feature, this parameter is not supported. For regions that support cross-region backup, see [Overview](https://help.aliyun.com/document_detail/72672.html).
      *
      * @example
      * 15:00Z-16:00Z
@@ -155,9 +126,8 @@ export declare class ModifyBackupPolicyShrinkRequest extends $dara.Model {
     dataLevel1BackupTime?: string;
     /**
      * @remarks
-     * The destination region for the cross-region level-2 backup. For more information about the regions that support cross-region backup, see [Overview](https://help.aliyun.com/document_detail/72672.html).
-     *
-     * > - After you enable advanced backup, this parameter is no longer effective. Use the `AdvancedDataPolicies` parameter instead.
+     * The destination region for cross-region level-2 backups. For regions that support cross-region backup, see [Overview](https://help.aliyun.com/document_detail/72672.html).
+     * > * After advanced backup is enabled, this parameter no longer takes effect. Use the AdvancedDataPolicies parameter instead.
      *
      * @example
      * cn-hangzhou
@@ -165,17 +135,16 @@ export declare class ModifyBackupPolicyShrinkRequest extends $dara.Model {
     dataLevel2BackupAnotherRegionRegion?: string;
     /**
      * @remarks
-     * The retention period of cross-region level-2 backups. Valid values:
+     * The retention period of cross-region backups for level-2 backups. Valid values:
      *
-     * - **0**: Disables the cross-region level-2 backup feature.
+     * - **0**: Disables the level-2 cross-region backup feature.
      *
-     * - **30 to 7300**: The retention period of cross-region level-2 backups, in days.
+     * - **30 to 7300**: The retention period of level-2 backups. Unit: days.
      *
-     * - **-1**: Cross-region level-2 backups are permanently retained.
+     * - **-1**: Long-term retention (LTR) of level-2 backups.
      *
-     * > * * When you create a cluster, the default value is **0**, which disables the cross-region level-2 backup feature.
-     * >
-     * > * - After you enable advanced backup, this parameter is no longer effective. Use the `AdvancedDataPolicies` parameter instead.
+     *  > * * When a cluster is created, the default value is **0**, which means the level-2 cross-region backup feature is disabled.
+     * > * * After advanced backup is enabled, this parameter no longer takes effect. Use the AdvancedDataPolicies parameter instead.
      *
      * @example
      * 30
@@ -184,28 +153,18 @@ export declare class ModifyBackupPolicyShrinkRequest extends $dara.Model {
     /**
      * @remarks
      * The level-2 backup cycle. Valid values:
-     *
-     * - **Monday**
-     *
-     * - **Tuesday**
-     *
-     * - **Wednesday**
-     *
-     * - **Thursday**
-     *
-     * - **Friday**
-     *
-     * - **Saturday**
-     *
-     * - **Sunday**
-     *
-     * > * * You must select at least two days. Separate multiple values with commas.
-     * >
-     * > * - This parameter is not supported for PolarDB for PostgreSQL (compatible with Oracle) and PolarDB for PostgreSQL.
-     * >
-     * > * - This parameter is not supported if your PolarDB for MySQL cluster is in a region that supports the cross-region backup feature. For more information about the regions that support cross-region backup, see [Overview](https://help.aliyun.com/document_detail/72672.html).
-     * >
-     * > * - After you enable advanced backup, this parameter is no longer effective. Use the `AdvancedDataPolicies` parameter instead.
+     * * **Monday**
+     * * **Tuesday**
+     * * **Wednesday**
+     * * **Thursday**
+     * * **Friday**
+     * * **Saturday**
+     * * **Sunday**
+     *
+     * > * * Select at least 2 days. Separate multiple values with commas (,).
+     * > * * PolarDB for PostgreSQL (Compatible with Oracle) and PolarDB for PostgreSQL do not support this parameter.
+     * > * * If the region of your PolarDB for MySQL cluster does not support the cross-region backup feature, this parameter is not supported. For regions that support cross-region backup, see [Overview](https://help.aliyun.com/document_detail/72672.html).
+     * > * * After advanced backup is enabled, this parameter no longer takes effect. Use the AdvancedDataPolicies parameter instead.
      *
      * @example
      * Monday,Tuesday
@@ -217,13 +176,12 @@ export declare class ModifyBackupPolicyShrinkRequest extends $dara.Model {
      *
      * - **0**: Disables the level-2 backup feature.
      *
-     * - **30 to 7300**: The retention period of level-2 backups, in days.
+     * - **30 to 7300**: The retention period of level-2 backups. Unit: days.
      *
-     * - **-1**: Level-2 backups are permanently retained.
+     * - **-1**: Long-term retention (LTR) of level-2 backups.
      *
-     * > * * When you create a cluster, the default value is **0**, which disables the level-2 backup feature.
-     * >
-     * > * - After you enable advanced backup, this parameter is no longer effective. Use the `AdvancedDataPolicies` parameter instead.
+     *  > * * When a cluster is created, the default value is **0**, which means the level-2 backup feature is disabled.
+     * > * * After advanced backup is enabled, this parameter no longer takes effect. Use the AdvancedDataPolicies parameter instead.
      *
      * @example
      * 0
@@ -234,26 +192,17 @@ export declare class ModifyBackupPolicyShrinkRequest extends $dara.Model {
     /**
      * @remarks
      * The backup cycle. Valid values:
-     *
-     * - **Monday**
-     *
-     * - **Tuesday**
-     *
-     * - **Wednesday**
-     *
-     * - **Thursday**
-     *
-     * - **Friday**
-     *
-     * - **Saturday**
-     *
-     * - **Sunday**
-     *
-     * > * * You must select at least two days. Separate multiple values with commas.
-     * >
-     * > * - This parameter is not supported if your PolarDB for MySQL cluster is in a region that supports the cross-region backup feature. For more information about the regions that support cross-region backup, see [Overview](https://help.aliyun.com/document_detail/72672.html).
-     * >
-     * > * - After you enable advanced backup, this parameter is no longer effective. Use the `AdvancedDataPolicies` parameter instead.
+     * * **Monday**
+     * * **Tuesday**
+     * * **Wednesday**
+     * * **Thursday**
+     * * **Friday**
+     * * **Saturday**
+     * * **Sunday**
+     *
+     * > * * Select at least 2 days. Separate multiple values with commas (,).
+     * > * * If the region of your PolarDB for MySQL cluster supports the cross-region backup feature, this parameter is not supported. For regions that support cross-region backup, see [Overview](https://help.aliyun.com/document_detail/72672.html).
+     * > * * After advanced backup is enabled, this parameter no longer takes effect. Use the AdvancedDataPolicies parameter instead.
      *
      * @example
      * Monday,Tuesday
@@ -261,7 +210,7 @@ export declare class ModifyBackupPolicyShrinkRequest extends $dara.Model {
     preferredBackupPeriod?: string;
     /**
      * @remarks
-     * The time window for automatic backups. Specify the time in UTC and in the `hh:mmZ-hh:mmZ` format. The time window must be a one-hour period that starts on the hour. For example, `14:00Z-15:00Z`.
+     * The time period during which automatic backup is performed. Specify the time period in the `hh:mmZ-hh:mmZ` format in UTC. The values must be on the hour with an interval of 1 hour, such as `14:00Z-15:00Z`.
      *
      * @example
      * 15:00Z-16:00Z

package/dist/models/ModifyBackupPolicyShrinkRequest.js.map

@@ -1 +1 @@
-{"version":3,"file":"ModifyBackupPolicyShrinkRequest.js","sourceRoot":"","sources":["../../src/models/ModifyBackupPolicyShrinkRequest.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,6CAA6C;AAC7C,6DAA+C;AAG/C,MAAa,+BAAgC,SAAQ,KAAK,CAAC,KAAK;IA8Q9D,MAAM,CAAC,KAAK;QACV,OAAO;YACL,0BAA0B,EAAE,sBAAsB;YAClD,eAAe,EAAE,iBAAiB;YAClC,iBAAiB,EAAE,mBAAmB;YACtC,sCAAsC,EAAE,wCAAwC;YAChF,WAAW,EAAE,aAAa;YAC1B,yBAAyB,EAAE,2BAA2B;YACtD,sBAAsB,EAAE,wBAAwB;YAChD,+BAA+B,EAAE,iCAAiC;YAClE,oBAAoB,EAAE,sBAAsB;YAC5C,mCAAmC,EAAE,qCAAqC;YAC1E,4CAA4C,EAAE,8CAA8C;YAC5F,sBAAsB,EAAE,wBAAwB;YAChD,+BAA+B,EAAE,iCAAiC;YAClE,YAAY,EAAE,cAAc;YAC5B,OAAO,EAAE,SAAS;YAClB,qBAAqB,EAAE,uBAAuB;YAC9C,mBAAmB,EAAE,qBAAqB;YAC1C,oBAAoB,EAAE,sBAAsB;YAC5C,eAAe,EAAE,iBAAiB;SACnC,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,KAAK;QACV,OAAO;YACL,0BAA0B,EAAE,QAAQ;YACpC,eAAe,EAAE,QAAQ;YACzB,iBAAiB,EAAE,QAAQ;YAC3B,sCAAsC,EAAE,QAAQ;YAChD,WAAW,EAAE,QAAQ;YACrB,yBAAyB,EAAE,QAAQ;YACnC,sBAAsB,EAAE,QAAQ;YAChC,+BAA+B,EAAE,QAAQ;YACzC,oBAAoB,EAAE,QAAQ;YAC9B,mCAAmC,EAAE,QAAQ;YAC7C,4CAA4C,EAAE,QAAQ;YACtD,sBAAsB,EAAE,QAAQ;YAChC,+BAA+B,EAAE,QAAQ;YACzC,YAAY,EAAE,QAAQ;YACtB,OAAO,EAAE,QAAQ;YACjB,qBAAqB,EAAE,QAAQ;YAC/B,mBAAmB,EAAE,QAAQ;YAC7B,oBAAoB,EAAE,QAAQ;YAC9B,eAAe,EAAE,QAAQ;SAC1B,CAAC;IACJ,CAAC;IAED,QAAQ;QACN,KAAK,CAAC,QAAQ,EAAE,CAAC;IACnB,CAAC;IAED,YAAY,GAA4B;QACtC,KAAK,CAAC,GAAG,CAAC,CAAC;IACb,CAAC;CACF;AArUD,0EAqUC"}
+{"version":3,"file":"ModifyBackupPolicyShrinkRequest.js","sourceRoot":"","sources":["../../src/models/ModifyBackupPolicyShrinkRequest.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,6CAA6C;AAC7C,6DAA+C;AAG/C,MAAa,+BAAgC,SAAQ,KAAK,CAAC,KAAK;IA2N9D,MAAM,CAAC,KAAK;QACV,OAAO;YACL,0BAA0B,EAAE,sBAAsB;YAClD,eAAe,EAAE,iBAAiB;YAClC,iBAAiB,EAAE,mBAAmB;YACtC,sCAAsC,EAAE,wCAAwC;YAChF,WAAW,EAAE,aAAa;YAC1B,yBAAyB,EAAE,2BAA2B;YACtD,sBAAsB,EAAE,wBAAwB;YAChD,+BAA+B,EAAE,iCAAiC;YAClE,oBAAoB,EAAE,sBAAsB;YAC5C,mCAAmC,EAAE,qCAAqC;YAC1E,4CAA4C,EAAE,8CAA8C;YAC5F,sBAAsB,EAAE,wBAAwB;YAChD,+BAA+B,EAAE,iCAAiC;YAClE,YAAY,EAAE,cAAc;YAC5B,OAAO,EAAE,SAAS;YAClB,qBAAqB,EAAE,uBAAuB;YAC9C,mBAAmB,EAAE,qBAAqB;YAC1C,oBAAoB,EAAE,sBAAsB;YAC5C,eAAe,EAAE,iBAAiB;SACnC,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,KAAK;QACV,OAAO;YACL,0BAA0B,EAAE,QAAQ;YACpC,eAAe,EAAE,QAAQ;YACzB,iBAAiB,EAAE,QAAQ;YAC3B,sCAAsC,EAAE,QAAQ;YAChD,WAAW,EAAE,QAAQ;YACrB,yBAAyB,EAAE,QAAQ;YACnC,sBAAsB,EAAE,QAAQ;YAChC,+BAA+B,EAAE,QAAQ;YACzC,oBAAoB,EAAE,QAAQ;YAC9B,mCAAmC,EAAE,QAAQ;YAC7C,4CAA4C,EAAE,QAAQ;YACtD,sBAAsB,EAAE,QAAQ;YAChC,+BAA+B,EAAE,QAAQ;YACzC,YAAY,EAAE,QAAQ;YACtB,OAAO,EAAE,QAAQ;YACjB,qBAAqB,EAAE,QAAQ;YAC/B,mBAAmB,EAAE,QAAQ;YAC7B,oBAAoB,EAAE,QAAQ;YAC9B,eAAe,EAAE,QAAQ;SAC1B,CAAC;IACJ,CAAC;IAED,QAAQ;QACN,KAAK,CAAC,QAAQ,EAAE,CAAC;IACnB,CAAC;IAED,YAAY,GAA4B;QACtC,KAAK,CAAC,GAAG,CAAC,CAAC;IACb,CAAC;CACF;AAlRD,0EAkRC"}

package/dist/models/RegisterKnowledgeBaseFileRequest.d.ts

@@ -0,0 +1,43 @@
+import * as $dara from '@darabonba/typescript';
+export declare class RegisterKnowledgeBaseFileRequest extends $dara.Model {
+    /**
+     * @remarks
+     * The OSS object key of the uploaded file, excluding the oss://BucketName/ prefix.
+     *
+     * This parameter is required.
+     *
+     * @example
+     * pks-2ze123456789abcd/pkb-2ze123456789abcd/example.pdf
+     */
+    filePath?: string;
+    /**
+     * @remarks
+     * The knowledge base ID.
+     *
+     * This parameter is required.
+     *
+     * @example
+     * pkb-2ze123456789abcd
+     */
+    knowledgeBaseId?: string;
+    /**
+     * @remarks
+     * The ID of the region where the knowledge base resides.
+     *
+     * This parameter is required.
+     *
+     * @example
+     * cn-beijing
+     */
+    regionId?: string;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    validate(): void;
+    constructor(map?: {
+        [key: string]: any;
+    });
+}

package/dist/models/RegisterKnowledgeBaseFileRequest.js

@@ -0,0 +1,62 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RegisterKnowledgeBaseFileRequest = void 0;
+// This file is auto-generated, don't edit it
+const $dara = __importStar(require("@darabonba/typescript"));
+class RegisterKnowledgeBaseFileRequest extends $dara.Model {
+    static names() {
+        return {
+            filePath: 'FilePath',
+            knowledgeBaseId: 'KnowledgeBaseId',
+            regionId: 'RegionId',
+        };
+    }
+    static types() {
+        return {
+            filePath: 'string',
+            knowledgeBaseId: 'string',
+            regionId: 'string',
+        };
+    }
+    validate() {
+        super.validate();
+    }
+    constructor(map) {
+        super(map);
+    }
+}
+exports.RegisterKnowledgeBaseFileRequest = RegisterKnowledgeBaseFileRequest;
+//# sourceMappingURL=RegisterKnowledgeBaseFileRequest.js.map

package/dist/models/RegisterKnowledgeBaseFileRequest.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"RegisterKnowledgeBaseFileRequest.js","sourceRoot":"","sources":["../../src/models/RegisterKnowledgeBaseFileRequest.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,6CAA6C;AAC7C,6DAA+C;AAG/C,MAAa,gCAAiC,SAAQ,KAAK,CAAC,KAAK;IA+B/D,MAAM,CAAC,KAAK;QACV,OAAO;YACL,QAAQ,EAAE,UAAU;YACpB,eAAe,EAAE,iBAAiB;YAClC,QAAQ,EAAE,UAAU;SACrB,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,KAAK;QACV,OAAO;YACL,QAAQ,EAAE,QAAQ;YAClB,eAAe,EAAE,QAAQ;YACzB,QAAQ,EAAE,QAAQ;SACnB,CAAC;IACJ,CAAC;IAED,QAAQ;QACN,KAAK,CAAC,QAAQ,EAAE,CAAC;IACnB,CAAC;IAED,YAAY,GAA4B;QACtC,KAAK,CAAC,GAAG,CAAC,CAAC;IACb,CAAC;CACF;AAtDD,4EAsDC"}

package/dist/models/RegisterKnowledgeBaseFileResponse.d.ts

@@ -0,0 +1,19 @@
+import * as $dara from '@darabonba/typescript';
+import { RegisterKnowledgeBaseFileResponseBody } from "./RegisterKnowledgeBaseFileResponseBody";
+export declare class RegisterKnowledgeBaseFileResponse extends $dara.Model {
+    headers?: {
+        [key: string]: string;
+    };
+    statusCode?: number;
+    body?: RegisterKnowledgeBaseFileResponseBody;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    validate(): void;
+    constructor(map?: {
+        [key: string]: any;
+    });
+}

package/dist/models/RegisterKnowledgeBaseFileResponse.js

@@ -0,0 +1,69 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RegisterKnowledgeBaseFileResponse = void 0;
+// This file is auto-generated, don't edit it
+const $dara = __importStar(require("@darabonba/typescript"));
+const RegisterKnowledgeBaseFileResponseBody_1 = require("./RegisterKnowledgeBaseFileResponseBody");
+class RegisterKnowledgeBaseFileResponse extends $dara.Model {
+    static names() {
+        return {
+            headers: 'headers',
+            statusCode: 'statusCode',
+            body: 'body',
+        };
+    }
+    static types() {
+        return {
+            headers: { 'type': 'map', 'keyType': 'string', 'valueType': 'string' },
+            statusCode: 'number',
+            body: RegisterKnowledgeBaseFileResponseBody_1.RegisterKnowledgeBaseFileResponseBody,
+        };
+    }
+    validate() {
+        if (this.headers) {
+            $dara.Model.validateMap(this.headers);
+        }
+        if (this.body && typeof this.body.validate === 'function') {
+            this.body.validate();
+        }
+        super.validate();
+    }
+    constructor(map) {
+        super(map);
+    }
+}
+exports.RegisterKnowledgeBaseFileResponse = RegisterKnowledgeBaseFileResponse;
+//# sourceMappingURL=RegisterKnowledgeBaseFileResponse.js.map

package/dist/models/RegisterKnowledgeBaseFileResponse.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"RegisterKnowledgeBaseFileResponse.js","sourceRoot":"","sources":["../../src/models/RegisterKnowledgeBaseFileResponse.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,6CAA6C;AAC7C,6DAA+C;AAC/C,mGAAgG;AAGhG,MAAa,iCAAkC,SAAQ,KAAK,CAAC,KAAK;IAIhE,MAAM,CAAC,KAAK;QACV,OAAO;YACL,OAAO,EAAE,SAAS;YAClB,UAAU,EAAE,YAAY;YACxB,IAAI,EAAE,MAAM;SACb,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,KAAK;QACV,OAAO;YACL,OAAO,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,SAAS,EAAE,QAAQ,EAAE,WAAW,EAAE,QAAQ,EAAE;YACtE,UAAU,EAAE,QAAQ;YACpB,IAAI,EAAE,6EAAqC;SAC5C,CAAC;IACJ,CAAC;IAED,QAAQ;QACN,IAAG,IAAI,CAAC,OAAO,EAAE,CAAC;YAChB,KAAK,CAAC,KAAK,CAAC,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACxC,CAAC;QACD,IAAG,IAAI,CAAC,IAAI,IAAI,OAAQ,IAAI,CAAC,IAAY,CAAC,QAAQ,KAAK,UAAU,EAAE,CAAC;YACjE,IAAI,CAAC,IAAY,CAAC,QAAQ,EAAE,CAAC;QAChC,CAAC;QACD,KAAK,CAAC,QAAQ,EAAE,CAAC;IACnB,CAAC;IAED,YAAY,GAA4B;QACtC,KAAK,CAAC,GAAG,CAAC,CAAC;IACb,CAAC;CACF;AAjCD,8EAiCC"}

package/dist/models/RegisterKnowledgeBaseFileResponseBody.d.ts

@@ -0,0 +1,63 @@
+import * as $dara from '@darabonba/typescript';
+export declare class RegisterKnowledgeBaseFileResponseBody extends $dara.Model {
+    /**
+     * @remarks
+     * The file ID, which is generated by the server based on the ETL rules for native OSS files.
+     *
+     * @example
+     * 3566626f-3cc5-57a3-904c-e777b39baa3d
+     */
+    fileId?: string;
+    /**
+     * @remarks
+     * The file name.
+     *
+     * @example
+     * example.pdf
+     */
+    fileName?: string;
+    /**
+     * @remarks
+     * The OSS object key of the registered file.
+     *
+     * @example
+     * pks-2ze123456789abcd/pkb-2ze123456789abcd/example.pdf
+     */
+    filePath?: string;
+    /**
+     * @remarks
+     * Indicates whether an existing idempotent record is matched. Valid values:
+     * - true: An existing idempotent record is matched.
+     * - false: No existing idempotent record is matched.
+     *
+     * @example
+     * false
+     */
+    idempotent?: boolean;
+    /**
+     * @remarks
+     * The request ID.
+     *
+     * @example
+     * 9C3E5A7B-12D4-4F68-9A01-2B3C4D5E6F70
+     */
+    requestId?: string;
+    /**
+     * @remarks
+     * The file processing status.
+     *
+     * @example
+     * DISPATCHED
+     */
+    status?: string;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    validate(): void;
+    constructor(map?: {
+        [key: string]: any;
+    });
+}