@alicloud/alidns20150109 4.4.0 → 4.5.0

package/src/models/UpdateCloudGtmInstanceConfigEnableStatusResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class UpdateCloudGtmInstanceConfigEnableStatusResponseBody extends $dara.Model {
   /**
    * @remarks
-   * Unique request identification code.
+   * The unique ID of the request.
    * 
    * @example
    * 29D0F8F8-5499-4F6C-9FDC-1EE13BF55925
@@ -13,9 +13,11 @@ export class UpdateCloudGtmInstanceConfigEnableStatusResponseBody extends $dara.
   requestId?: string;
   /**
    * @remarks
-   * Indicates whether the operation was successful: 
-   * - **true**: The call succeeded. 
-   * - **false**: The call failed.
+   * Indicates whether the operation is successful. Valid values:
+   * 
+   * - **true**: The operation is successful.
+   * 
+   * - **false**: The operation failed.
    * 
    * @example
    * true

package/src/models/UpdateCloudGtmInstanceConfigLbStrategyRequest.ts

@@ -5,10 +5,11 @@ import * as $dara from '@darabonba/typescript';
 export class UpdateCloudGtmInstanceConfigLbStrategyRequest extends $dara.Model {
   /**
    * @remarks
-   * The language in which the returned results are displayed. Valid values:
+   * The language of the response. Valid values:
    * 
-   * *   **zh-CN**: Chinese
-   * *   **en-US** (default): English
+   * - **zh-CN**: Chinese.
+   * 
+   * - **en-US**: English. This is the default value.
    * 
    * @example
    * en-US
@@ -16,12 +17,15 @@ export class UpdateCloudGtmInstanceConfigLbStrategyRequest extends $dara.Model {
   acceptLanguage?: string;
   /**
    * @remarks
-   * The new policy for load balancing between address pools. Valid values:
+   * The load balancing policy for the address pools. Valid values:
+   * 
+   * - round_robin: Returns all address pools for any DNS request. The address pools are rotated for each request.
+   * 
+   * - sequence: Returns the address pool with the smallest ordinal number. The smaller the ordinal number, the higher the priority. If the primary address pool is unavailable, the next address pool in the sequence is used.
    * 
-   * *   round_robin: All address pools are returned for Domain Name System (DNS) requests from any source. All address pools are sorted in round-robin mode each time they are returned.
-   * *   sequence: The address pool with the smallest sequence number is preferentially returned for DNS requests from any source. The sequence number indicates the priority for returning the address pool. A smaller sequence number indicates a higher priority. If the address pool with the smallest sequence number is unavailable, the address pool with the second smallest sequence number is returned.
-   * *   weight: You can set a different weight value for each address pool. This way, address pools are returned based on the weight values.
-   * *   source_nearest: GTM returns different address pools based on the sources of DNS requests. This way, users can access nearby address pools.
+   * - weight: Distributes DNS requests to address pools based on their configured weights.
+   * 
+   * - source_nearest: Returns an address pool based on the proximity of the DNS request source. This implements intelligent DNS resolution and directs users to the nearest access point.
    * 
    * @example
    * sequence
@@ -29,36 +33,37 @@ export class UpdateCloudGtmInstanceConfigLbStrategyRequest extends $dara.Model {
   addressPoolLbStrategy?: string;
   /**
    * @remarks
-   * The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.
+   * A client-generated token that is used to ensure the idempotence of the request. The token must be unique among different requests. The token can contain a maximum of 64 ASCII characters.
    * 
    * @example
-   * 1ae05db4-10e7-11ef-b126-00163e24**22
+   * 1ae05db4-10e7-11ef-b126-00163e24****
    */
   clientToken?: string;
   /**
    * @remarks
-   * The configuration ID of the access domain name. Two configuration IDs exist when the access domain name is bound to the same GTM instance but an A record and an AAAA record are configured for the access domain name. The configuration ID uniquely identifies a configuration.
+   * The ID of the instance configuration. A GTM instance can have multiple configurations for the same domain name, such as one for A records and another for AAAA records. The ConfigId uniquely identifies the configuration that you want to modify.
    * 
-   * You can call the [ListCloudGtmInstanceConfigs](~~ListCloudGtmInstanceConfigs~~) operation to query the configuration ID of the desired access domain name.
+   * For more information, see [ListCloudGtmInstanceConfigs](https://help.aliyun.com/document_detail/2797349.html).
    * 
    * @example
-   * Config-000**11
+   * Config-000****
    */
   configId?: string;
   /**
    * @remarks
-   * The ID of the GTM 3.0 instance for which you want to modify the load balancing policy.
+   * The ID of the Global Traffic Manager (GTM) 3.0 instance.
    * 
    * @example
-   * gtm-cn-wwo3a3hbz**
+   * gtm-cn-wwo3a3h***
    */
   instanceId?: string;
   /**
    * @remarks
-   * The mode used if the address pool with the smallest sequence number is recovered. This parameter is required when AddressPoolLbStrategy is set to sequence. Valid values:
+   * The recovery mode for a primary address pool when the load balancing policy is set to sequence. Valid values:
+   * 
+   * - preemptive: The system switches back to the primary address pool as soon as it recovers.
    * 
-   * *   preemptive: The address pool with the smallest sequence number is preferentially used if this address pool is recovered.
-   * *   non_preemptive: The current address pool is still used even if the address pool with the smallest sequence number is recovered.
+   * - non_preemptive: The system continues to use the current address pool even after the primary address pool recovers.
    * 
    * @example
    * preemptive

package/src/models/UpdateCloudGtmInstanceConfigLbStrategyResponseBody.ts

@@ -4,11 +4,21 @@ import * as $dara from '@darabonba/typescript';
 
 export class UpdateCloudGtmInstanceConfigLbStrategyResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The unique identifier for the request.
+   * 
    * @example
    * 0F32959D-417B-4D66-8463-68606605E3E2
    */
   requestId?: string;
   /**
+   * @remarks
+   * Indicates whether the operation was successful. Valid values:
+   * 
+   * - **true**: The operation was successful.
+   * 
+   * - **false**: The operation failed.
+   * 
    * @example
    * true
    */

package/src/models/UpdateCloudGtmInstanceConfigRemarkRequest.ts

@@ -5,10 +5,11 @@ import * as $dara from '@darabonba/typescript';
 export class UpdateCloudGtmInstanceConfigRemarkRequest extends $dara.Model {
   /**
    * @remarks
-   * The language in which the returned results are displayed. Valid values:
+   * The language of the response. Valid values:
    * 
-   * *   **zh-CN**: Chinese
-   * *   **en-US** (default): English
+   * - **zh-CN**: Chinese.
+   * 
+   * - **en-US** (default): English.
    * 
    * @example
    * en-US
@@ -16,31 +17,34 @@ export class UpdateCloudGtmInstanceConfigRemarkRequest extends $dara.Model {
   acceptLanguage?: string;
   /**
    * @remarks
-   * The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.
+   * The client token that is used to ensure the idempotence of the request. Generate a unique token for each request. The token can contain a maximum of 64 ASCII characters.
    * 
    * @example
-   * 1ae05db4-10e7-11ef-b126-00163e24**22
+   * 1ae05db4-10e7-11ef-b126-00163e24****
    */
   clientToken?: string;
   /**
    * @remarks
-   * The configuration ID of the access domain name. Two configuration IDs exist when the access domain name is bound to the same GTM instance but an A record and an AAAA record are configured for the access domain name. The configuration ID uniquely identifies a configuration.
+   * The ID of the instance configuration. A GTM instance can have multiple configurations if you add both an A record and an AAAA record for the same domain name. The ConfigId uniquely identifies the configuration that you want to update.
    * 
-   * You can call the [ListCloudGtmInstanceConfigs](~~ListCloudGtmInstanceConfigs~~) operation to query the configuration ID of the access domain name.
+   * For more information, see [ListCloudGtmInstanceConfigs](https://help.aliyun.com/document_detail/2797349.html).
    * 
    * @example
-   * Config-000**11
+   * Config-000****
    */
   configId?: string;
   /**
    * @remarks
-   * The ID of the GTM 3.0 instance for which you want to modify the description.
+   * The ID of the Global Traffic Manager (GTM) instance for which you want to update the remarks.
    * 
    * @example
-   * gtm-cn-wwo3a3hbz**
+   * gtm-cn-wwo3a3h****
    */
   instanceId?: string;
   /**
+   * @remarks
+   * The new remarks for the configuration.
+   * 
    * @example
    * API
    */

package/src/models/UpdateCloudGtmInstanceConfigRemarkResponseBody.ts

@@ -4,11 +4,21 @@ import * as $dara from '@darabonba/typescript';
 
 export class UpdateCloudGtmInstanceConfigRemarkResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The unique request ID.
+   * 
    * @example
    * B57C121B-A45F-44D8-A9B2-13E5A5044195
    */
   requestId?: string;
   /**
+   * @remarks
+   * Indicates whether the operation was successful.
+   * 
+   * - **true**: The operation was successful.
+   * 
+   * - **false**: The operation failed.
+   * 
    * @example
    * true
    */

package/src/models/UpdateCloudGtmInstanceNameRequest.ts

@@ -7,8 +7,9 @@ export class UpdateCloudGtmInstanceNameRequest extends $dara.Model {
    * @remarks
    * The language of the response. Valid values:
    * 
-   * *   zh-CN: Chinese
-   * *   en-US: English
+   * - zh-CN: Chinese
+   * 
+   * - en-US: English
    * 
    * @example
    * en-US
@@ -16,7 +17,7 @@ export class UpdateCloudGtmInstanceNameRequest extends $dara.Model {
   acceptLanguage?: string;
   /**
    * @remarks
-   * The client token that is used to ensure the idempotence of the request. You can specify a custom value for this parameter, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.
+   * A client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must ensure that the value is unique among different requests. The token can contain a maximum of 64 ASCII characters.
    * 
    * @example
    * 1ae05db4-10e7-11ef-b126-00163e24**22
@@ -32,7 +33,7 @@ export class UpdateCloudGtmInstanceNameRequest extends $dara.Model {
   instanceId?: string;
   /**
    * @remarks
-   * The name of the instance. You cannot leave this parameter empty.
+   * The name of the instance. The value cannot be empty.
    * 
    * @example
    * test

package/src/models/UpdateCloudGtmInstanceNameResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class UpdateCloudGtmInstanceNameResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The request ID.
+   * The unique ID of the request.
    * 
    * @example
    * 29D0F8F8-5499-4F6C-9FDC-1EE13BF55925
@@ -13,10 +13,11 @@ export class UpdateCloudGtmInstanceNameResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * Indicates whether the request was successful. Valid values:
+   * Indicates whether the operation was successful. Valid values:
    * 
-   * *   true
-   * *   false
+   * - true: The operation was successful.
+   * 
+   * - false: The operation failed.
    * 
    * @example
    * true

package/src/models/UpdateCloudGtmMonitorTemplateRemarkRequest.ts

@@ -7,8 +7,9 @@ export class UpdateCloudGtmMonitorTemplateRemarkRequest extends $dara.Model {
    * @remarks
    * The language of the response. Valid values:
    * 
-   * *   zh-CN: Chinese
-   * *   en-US: English
+   * - zh-CN: Chinese
+   * 
+   * - en-US: English
    * 
    * @example
    * en-US
@@ -16,7 +17,7 @@ export class UpdateCloudGtmMonitorTemplateRemarkRequest extends $dara.Model {
   acceptLanguage?: string;
   /**
    * @remarks
-   * The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.
+   * The client token that is used to ensure the idempotence of the request. Generate a unique token for each request. The token can contain a maximum of 64 ASCII characters.
    * 
    * @example
    * 1ae05db4-10e7-11ef-b126-00163e24**22
@@ -24,7 +25,7 @@ export class UpdateCloudGtmMonitorTemplateRemarkRequest extends $dara.Model {
   clientToken?: string;
   /**
    * @remarks
-   * The new description of the template. If you do not specify this parameter, the original description is deleted.
+   * The updated remarks. To delete the remarks, leave this parameter empty.
    * 
    * @example
    * test
@@ -32,7 +33,7 @@ export class UpdateCloudGtmMonitorTemplateRemarkRequest extends $dara.Model {
   remark?: string;
   /**
    * @remarks
-   * The ID of the health check template. This ID uniquely identifies a health check template.
+   * The unique ID of the health check template.
    * 
    * This parameter is required.
    * 

package/src/models/UpdateCloudGtmMonitorTemplateRemarkResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class UpdateCloudGtmMonitorTemplateRemarkResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The request ID.
+   * The unique ID of the request.
    * 
    * @example
    * 6856BCF6-11D6-4D7E-AC53-FD579933522B
@@ -13,9 +13,11 @@ export class UpdateCloudGtmMonitorTemplateRemarkResponseBody extends $dara.Model
   requestId?: string;
   /**
    * @remarks
-   * Modify the health check template remark operation status:
-   * - true: Operation successful
-   * - false: Operation failed
+   * Indicates whether the operation was successful. Valid values:
+   * 
+   * - true: The operation was successful.
+   * 
+   * - false: The operation failed.
    * 
    * @example
    * true

package/src/models/UpdateCloudGtmMonitorTemplateRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class UpdateCloudGtmMonitorTemplateRequestIspCityNodes extends $dara.Model {
   /**
    * @remarks
-   * The city code of the health check node.
+   * The city code of the detection point.
    * 
    * @example
    * 503
@@ -13,7 +13,7 @@ export class UpdateCloudGtmMonitorTemplateRequestIspCityNodes extends $dara.Mode
   cityCode?: string;
   /**
    * @remarks
-   * The Internet service provider (ISP) code of the health check node.
+   * The carrier code of the detection point.
    * 
    * @example
    * 465
@@ -47,8 +47,9 @@ export class UpdateCloudGtmMonitorTemplateRequest extends $dara.Model {
    * @remarks
    * The language of the response. Valid values:
    * 
-   * *   zh-CN: Chinese
-   * *   en-US (default): English
+   * - zh-CN: Chinese
+   * 
+   * - en-US (default): English
    * 
    * @example
    * en-US
@@ -56,17 +57,20 @@ export class UpdateCloudGtmMonitorTemplateRequest extends $dara.Model {
   acceptLanguage?: string;
   /**
    * @remarks
-   * The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.
+   * A client-generated token that is used to ensure the idempotence of the request. Make sure that the token is unique for each request. The token can be up to 64 ASCII characters in length.
    * 
    * @example
-   * 1ae05db4-10e7-11ef-b126-00163e24**22
+   * 1ae05db4-10e7-11ef-b126-00163e24****
    */
   clientToken?: string;
   /**
    * @remarks
-   * The number of retries. The system will only judge the application service as abnormal after consecutive monitoring failures to prevent inaccurate monitoring results due to momentary network fluctuations or other reasons. Available retry options are:
-   * - 1 
-   * - 2 
+   * The number of consecutive health check failures that must occur before an application service is considered abnormal. This helps prevent false alarms caused by transient issues such as network jitter. Valid values:
+   * 
+   * - 1
+   * 
+   * - 2
+   * 
    * - 3
    * 
    * @example
@@ -75,34 +79,37 @@ export class UpdateCloudGtmMonitorTemplateRequest extends $dara.Model {
   evaluationCount?: number;
   /**
    * @remarks
-   * The extended information. The value of this parameter is a JSON string. The required parameters vary based on the health check protocol.
+   * The extended information in a JSON string. The parameters vary based on the health check protocol.
    * 
-   * *   HTTP or HTTPS:
+   * - HTTP and HTTPS:
    * 
-   *     host: the Host field of an HTTP or HTTPS request header during an HTTP or HTTPS health check. The parameter value indicates the HTTP website that you want to visit. By default, the value is the primary domain name. You can change the value based on your business requirements.
+   *   host: When you perform an HTTP or HTTPS health check, this parameter specifies the Host field in the HTTP request header. It identifies the target website. The default value is the primary domain name. If the target website has specific requirements for the Host field, modify this parameter as needed.
    * 
-   *     path: the URL for HTTP or HTTPS health checks. Default value: /.
+   *   path: The path for the HTTP or HTTPS health check. The default value is /.
    * 
-   *     code: the alert threshold. During an HTTP or HTTPS health check, the system checks whether a web server functions as expected based on the status code that is returned from the web server. If the returned status code is greater than the specified threshold, the corresponding application service address is deemed abnormal. Valid values:
+   *   code: When you perform an HTTP or HTTPS health check, the system uses the return code from the web server to determine its status. If the return code exceeds the specified threshold, the application service is considered abnormal.
    * 
-   *     *   400: specifies an invalid request. If an HTTP or HTTPS request contains invalid request parameters, a web server returns a status code that is greater than 400. You must set path to an exact URL if you set code to 400.
-   *     *   500: specifies a server error. If some exceptions occur on a web server, the web server returns a status code that is greater than 500. This value is used by default.
+   *   - 400: Bad Request. If an HTTP or HTTPS request contains invalid parameters, the web server returns a code greater than 400. If you set the threshold to 400, make sure that you specify the exact URL path.
    * 
-   *     sni: specifies whether to enable Server Name Indication (SNI). This parameter is used only when the health check protocol is HTTPS. SNI is an extension to the Transport Layer Security (TLS) protocol, which allows a client to specify the host to be connected when the client sends a TLS handshake request. TLS handshakes occur before any data of HTTP requests is sent. Therefore, SNI enables servers to identify the services that clients are attempting to access before certificates are sent. This allows the servers to present correct certificates to the clients. Valid values:
+   *   - 500: Server Error. If the web server encounters an error, it returns a code greater than 500. The default threshold is 500.
    * 
-   *     *   true: enables SNI.
-   *     *   false: disables SNI.
+   *   sni: Specifies whether to enable Server Name Indication (SNI). This parameter is used only for HTTPS health checks. SNI is an extension to the Transport Layer Security (TLS) protocol. It allows a client to specify the hostname it is trying to connect to at the start of the TLS handshake. Because the TLS handshake occurs before any HTTP data is sent, SNI allows the server to know which service the client is trying to access before sending the certificate. This enables the server to present the correct certificate to the client.
    * 
-   *     followRedirect: specifies whether to follow 3XX redirects. Valid values:
+   *   - true: Enable SNI.
    * 
-   *     *   true: follows 3XX redirects. You are redirected to the destination address if a 3XX status code such as 301, 302, 303, 307, or 308 is returned.
-   *     *   false: does not follow 3XX redirects.
+   *   - false: Disable SNI.
    * 
-   * *   ping:
+   *   followRedirect: Specifies whether to follow 3xx redirections.
    * 
-   *     packetNum: the total number of Internet Control Message Protocol (ICMP) packets that are sent to the address for each ping-based health check. Valid values: 20, 50, and 100.
+   *   - true: Follow the redirection if the detection point receives a 3xx status code (301, 302, 303, 307, or 308).
    * 
-   *     packetLossRate: the ICMP packet loss rate for each ping-based health check. The packet loss rate in a health check can be calculated by using the following formula: Packet loss rate in a health check = (Number of lost packets/Total number of sent ICMP packets) × 100%. If the packet loss rate reaches the threshold, an alert is triggered. Valid values: 10, 30, 40, 80, 90, and 100.
+   *   - false: Do not follow the redirection.
+   * 
+   * - Ping:
+   * 
+   *   packetNum: The number of ICMP packets to send for each ping health check. Valid values: 20, 50, and 100.
+   * 
+   *   packetLossRate: The packet loss rate that triggers an alarm. For each ping health check, the system calculates the packet loss rate. Packet loss rate = (Number of lost packets / Total number of sent ICMP packets) × 100%. An alarm is triggered if the packet loss rate reaches this threshold. Valid values: 10, 30, 40, 80, 90, and 100.
    * 
    * @example
    * {\\"code\\":200,\\"path\\":\\"\\\\index.htm\\",\\"host\\":\\"aliyun.com\\"}
@@ -110,10 +117,14 @@ export class UpdateCloudGtmMonitorTemplateRequest extends $dara.Model {
   extendInfo?: string;
   /**
    * @remarks
-   * Percentage of selected node probe failures (%), that is, the percentage of abnormal detection points among the total detection points. When the failure ratio exceeds the set threshold, the service address is judged as abnormal. The available failure ratio thresholds are:
+   * The percentage of failed detection points. An endpoint is considered abnormal if the percentage of detection points that fail the health check exceeds this threshold. Valid values:
+   * 
    * - 20
+   * 
    * - 50
+   * 
    * - 80
+   * 
    * - 100
    * 
    * @example
@@ -122,7 +133,7 @@ export class UpdateCloudGtmMonitorTemplateRequest extends $dara.Model {
   failureRate?: number;
   /**
    * @remarks
-   * The time interval (in seconds) for each health check probe. By default, it probes every 60 seconds. The minimum supported interval for health checks is 15 seconds, available for flagship edition instances.
+   * The interval between health checks in seconds. The default value is 60. The minimum interval is 15 seconds. This feature is available only for Ultimate Edition instances.
    * 
    * @example
    * 60
@@ -130,12 +141,12 @@ export class UpdateCloudGtmMonitorTemplateRequest extends $dara.Model {
   interval?: number;
   /**
    * @remarks
-   * The health check nodes. You can call the [ListCloudGtmMonitorNodes](https://help.aliyun.com/document_detail/2797327.html) operation to obtain the health check nodes.
+   * The list of detection points. Call [ListCloudGtmMonitorNodes](https://help.aliyun.com/document_detail/2797327.html) to obtain the information.
    */
   ispCityNodes?: UpdateCloudGtmMonitorTemplateRequestIspCityNodes[];
   /**
    * @remarks
-   * The name of the health check probe template, which is generally recommended to be distinguishable and memorable for configuration personnel, ideally indicating the health check protocol for easier identification.
+   * The name of the health check template. For easy identification, name the template based on its health check protocol.
    * 
    * @example
    * Ping-IPv4
@@ -143,20 +154,24 @@ export class UpdateCloudGtmMonitorTemplateRequest extends $dara.Model {
   name?: string;
   /**
    * @remarks
-   * The ID of the health check template that you want to modify. This ID uniquely identifies the health check template.
+   * The unique ID of the health check template that you want to modify.
    * 
    * This parameter is required.
    * 
    * @example
-   * mtp-89518052425100**80
+   * mtp-89518052425100****
    */
   templateId?: string;
   /**
    * @remarks
-   * Probe timeout (in milliseconds), data packets not returned within the timeout period are considered as health check timeouts:
+   * The timeout period for a health check in milliseconds. If a packet is not returned within the specified timeout period, the health check fails. Valid values:
+   * 
    * - 2000
+   * 
    * - 3000
+   * 
    * - 5000
+   * 
    * - 10000
    * 
    * @example

package/src/models/UpdateCloudGtmMonitorTemplateResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class UpdateCloudGtmMonitorTemplateResponseBody extends $dara.Model {
   /**
    * @remarks
-   * Unique request identification code.
+   * The request ID.
    * 
    * @example
    * 6856BCF6-11D6-4D7E-AC53-FD579933522B
@@ -13,9 +13,11 @@ export class UpdateCloudGtmMonitorTemplateResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * Modify the health check template operation status:
-   * - true: Operation successful
-   * - false: Operation failed
+   * Indicates whether the operation was successful.
+   * 
+   * - true: The operation was successful.
+   * 
+   * - false: The operation failed.
    * 
    * @example
    * true