@alicloud/adb20211201 5.4.0 → 5.5.1

package/src/models/CancelSqlPatternCompareReportResponseBody.ts

@@ -0,0 +1,64 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class CancelSqlPatternCompareReportResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The time when the report was first canceled. The time is in UTC in the yyyy-MM-ddTHH:mmZ format.
+   * 
+   * @example
+   * 2026-09-08T01:06Z
+   */
+  cancelTime?: string;
+  /**
+   * @remarks
+   * Indicates whether the report is canceled. The value true is returned when the report is successfully canceled or canceled again.
+   * 
+   * @example
+   * true
+   */
+  canceled?: boolean;
+  /**
+   * @remarks
+   * The SQL Pattern comparison report ID.
+   * 
+   * @example
+   * 1001
+   */
+  reportId?: number;
+  /**
+   * @remarks
+   * The request ID.
+   * 
+   * @example
+   * 9A1B2C3D-4E5F-6789-ABCD-0123456789AB
+   */
+  requestId?: string;
+  static names(): { [key: string]: string } {
+    return {
+      cancelTime: 'CancelTime',
+      canceled: 'Canceled',
+      reportId: 'ReportId',
+      requestId: 'RequestId',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      cancelTime: 'string',
+      canceled: 'boolean',
+      reportId: 'number',
+      requestId: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/CheckBindRamUserRequest.ts

@@ -5,9 +5,9 @@ import * as $dara from '@darabonba/typescript';
 export class CheckBindRamUserRequest extends $dara.Model {
   /**
    * @remarks
-   * The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.
-   * 
-   * >  You can call the [DescribeDBClusters](https://help.aliyun.com/document_detail/454250.html) operation to query the IDs of all AnalyticDB for MySQL clusters within a region.
+   * <props="china">The ID of the Enterprise Edition, Basic Edition, or Data Lakehouse Edition cluster.
+   * <props="intl">The ID of the Data Lakehouse Edition cluster.
+   * > You can call the [DescribeDBClusters](https://help.aliyun.com/document_detail/454250.html) operation to query the cluster ID.
    * 
    * @example
    * amv-wz9842849v6****
@@ -15,7 +15,7 @@ export class CheckBindRamUserRequest extends $dara.Model {
   DBClusterId?: string;
   /**
    * @remarks
-   * The region ID of the cluster.
+   * The region ID.
    * 
    * @example
    * cn-hangzhou

package/src/models/CheckBindRamUserResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class CheckBindRamUserResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The request ID.
+   * The ID of the request.
    * 
    * @example
    * 2FB9DCA3-DA56-5B43-A9A0-68E3D0E6AA84
@@ -13,10 +13,9 @@ export class CheckBindRamUserResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * The returned result of the request. Valid values:
-   * 
-   * *   **true**: the database account is associated with a RAM user.
-   * *   **false**: the database account is not associated with a RAM user.
+   * The result returned by the node. Valid values:
+   * - **true**: The current Resource Access Management (RAM) user is attached to a database account.
+   * - **false**: The current Resource Access Management (RAM) user is not attached to a database account.
    * 
    * @example
    * true

package/src/models/CheckFormationSchemaExistsRequest.ts

@@ -6,8 +6,7 @@ export class CheckFormationSchemaExistsRequest extends $dara.Model {
   /**
    * @remarks
    * The cluster ID.
-   * 
-   * > You can call the [DescribeDBClusters](https://help.aliyun.com/document_detail/129857.html) operation to query the cluster IDs of all AnalyticDB for MySQL Data Lakehouse Edition (V3.0) clusters in a region.
+   * > You can call the [DescribeDBClusters](https://help.aliyun.com/document_detail/129857.html) operation to query the IDs of all AnalyticDB for MySQL Data Lakehouse Edition (3.0) clusters in the destination region.
    * 
    * This parameter is required.
    * 
@@ -17,10 +16,9 @@ export class CheckFormationSchemaExistsRequest extends $dara.Model {
   DBClusterId?: string;
   /**
    * @remarks
-   * Specifies whether to enable prefix mode. Valid values:
-   * 
-   * - true: Enable prefix mode.
-   * - false: Disable prefix mode.
+   * Specifies whether to enable the prefix mode. Valid values:
+   * - true: Yes.
+   * - false: No.
    * 
    * This parameter is required.
    * 
@@ -40,7 +38,7 @@ export class CheckFormationSchemaExistsRequest extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
-   * schema 。
+   * The schema.
    * 
    * This parameter is required.
    * 

package/src/models/CheckFormationSchemaExistsResponseBody.ts

@@ -29,7 +29,7 @@ export class CheckFormationSchemaExistsResponseBody extends $dara.Model {
   httpStatusCode?: number;
   /**
    * @remarks
-   * The response message. OK is returned if the request was successful.
+   * The returned message. OK is returned if the request is successful.
    * 
    * @example
    * OK
@@ -45,7 +45,7 @@ export class CheckFormationSchemaExistsResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * Indicates whether the request was successful.
+   * Indicates whether the request is successful.
    * 
    * @example
    * true

package/src/models/CheckSampleDataSetRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class CheckSampleDataSetRequest extends $dara.Model {
   /**
    * @remarks
-   * The ID of the cluster.
+   * The cluster ID.
    * 
    * This parameter is required.
    * 

package/src/models/CheckSampleDataSetResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class CheckSampleDataSetResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The ID of the request.
+   * The request ID.
    * 
    * @example
    * 0CE655C3-C211-513D-A42F-D4AE2D1A867C
@@ -14,12 +14,11 @@ export class CheckSampleDataSetResponseBody extends $dara.Model {
   /**
    * @remarks
    * The status of the built-in dataset. Valid values:
+   * - **SUCCEED**: Loaded successfully.
    * 
-   * - **SUCCEED**: The dataset loaded successfully.
+   * - **INIT**: Loading.
    * 
-   * - **INIT**: Loading in progress.
-   * 
-   * - **FAILED**: Failed to load the dataset.
+   * - **FAILED**: Load failed.
    * 
    * - **UNINITIALIZED**: Not loaded.
    * 

package/src/models/ConfigureResultExportRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ConfigureResultExportRequestOssInfo extends $dara.Model {
   /**
    * @remarks
-   * The OSS path where the result sets are stored.
+   * The OSS path where the export results are stored.
    * 
    * @example
    * oss://testBucketName/data_result
@@ -13,7 +13,7 @@ export class ConfigureResultExportRequestOssInfo extends $dara.Model {
   exportBasePath?: string;
   /**
    * @remarks
-   * The name of the resource group that runs the job.
+   * The name of the resource group in which the export SQL statement is executed.
    * 
    * @example
    * aps
@@ -21,7 +21,7 @@ export class ConfigureResultExportRequestOssInfo extends $dara.Model {
   resourceGroup?: string;
   /**
    * @remarks
-   * The expiration time of the OSS file. Unit: days. Minimum: 1 day, maximum: 30 days. Values outside this range will result in an error.
+   * The expiration time of the OSS file. Unit: days. The minimum value is 1 day and the maximum value is 30 days. An error is returned if the value is out of range.
    * 
    * @example
    * 10
@@ -55,7 +55,7 @@ export class ConfigureResultExportRequestOssInfo extends $dara.Model {
 export class ConfigureResultExportRequestSlsInfo extends $dara.Model {
   /**
    * @remarks
-   * The expiration time of the Logstore temporarily generated during the result set export. Unit: days. The Logstore is automatically deleted after it expires. Minimum value: 1 day, maximum: 30 days. Values outside this range will result in an error.
+   * The expiration time of the temporary Logstore generated for result set export. Unit: days. The Logstore is automatically deleted after expiration. The minimum value is 1 day and the maximum value is 30 days. An error is returned if the value is out of range.
    * 
    * @example
    * 10
@@ -63,7 +63,7 @@ export class ConfigureResultExportRequestSlsInfo extends $dara.Model {
   logstoreTtl?: number;
   /**
    * @remarks
-   * The name of the resource group that runs the job.
+   * The name of the resource group in which the export SQL statement is executed.
    * 
    * @example
    * aps
@@ -106,8 +106,7 @@ export class ConfigureResultExportRequest extends $dara.Model {
   /**
    * @remarks
    * The cluster ID.
-   * 
-   * >  You can call the [DescribeDBClusters](https://help.aliyun.com/document_detail/129857.html) operation to query the information about all AnalyticDB for MySQL clusters within a region, including cluster IDs.
+   * > You can call the [DescribeDBClusters](https://help.aliyun.com/document_detail/129857.html) operation to view the cluster IDs of all AnalyticDB for MySQL clusters in the destination region.
    * 
    * This parameter is required.
    * 
@@ -119,8 +118,8 @@ export class ConfigureResultExportRequest extends $dara.Model {
    * @remarks
    * The export type. Valid values:
    * 
-   * *   SLS: Specifies that the export destination is SLS.
-   * *   OSS: Specifies that the export destination is OSS.
+   * - SLS: Exports data to SLS.
+   * - OSS: Exports data to OSS.
    * 
    * @example
    * SLS
@@ -128,12 +127,12 @@ export class ConfigureResultExportRequest extends $dara.Model {
   exportType?: string;
   /**
    * @remarks
-   * The OSS configuration details if the destination is of the OSS type.
+   * The OSS configuration information when the export destination is OSS.
    */
   ossInfo?: ConfigureResultExportRequestOssInfo;
   /**
    * @remarks
-   * The ID of the region where the instance resides.
+   * The region ID.
    * 
    * This parameter is required.
    * 
@@ -143,7 +142,7 @@ export class ConfigureResultExportRequest extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
-   * The SLS configuration details if the destination is of the SLS type.
+   * The SLS configuration information when the export destination is SLS.
    */
   slsInfo?: ConfigureResultExportRequestSlsInfo;
   static names(): { [key: string]: string } {

package/src/models/ConfigureResultExportResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ConfigureResultExportResponseBodyDataOssInfo extends $dara.Model {
   /**
    * @remarks
-   * The OSS path where the result sets are stored.
+   * The OSS path where the export results are stored.
    * 
    * @example
    * oss://testBucketName/data_result
@@ -13,7 +13,7 @@ export class ConfigureResultExportResponseBodyDataOssInfo extends $dara.Model {
   exportBasePath?: string;
   /**
    * @remarks
-   * The name of the resource group that runs the job.
+   * The name of the resource group in which the export SQL statement is executed.
    * 
    * @example
    * aps
@@ -21,7 +21,7 @@ export class ConfigureResultExportResponseBodyDataOssInfo extends $dara.Model {
   resourceGroup?: string;
   /**
    * @remarks
-   * The expiration time of the OSS file. Unit: days. Minimum: 1 day, maximum: 30 days.
+   * The expiration time of the OSS file. Unit: days. The minimum value is 1 day and the maximum value is 30 days.
    * 
    * @example
    * 10
@@ -55,7 +55,7 @@ export class ConfigureResultExportResponseBodyDataOssInfo extends $dara.Model {
 export class ConfigureResultExportResponseBodyDataSlsInfo extends $dara.Model {
   /**
    * @remarks
-   * The expiration time of the Logstore temporarily generated during the result set export. Unit: days. The Logstore is automatically deleted after it expires. Minimum value: 1 day. Maximum value: 30 days.
+   * The expiration time of the temporary Logstore generated for result set export. Unit: days. The Logstore is automatically deleted after expiration. The minimum value is 1 day and the maximum value is 30 days.
    * 
    * @example
    * 10
@@ -63,7 +63,7 @@ export class ConfigureResultExportResponseBodyDataSlsInfo extends $dara.Model {
   logstoreTtl?: number;
   /**
    * @remarks
-   * The name of the resource group that runs the job.
+   * The name of the resource group in which the export SQL statement is executed.
    * 
    * @example
    * aps
@@ -107,8 +107,8 @@ export class ConfigureResultExportResponseBodyData extends $dara.Model {
    * @remarks
    * The export type. Valid values:
    * 
-   * *   SLS: Indicates that the export destination is SLS.
-   * *   OSS: Indicates that the export destination is OSS.
+   * - SLS: Exports data to SLS.
+   * - OSS: Exports data to OSS.
    * 
    * @example
    * SLS
@@ -116,12 +116,12 @@ export class ConfigureResultExportResponseBodyData extends $dara.Model {
   exportType?: string;
   /**
    * @remarks
-   * The OSS configuration if the destination is of the OSS type.
+   * The OSS export information configured when the export destination is OSS.
    */
   ossInfo?: ConfigureResultExportResponseBodyDataOssInfo;
   /**
    * @remarks
-   * The SLS configuration if the destination is of the SLS type.
+   * The SLS configuration information when the export destination is SLS.
    */
   slsInfo?: ConfigureResultExportResponseBodyDataSlsInfo;
   static names(): { [key: string]: string } {
@@ -166,12 +166,12 @@ export class ConfigureResultExportResponseBody extends $dara.Model {
   code?: string;
   /**
    * @remarks
-   * The path where the result sets are stored.
+   * The configured result set export information.
    */
   data?: ConfigureResultExportResponseBodyData;
   /**
    * @remarks
-   * The HTTP status code. A value of 200 indicates that the request is successful.
+   * The HTTP status code. A status code of 200 indicates that the request was successful.
    * 
    * @example
    * 200
@@ -179,10 +179,10 @@ export class ConfigureResultExportResponseBody extends $dara.Model {
   httpStatusCode?: number;
   /**
    * @remarks
-   * The returned message. Valid values:
+   * The additional information about the call result. Description:
    * 
-   * *   OK is returned if the request is normal.
-   * *   The specific error code is returned if the request is abnormal,
+   * - If the request is normal, OK is returned.
+   * - If the request is abnormal, a specific error code is returned.
    * 
    * @example
    * OK
@@ -190,7 +190,7 @@ export class ConfigureResultExportResponseBody extends $dara.Model {
   message?: string;
   /**
    * @remarks
-   * The ID of the request.
+   * The request ID.
    * 
    * @example
    * 1AD222E9-E606-4A42-BF6D-8A4442913CEF
@@ -198,10 +198,9 @@ export class ConfigureResultExportResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * Indicates whether the request is successful. Valid values:
-   * 
-   * *   **true**: Succeeded.
-   * *   **false**: Failed.
+   * Indicates whether the call was successful. Valid values:
+   * - **true**: The call was successful.
+   * - **false**: The call failed.
    * 
    * @example
    * true

package/src/models/ConfigureResultExportShrinkRequest.ts

@@ -6,8 +6,7 @@ export class ConfigureResultExportShrinkRequest extends $dara.Model {
   /**
    * @remarks
    * The cluster ID.
-   * 
-   * >  You can call the [DescribeDBClusters](https://help.aliyun.com/document_detail/129857.html) operation to query the information about all AnalyticDB for MySQL clusters within a region, including cluster IDs.
+   * > You can call the [DescribeDBClusters](https://help.aliyun.com/document_detail/129857.html) operation to view the cluster IDs of all AnalyticDB for MySQL clusters in the destination region.
    * 
    * This parameter is required.
    * 
@@ -19,8 +18,8 @@ export class ConfigureResultExportShrinkRequest extends $dara.Model {
    * @remarks
    * The export type. Valid values:
    * 
-   * *   SLS: Specifies that the export destination is SLS.
-   * *   OSS: Specifies that the export destination is OSS.
+   * - SLS: Exports data to SLS.
+   * - OSS: Exports data to OSS.
    * 
    * @example
    * SLS
@@ -28,12 +27,12 @@ export class ConfigureResultExportShrinkRequest extends $dara.Model {
   exportType?: string;
   /**
    * @remarks
-   * The OSS configuration details if the destination is of the OSS type.
+   * The OSS configuration information when the export destination is OSS.
    */
   ossInfoShrink?: string;
   /**
    * @remarks
-   * The ID of the region where the instance resides.
+   * The region ID.
    * 
    * This parameter is required.
    * 
@@ -43,7 +42,7 @@ export class ConfigureResultExportShrinkRequest extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
-   * The SLS configuration details if the destination is of the SLS type.
+   * The SLS configuration information when the export destination is SLS.
    */
   slsInfoShrink?: string;
   static names(): { [key: string]: string } {

package/src/models/CreateAccountRequest.ts

@@ -5,9 +5,9 @@ import * as $dara from '@darabonba/typescript';
 export class CreateAccountRequest extends $dara.Model {
   /**
    * @remarks
-   * The description of the account.
-   * - Cannot start with `http://` or `https://`.
-   * - Cannot exceed 256 characters in length.
+   * The description of the account. The description must meet the following requirements:
+   * - It cannot start with `http://` or `https://`.
+   * - It can be up to 256 characters in length.
    * 
    * @example
    * Database connection test account
@@ -16,8 +16,8 @@ export class CreateAccountRequest extends $dara.Model {
   /**
    * @remarks
    * The name of the database account. The name must meet the following requirements:
-   * - Starts with a lowercase letter and ends with a lowercase letter or digit.
-   * - Contains only lowercase letters, digits, or underscores (_).
+   * - It must start with a lowercase letter and end with a lowercase letter or a digit.
+   * - It can contain only lowercase letters, digits, and underscores (_).
    * 
    * This parameter is required.
    * 
@@ -27,10 +27,10 @@ export class CreateAccountRequest extends $dara.Model {
   accountName?: string;
   /**
    * @remarks
-   * The password of the database account.
-   * - Must contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters.
+   * The password of the database account. The password must meet the following requirements:
+   * - It must contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters.
    * - Special characters include: `!@#$%^&*()_+-=`
-   * - Must be 8 to 32 characters in length.
+   * - It must be 8 to 32 characters in length.
    * 
    * This parameter is required.
    * 
@@ -65,21 +65,43 @@ export class CreateAccountRequest extends $dara.Model {
    * @remarks
    * The database engine. Valid values:
    * 
-   * - **AnalyticDB** (default): the AnalyticDB for MySQL engine.
-   * - **Clickhouse**: the wide table engine.
+   * - **AnalyticDB** (default): AnalyticDB for MySQL engine.
+   * - **Clickhouse**: wide table engine.
    * 
    * @example
    * Clickhouse
    */
   engine?: string;
+  /**
+   * @remarks
+   * The list of PromQL write permissions.
+   */
   promqlInsertPrivileges?: string[];
+  /**
+   * @remarks
+   * The percentage of PromQL query nodes.
+   * 
+   * @example
+   * 0.6
+   */
   promqlSelectNodePercentage?: number;
+  /**
+   * @remarks
+   * The list of PromQL query permissions.
+   */
   promqlSelectPrivileges?: string[];
   /**
    * @remarks
-   * The list of Alibaba Cloud RAM user IDs to bind. Currently, only one RAM user can be bound.
+   * The IDs of the Alibaba Cloud Resource Access Management (RAM) users to bind. Currently, only one RAM user can be bound.
    */
   ramUserList?: string[];
+  /**
+   * @remarks
+   * The name of the resource group.
+   * 
+   * @example
+   * test_group
+   */
   resourceGroupName?: string;
   static names(): { [key: string]: string } {
     return {

package/src/models/CreateAccountResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class CreateAccountResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The request ID.
+   * The ID of the request.
    * 
    * @example
    * 2FED790E-FB61-4721-8C1C-07C627FA5A19

package/src/models/CreateAccountShrinkRequest.ts

@@ -5,9 +5,9 @@ import * as $dara from '@darabonba/typescript';
 export class CreateAccountShrinkRequest extends $dara.Model {
   /**
    * @remarks
-   * The description of the account.
-   * - Cannot start with `http://` or `https://`.
-   * - Cannot exceed 256 characters in length.
+   * The description of the account. The description must meet the following requirements:
+   * - It cannot start with `http://` or `https://`.
+   * - It can be up to 256 characters in length.
    * 
    * @example
    * Database connection test account
@@ -16,8 +16,8 @@ export class CreateAccountShrinkRequest extends $dara.Model {
   /**
    * @remarks
    * The name of the database account. The name must meet the following requirements:
-   * - Starts with a lowercase letter and ends with a lowercase letter or digit.
-   * - Contains only lowercase letters, digits, or underscores (_).
+   * - It must start with a lowercase letter and end with a lowercase letter or a digit.
+   * - It can contain only lowercase letters, digits, and underscores (_).
    * 
    * This parameter is required.
    * 
@@ -27,10 +27,10 @@ export class CreateAccountShrinkRequest extends $dara.Model {
   accountName?: string;
   /**
    * @remarks
-   * The password of the database account.
-   * - Must contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters.
+   * The password of the database account. The password must meet the following requirements:
+   * - It must contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters.
    * - Special characters include: `!@#$%^&*()_+-=`
-   * - Must be 8 to 32 characters in length.
+   * - It must be 8 to 32 characters in length.
    * 
    * This parameter is required.
    * 
@@ -65,21 +65,43 @@ export class CreateAccountShrinkRequest extends $dara.Model {
    * @remarks
    * The database engine. Valid values:
    * 
-   * - **AnalyticDB** (default): the AnalyticDB for MySQL engine.
-   * - **Clickhouse**: the wide table engine.
+   * - **AnalyticDB** (default): AnalyticDB for MySQL engine.
+   * - **Clickhouse**: wide table engine.
    * 
    * @example
    * Clickhouse
    */
   engine?: string;
+  /**
+   * @remarks
+   * The list of PromQL write permissions.
+   */
   promqlInsertPrivilegesShrink?: string;
+  /**
+   * @remarks
+   * The percentage of PromQL query nodes.
+   * 
+   * @example
+   * 0.6
+   */
   promqlSelectNodePercentage?: number;
+  /**
+   * @remarks
+   * The list of PromQL query permissions.
+   */
   promqlSelectPrivilegesShrink?: string;
   /**
    * @remarks
-   * The list of Alibaba Cloud RAM user IDs to bind. Currently, only one RAM user can be bound.
+   * The IDs of the Alibaba Cloud Resource Access Management (RAM) users to bind. Currently, only one RAM user can be bound.
    */
   ramUserListShrink?: string;
+  /**
+   * @remarks
+   * The name of the resource group.
+   * 
+   * @example
+   * test_group
+   */
   resourceGroupName?: string;
   static names(): { [key: string]: string } {
     return {

package/src/models/CreateApsCopyWorkloadResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class CreateApsCopyWorkloadResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The API status or POP error code.
+   * The API status code or POP error code.
    * 
    * @example
    * InvalidInput
@@ -29,9 +29,9 @@ export class CreateApsCopyWorkloadResponseBody extends $dara.Model {
   httpStatusCode?: number;
   /**
    * @remarks
-   * The additional information about the result. Valid values:
-   * - If the request was successful, Success is returned.
-   * - If the request failed, a specific error code is returned.
+   * The additional information about the call result. Valid values:
+   * - If the request is normal, Success is returned.
+   * - If the request is abnormal, a specific error code is returned.
    * 
    * @example
    * Success