@alicloud/esa20240910 3.2.0 → 3.4.0

package/src/models/CreateRecordShrinkRequest.ts

@@ -5,16 +5,15 @@ import * as $dara from '@darabonba/typescript';
 export class CreateRecordShrinkRequest extends $dara.Model {
   /**
    * @remarks
-   * The origin authentication information of the CNAME record.
+   * The origin authentication information for the CNAME record.
    */
   authConfShrink?: string;
   /**
    * @remarks
-   * The business scenario of the record for acceleration. Leave the parameter empty if your record is not proxied. Valid values:
-   * 
-   * *   **image_video**: video and image.
-   * *   **api**: API.
-   * *   **web**: web page.
+   * Used to tag the business scenario of the DNS record. This parameter is required when proxy acceleration is enabled for the DNS record (i.e., when the proxied parameter is set to true), and is not required when proxy acceleration is disabled (i.e., when the proxied parameter is set to false). Valid values:
+   * - **image_video**: Image and video.
+   * - **api**: API.
+   * - **web**: Web page.
    * 
    * @example
    * web
@@ -22,7 +21,7 @@ export class CreateRecordShrinkRequest extends $dara.Model {
   bizName?: string;
   /**
    * @remarks
-   * The comment of the record. The maximum length is 100 characters.
+   * The comment for the record, with a maximum length of 100 characters.
    * 
    * @example
    * This is a remark.
@@ -30,7 +29,9 @@ export class CreateRecordShrinkRequest extends $dara.Model {
   comment?: string;
   /**
    * @remarks
-   * The DNS record information. The format of this field varies based on the record type. For more information, see [References](https://www.alibabacloud.com/help/doc-detail/2708761.html) .
+   * The DNS information of the record. Different types of records require different content for this field. For more information, see
+   * <props="china">[Documentation](https://help.aliyun.com/document_detail/2708761.html)<props="intl">[Documentation](https://www.alibabacloud.com/help/doc-detail/2708761.html)
+   * .
    * 
    * This parameter is required.
    * 
@@ -42,10 +43,10 @@ export class CreateRecordShrinkRequest extends $dara.Model {
   dataShrink?: string;
   /**
    * @remarks
-   * The origin host policy. This policy takes effect when the record type is CNAME. You can set the policy in two modes:
+   * The origin host policy. This takes effect when the record type is CNAME. It specifies the host policy for back-to-origin requests. Two modes are available:
    * 
-   * *   follow_hostname: Follow the host record.
-   * *   follow_origin_domain: match the origin\\"s domain name.
+   * - **follow_hostname**: Follow the request host.
+   * - **follow_origin_domain**: Follow the origin domain.
    * 
    * @example
    * follow_origin_domain
@@ -55,10 +56,9 @@ export class CreateRecordShrinkRequest extends $dara.Model {
   httpsPorts?: string;
   /**
    * @remarks
-   * Specifies whether to proxy the record. Only CNAME and A/AAAA records can be proxied. Valid values:
-   * 
-   * *   **true**
-   * *   **false**
+   * Specifies whether to enable proxy acceleration for the record. Only CNAME records or A/AAAA records (i.e., when the type parameter is set to A/AAAA or CNAME) can enable proxy acceleration. Valid values:
+   * - **true**: Enable proxy acceleration.
+   * - **false**: Disable proxy acceleration.
    * 
    * @example
    * true
@@ -76,7 +76,7 @@ export class CreateRecordShrinkRequest extends $dara.Model {
   recordName?: string;
   /**
    * @remarks
-   * The website ID, which can be obtained by calling the [ListSites](https://help.aliyun.com/document_detail/2850189.html) operation.
+   * The site ID, which can be obtained by calling the [ListSites](https://help.aliyun.com/document_detail/2850189.html) API.
    * 
    * This parameter is required.
    * 
@@ -86,15 +86,15 @@ export class CreateRecordShrinkRequest extends $dara.Model {
   siteId?: number;
   /**
    * @remarks
-   * The origin type for the CNAME record. This parameter is required when you add a CNAME record. Valid values:
+   * The origin type of the CNAME record. This parameter is required when adding a CNAME record (i.e., when the type parameter is set to CNAME). Valid values:
    * 
-   * *   **OSS**: OSS bucket.
-   * *   **S3**: S3 bucket.
-   * *   **LB**: load balancer.
-   * *   **OP**: origin pool.
-   * *   **Domain**: domain name.
+   * - **OSS**: OSS origin.
+   * - **S3**: S3 origin.
+   * - **LB**: Load balancer origin.
+   * - **OP**: Origin pool origin.
+   * - **Domain**: Standard domain origin.
    * 
-   * If you do not pass this parameter or if you leave its value empty, Domain is used by default.
+   * If this parameter is not specified or is left empty, it defaults to Domain, which is the standard domain origin type.
    * 
    * @example
    * OSS
@@ -102,7 +102,7 @@ export class CreateRecordShrinkRequest extends $dara.Model {
   sourceType?: string;
   /**
    * @remarks
-   * The TTL of the record. Unit: seconds. If the value is 1, the TTL of the record is determined by the system.
+   * The time-to-live (TTL) of the record, in seconds. When set to 1, the TTL is automatic.
    * 
    * This parameter is required.
    * 
@@ -112,7 +112,7 @@ export class CreateRecordShrinkRequest extends $dara.Model {
   ttl?: number;
   /**
    * @remarks
-   * The type of the DNS record. For example, A/AAAA, TXT, MX, or CNAME.
+   * The DNS type of the record, such as **A/AAAA**, **CNAME**, **TXT**, etc.
    * 
    * This parameter is required.
    * 

package/src/models/CreateRedirectRuleRequest.ts

@@ -5,11 +5,10 @@ import * as $dara from '@darabonba/typescript';
 export class CreateRedirectRuleRequest extends $dara.Model {
   /**
    * @remarks
-   * Specifies whether to preserve the query string from the original request. Valid values:
+   * Specifies whether to preserve the query string. Valid values:
    * 
-   * - `on`: Preserves the query string.
-   * 
-   * - `off`: Discards the query string.
+   * - on: Enabled.
+   * - off: Disabled.
    * 
    * This parameter is required.
    * 
@@ -19,11 +18,9 @@ export class CreateRedirectRuleRequest extends $dara.Model {
   reserveQueryString?: string;
   /**
    * @remarks
-   * The rule content, which is a conditional expression used to match user requests. Do not set this parameter when adding a global configuration. The following use cases are supported:
-   * 
-   * - To match all incoming requests, set the value to `true`.
-   * 
-   * - To match specific requests, set the value to a custom expression, such as `(http.host eq "video.example.com")`.
+   * The rule content, which uses a conditional expression to match user requests. You do not need to set this parameter when adding a global configuration. Two scenarios are supported:
+   * - Match all incoming requests: Set the value to true.
+   * - Match specified requests: Set the value to a custom expression, such as (http.host eq \\"video.example.com\\").
    * 
    * @example
    * (http.host eq "video.example.com")
@@ -31,11 +28,9 @@ export class CreateRedirectRuleRequest extends $dara.Model {
   rule?: string;
   /**
    * @remarks
-   * Specifies whether to enable the rule. Do not set this parameter when adding a global configuration. Valid values:
-   * 
-   * - `on`: The rule is enabled.
-   * 
-   * - `off`: The rule is disabled.
+   * The rule switch. You do not need to set this parameter when adding a global configuration. Valid values:
+   * - on: Enabled.
+   * - off: Disabled.
    * 
    * @example
    * on
@@ -43,7 +38,7 @@ export class CreateRedirectRuleRequest extends $dara.Model {
   ruleEnable?: string;
   /**
    * @remarks
-   * The rule name. Do not set this parameter when adding a global configuration.
+   * The rule name. You do not need to set this parameter when adding a global configuration.
    * 
    * @example
    * rule_example
@@ -51,7 +46,7 @@ export class CreateRedirectRuleRequest extends $dara.Model {
   ruleName?: string;
   /**
    * @remarks
-   * The execution priority of the rule. A smaller value indicates a higher priority.
+   * The rule execution order. A smaller value indicates a higher priority.
    * 
    * @example
    * 1
@@ -59,7 +54,7 @@ export class CreateRedirectRuleRequest extends $dara.Model {
   sequence?: number;
   /**
    * @remarks
-   * The site ID. To get this value, call the [ListSites](https://help.aliyun.com/document_detail/2850189.html) operation.
+   * The site ID, which can be obtained by calling the [ListSites](https://help.aliyun.com/document_detail/2850189.html) operation.
    * 
    * This parameter is required.
    * 
@@ -69,7 +64,7 @@ export class CreateRedirectRuleRequest extends $dara.Model {
   siteId?: number;
   /**
    * @remarks
-   * For sites with configuration version management enabled, specify the version to which this configuration applies.
+   * The version number of the site configuration. For sites with configuration version management enabled, you can use this parameter to specify the site version on which the configuration takes effect. The default value is version 0.
    * 
    * @example
    * 0
@@ -77,17 +72,13 @@ export class CreateRedirectRuleRequest extends $dara.Model {
   siteVersion?: number;
   /**
    * @remarks
-   * The status code that the edge node returns to the client for the redirect. Valid values:
+   * The response status code used by the node when responding to the client with the redirect address. Valid values:
    * 
    * - 301
-   * 
    * - 302
-   * 
    * - 303
-   * 
    * - 307
-   * 
-   * - 308
+   * - 308.
    * 
    * This parameter is required.
    * 
@@ -97,7 +88,7 @@ export class CreateRedirectRuleRequest extends $dara.Model {
   statusCode?: string;
   /**
    * @remarks
-   * The target URL for the redirect.
+   * The target URL after redirection.
    * 
    * This parameter is required.
    * 
@@ -109,9 +100,8 @@ export class CreateRedirectRuleRequest extends $dara.Model {
    * @remarks
    * The redirect type. Valid values:
    * 
-   * - `static`: Static mode.
-   * 
-   * - `dynamic`: Dynamic mode.
+   * - static: Static pattern.
+   * - dynamic: Dynamic pattern.
    * 
    * This parameter is required.
    * 

package/src/models/CreateRedirectRuleResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class CreateRedirectRuleResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The config ID.
+   * The configuration ID.
    * 
    * @example
    * 35281609698****

package/src/models/CreateRewriteUrlRuleRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class CreateRewriteUrlRuleRequest extends $dara.Model {
   /**
    * @remarks
-   * The query string after the rewrite.
+   * The query string after rewriting.
    * 
    * @example
    * example=123
@@ -13,11 +13,10 @@ export class CreateRewriteUrlRuleRequest extends $dara.Model {
   queryString?: string;
   /**
    * @remarks
-   * The query string rewrite mode. Valid values:
+   * The query string rewrite type. Valid values:
    * 
-   * - `static`: Static mode.
-   * 
-   * - `dynamic`: Dynamic mode.
+   * - static: static mode.
+   * - dynamic: dynamic mode.
    * 
    * @example
    * static
@@ -28,11 +27,10 @@ export class CreateRewriteUrlRuleRequest extends $dara.Model {
   rewriteQueryStringType?: string;
   /**
    * @remarks
-   * The URI rewrite mode. Valid values:
-   * 
-   * - `static`: Static mode.
+   * The URI rewrite type. Valid values:
    * 
-   * - `dynamic`: Dynamic mode.
+   * - static: static mode.
+   * - dynamic: dynamic mode.
    * 
    * @example
    * static
@@ -43,11 +41,9 @@ export class CreateRewriteUrlRuleRequest extends $dara.Model {
   rewriteUriType?: string;
   /**
    * @remarks
-   * The conditional expression used to match user requests. This parameter is not required when you add a global configuration. Two use cases are supported:
-   * 
-   * - To match all inbound requests, set the value to `true`.
-   * 
-   * - To match specific requests, set the value to a custom expression, such as `(http.host eq "video.example.com")`.
+   * The rule content, which uses conditional expressions to match user requests. This parameter does not need to be set when adding global configurations. There are two usage scenarios:
+   * - Match all incoming requests: Set the value to true.
+   * - Match specified requests: Set the value to a custom expression, for example: (http.host eq \\"video.example.com\\").
    * 
    * @example
    * (http.host eq "video.example.com")
@@ -55,11 +51,9 @@ export class CreateRewriteUrlRuleRequest extends $dara.Model {
   rule?: string;
   /**
    * @remarks
-   * This parameter is not required when you add a global configuration. Valid values:
-   * 
-   * - `on`: Enables the rule.
-   * 
-   * - `off`: Disables the rule.
+   * The rule switch. This parameter does not need to be set when adding global configurations. Valid values:
+   * - on: enabled.
+   * - off: disabled.
    * 
    * @example
    * on
@@ -67,7 +61,7 @@ export class CreateRewriteUrlRuleRequest extends $dara.Model {
   ruleEnable?: string;
   /**
    * @remarks
-   * The rule name. This parameter is not required when you add a global configuration.
+   * The rule name. This parameter does not need to be set when adding global configurations.
    * 
    * @example
    * rule_example
@@ -75,7 +69,7 @@ export class CreateRewriteUrlRuleRequest extends $dara.Model {
   ruleName?: string;
   /**
    * @remarks
-   * The execution priority of the rule. A lower value indicates a higher priority.
+   * The rule execution order. A smaller value indicates a higher priority.
    * 
    * @example
    * 1
@@ -83,7 +77,7 @@ export class CreateRewriteUrlRuleRequest extends $dara.Model {
   sequence?: number;
   /**
    * @remarks
-   * The site ID. Obtain it by calling the [ListSites](~~ListSites~~) operation.
+   * The site ID, which can be obtained by calling the [ListSites](~~ListSites~~) operation.
    * 
    * This parameter is required.
    * 
@@ -93,7 +87,7 @@ export class CreateRewriteUrlRuleRequest extends $dara.Model {
   siteId?: number;
   /**
    * @remarks
-   * If configuration versioning is enabled for the site, this parameter specifies the target version. The default value is 0.
+   * The version number of the site configuration. For sites with configuration version management enabled, you can use this parameter to specify the site version for which the configuration takes effect. Default value: 0.
    * 
    * @example
    * 0
@@ -101,7 +95,7 @@ export class CreateRewriteUrlRuleRequest extends $dara.Model {
   siteVersion?: number;
   /**
    * @remarks
-   * The target URI after the rewrite.
+   * The destination URI after rewriting.
    * 
    * @example
    * /image/example.jpg

package/src/models/CreateRewriteUrlRuleResponseBody.ts

@@ -13,7 +13,7 @@ export class CreateRewriteUrlRuleResponseBody extends $dara.Model {
   configId?: number;
   /**
    * @remarks
-   * The ID of the request.
+   * The request ID.
    * 
    * @example
    * CB1A380B-09F0-41BB-280B-72F8FD6DA2FE

package/src/models/CreateRoutineCodeDeploymentRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class CreateRoutineCodeDeploymentRequestCodeVersions extends $dara.Model {
   /**
    * @remarks
-   * The version of the code.
+   * The code version number.
    * 
    * This parameter is required.
    * 
@@ -15,7 +15,7 @@ export class CreateRoutineCodeDeploymentRequestCodeVersions extends $dara.Model
   codeVersion?: string;
   /**
    * @remarks
-   * The phased release ratio of the code version. Valid values: 1 to 100.
+   * The canary release percentage for the code version. Valid values: 1 to 100.
    * 
    * This parameter is required.
    * 
@@ -49,14 +49,17 @@ export class CreateRoutineCodeDeploymentRequestCodeVersions extends $dara.Model
 export class CreateRoutineCodeDeploymentRequest extends $dara.Model {
   /**
    * @remarks
-   * The configuration list of phased release version numbers. A maximum of two versions are supported, and the sum of the total proportions is equal to 100.
+   * The list of percentage-based canary release version configurations. A maximum of two versions are supported, and the total percentage must equal 100.
    * 
    * This parameter is required.
    */
   codeVersions?: CreateRoutineCodeDeploymentRequestCodeVersions[];
   /**
    * @remarks
-   * The name of the environment. Only supports test environment `staging` or production environment `production`.
+   * The environment name.  
+   * Valid values:
+   * - `staging`: staging environment 
+   * - `production`: production environment
    * 
    * This parameter is required.
    * 
@@ -66,7 +69,7 @@ export class CreateRoutineCodeDeploymentRequest extends $dara.Model {
   env?: string;
   /**
    * @remarks
-   * The function name.
+   * The name of the Edge Function Routine.
    * 
    * This parameter is required.
    * 
@@ -76,7 +79,9 @@ export class CreateRoutineCodeDeploymentRequest extends $dara.Model {
   name?: string;
   /**
    * @remarks
-   * The deployment policy. Valid value: percentage.
+   * The deployment strategy.  
+   * Valid values:
+   * - `percentage`: percentage mode
    * 
    * This parameter is required.
    * 

package/src/models/CreateRoutineCodeDeploymentResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class CreateRoutineCodeDeploymentResponseBodyCodeVersions extends $dara.Model {
   /**
    * @remarks
-   * The version of the code.
+   * The code version number.
    * 
    * @example
    * 1723599747213377175
@@ -13,7 +13,7 @@ export class CreateRoutineCodeDeploymentResponseBodyCodeVersions extends $dara.M
   codeVersion?: string;
   /**
    * @remarks
-   * The phased release ratio.
+   * The canary release percentage for the code version.
    * 
    * @example
    * 100
@@ -45,7 +45,7 @@ export class CreateRoutineCodeDeploymentResponseBodyCodeVersions extends $dara.M
 export class CreateRoutineCodeDeploymentResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The configuration list of the phased release version number.
+   * The list of percentage-based canary release code version configurations.
    */
   codeVersions?: CreateRoutineCodeDeploymentResponseBodyCodeVersions[];
   /**
@@ -66,7 +66,7 @@ export class CreateRoutineCodeDeploymentResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * The phased release policy. The constant string is "percentage".
+   * The canary release strategy. Fixed value: percentage.
    * 
    * @example
    * percentage

package/src/models/CreateRoutineCodeDeploymentShrinkRequest.ts

@@ -5,14 +5,17 @@ import * as $dara from '@darabonba/typescript';
 export class CreateRoutineCodeDeploymentShrinkRequest extends $dara.Model {
   /**
    * @remarks
-   * The configuration list of phased release version numbers. A maximum of two versions are supported, and the sum of the total proportions is equal to 100.
+   * The list of percentage-based canary release version configurations. A maximum of two versions are supported, and the total percentage must equal 100.
    * 
    * This parameter is required.
    */
   codeVersionsShrink?: string;
   /**
    * @remarks
-   * The name of the environment. Only supports test environment `staging` or production environment `production`.
+   * The environment name.  
+   * Valid values:
+   * - `staging`: staging environment 
+   * - `production`: production environment
    * 
    * This parameter is required.
    * 
@@ -22,7 +25,7 @@ export class CreateRoutineCodeDeploymentShrinkRequest extends $dara.Model {
   env?: string;
   /**
    * @remarks
-   * The function name.
+   * The name of the Edge Function Routine.
    * 
    * This parameter is required.
    * 
@@ -32,7 +35,9 @@ export class CreateRoutineCodeDeploymentShrinkRequest extends $dara.Model {
   name?: string;
   /**
    * @remarks
-   * The deployment policy. Valid value: percentage.
+   * The deployment strategy.  
+   * Valid values:
+   * - `percentage`: percentage mode
    * 
    * This parameter is required.
    * 

package/src/models/CreateRoutineRouteRequest.ts

@@ -6,7 +6,7 @@ export class CreateRoutineRouteRequest extends $dara.Model {
   /**
    * @remarks
    * The bypass mode. Valid values:
-   * - on: enabled.
+   * - on: enabled
    * - off: disabled.
    * 
    * @example
@@ -16,8 +16,8 @@ export class CreateRoutineRouteRequest extends $dara.Model {
   /**
    * @remarks
    * The fallback-to-origin switch. When enabled, if the function encounters an exception such as CPU usage exceeding the limit, the request is forwarded to the origin server. Valid values:
-   * - on: enabled.
-   * - off: disabled.
+   * - on: Enabled.
+   * - off: Disabled.
    * 
    * @example
    * on
@@ -26,9 +26,11 @@ export class CreateRoutineRouteRequest extends $dara.Model {
   /**
    * @remarks
    * The route switch. Valid values:
-   * - on: enabled.
+   * - on: enabled
    * - off: disabled.
    * 
+   * This parameter is required.
+   * 
    * @example
    * on
    */
@@ -37,13 +39,15 @@ export class CreateRoutineRouteRequest extends $dara.Model {
    * @remarks
    * The route name.
    * 
+   * This parameter is required.
+   * 
    * @example
    * test_route
    */
   routeName?: string;
   /**
    * @remarks
-   * The name of the edge function routine.
+   * The Edge Routine name.
    * 
    * This parameter is required.
    * 
@@ -55,13 +59,15 @@ export class CreateRoutineRouteRequest extends $dara.Model {
    * @remarks
    * The rule content.
    * 
+   * This parameter is required.
+   * 
    * @example
    * (http.host eq \\"video.example.com\\")
    */
   rule?: string;
   /**
    * @remarks
-   * The rule execution sequence.
+   * The rule execution order.
    * 
    * @example
    * 1
@@ -69,7 +75,7 @@ export class CreateRoutineRouteRequest extends $dara.Model {
   sequence?: number;
   /**
    * @remarks
-   * The site ID. You can call the [ListSites](https://help.aliyun.com/document_detail/2850189.html) operation to obtain the site ID.
+   * The site ID, which can be obtained by calling the [ListSites](https://help.aliyun.com/document_detail/2850189.html) operation.
    * 
    * This parameter is required.
    * 
@@ -79,7 +85,7 @@ export class CreateRoutineRouteRequest extends $dara.Model {
   siteId?: number;
   /**
    * @remarks
-   * The edge routine timeout period. Valid values: 5 to 60. Unit: seconds.
+   * The Edge Routine timeout period. Valid values: 5 to 60.
    * 
    * @example
    * 5

package/src/models/CreateScheduledPreloadExecutionsRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class CreateScheduledPreloadExecutionsRequestExecutions extends $dara.Model {
   /**
    * @remarks
-   * The end time of the scheduled prefetch plan.
+   * The end time of the scheduled prefetch plan, in ISO 8601 format (such as 2024-01-01T00:00:00+Z).
    * 
    * @example
    * 2024-06-04T02:02:09Z
@@ -13,7 +13,7 @@ export class CreateScheduledPreloadExecutionsRequestExecutions extends $dara.Mod
   endTime?: string;
   /**
    * @remarks
-   * The interval at which batches of a scheduled prefetch plan are executed. Unit: seconds.
+   * The interval between each batch execution of the scheduled prefetch plan. Unit: seconds.
    * 
    * This parameter is required.
    * 
@@ -23,7 +23,7 @@ export class CreateScheduledPreloadExecutionsRequestExecutions extends $dara.Mod
   interval?: number;
   /**
    * @remarks
-   * The number of URLs to prefetch in each batch.
+   * The number of URLs to prefetch per batch.
    * 
    * This parameter is required.
    * 
@@ -33,7 +33,7 @@ export class CreateScheduledPreloadExecutionsRequestExecutions extends $dara.Mod
   sliceLen?: number;
   /**
    * @remarks
-   * The start time of the scheduled prefetch plan.
+   * The start time of the scheduled prefetch plan, in ISO 8601 format (such as 2024-01-01T00:00:00+Z).
    * 
    * @example
    * 2024-06-03T16:00:00Z
@@ -69,14 +69,14 @@ export class CreateScheduledPreloadExecutionsRequestExecutions extends $dara.Mod
 export class CreateScheduledPreloadExecutionsRequest extends $dara.Model {
   /**
    * @remarks
-   * The list of execution plans for scheduled prefetch tasks to be added.
+   * The list of execution plans to be added for scheduled prefetch tasks.
    * 
    * This parameter is required.
    */
   executions?: CreateScheduledPreloadExecutionsRequestExecutions[];
   /**
    * @remarks
-   * The ID of the prefetch task. The ID is generated by calling the [CreateScheduledPreloadJob](https://help.aliyun.com/document_detail/2850459.html) operation.
+   * The prefetch task ID, which is generated by calling the [CreateScheduledPreloadJob](https://help.aliyun.com/document_detail/2850459.html) operation.
    * 
    * @example
    * 665d3af3621bccf3fe29e1a4