@alicloud/cms20190101 4.0.8 → 4.0.10

package/src/models/DescribeSiteMonitorListResponseBody.ts

@@ -3,56 +3,9 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class DescribeSiteMonitorListResponseBodySiteMonitorsSiteMonitorOptionsJsonAssertionsAssertions extends $dara.Model {
-  /**
-   * @remarks
-   * The comparison operator of the assertion. Valid values:
-   * 
-   * *   contains: contains
-   * *   doesNotContain: does not contain
-   * *   matches: matches regular expressions
-   * *   doesNotMatch: does not match regular expressions
-   * *   is: equal to a numeric value or matches a character
-   * *   isNot: not equal to
-   * *   lessThan: less than
-   * *   moreThan: greater than
-   * 
-   * @example
-   * lessThan
-   */
   operator?: string;
-  /**
-   * @remarks
-   * The parsing path of the assertion.
-   * 
-   * *   If the assertion type is `body_json`, the path is `json path`.
-   * *   If the assertion type is `body_xml`, the path is `xml path`.
-   * 
-   * @example
-   * json path
-   */
   property?: string;
-  /**
-   * @remarks
-   * The numeric value or character used for matching.
-   * 
-   * @example
-   * 1000
-   */
   target?: string;
-  /**
-   * @remarks
-   * The assertion type. Valid values:
-   * 
-   * *   response_time: checks whether the response time meets expectations.
-   * *   status_code: checks whether the HTTP status code meets expectations.
-   * *   header: checks whether the fields in the response header meet expectations.
-   * *   body_text: checks whether the content in the response body meets expectations by using text matching.
-   * *   body_json: checks whether the content in the response body meets expectations by using JSON parsing (JSONPath).
-   * *   body_xml: checks whether the content in the response body meets expectations by using XML parsing (XPath).
-   * 
-   * @example
-   * response_time
-   */
   type?: string;
   static names(): { [key: string]: string } {
     return {
@@ -108,302 +61,35 @@ export class DescribeSiteMonitorListResponseBodySiteMonitorsSiteMonitorOptionsJs
 }
 
 export class DescribeSiteMonitorListResponseBodySiteMonitorsSiteMonitorOptionsJson extends $dara.Model {
-  /**
-   * @remarks
-   * The acceptable status code.
-   * 
-   * >  We recommend that you configure assertions.
-   * 
-   * @example
-   * 400
-   */
   acceptableResponseCode?: string;
-  /**
-   * @remarks
-   * The assertions.
-   */
   assertions?: DescribeSiteMonitorListResponseBodySiteMonitorsSiteMonitorOptionsJsonAssertions;
-  /**
-   * @remarks
-   * The number of retries after a DNS failure occurred.
-   * 
-   * @example
-   * 3
-   */
   attempts?: number;
-  /**
-   * @remarks
-   * Indicates whether the security authentication feature is enabled. Valid values:
-   * 
-   * *   0: The feature is enabled.
-   * *   1: The feature is disabled.
-   * 
-   * @example
-   * 1
-   */
   authentication?: number;
-  /**
-   * @remarks
-   * Indicates whether the certificate is verified. Valid values:
-   * 
-   * *   false (default): The certificate is not verified.
-   * *   true: The certificate is verified.
-   * 
-   * @example
-   * false
-   */
   certVerify?: boolean;
-  /**
-   * @remarks
-   * The cookie of the HTTP request.
-   * 
-   * @example
-   * lang=en
-   */
   cookie?: string;
-  /**
-   * @remarks
-   * Indicates whether MTR is automatically used to diagnose network issues if a task fails. Valid values:
-   * 
-   * *   false (default): MTR is not automatically used to diagnose network issues if a task fails.
-   * *   true: MTR is automatically used to diagnose network issues if a task fails.
-   * 
-   * @example
-   * false
-   */
   diagnosisMtr?: boolean;
-  /**
-   * @remarks
-   * Indicates whether ping requests are automatically sent to detect network latency if a detection task fails. Valid values:
-   * 
-   * *   false (default): Ping requests are not automatically sent to detect network latency if a detection task fails.
-   * *   true: Ping requests are automatically sent to detect network latency if a detection task fails.
-   * 
-   * @example
-   * false
-   */
   diagnosisPing?: boolean;
-  /**
-   * @remarks
-   * The relationship between the list of expected aliases or IP addresses and the list of DNS results. Valid values:
-   * 
-   * *   IN_DNS: The list of expected values is a subset of the list of DNS results.
-   * *   DNS_IN: The list of DNS results is a subset of the list of expected values.
-   * *   EQUAL: The list of DNS results is the same as the list of expected values.
-   * *   ANY: The list of DNS results intersects with the list of expected values.
-   * 
-   * @example
-   * IN_DNS
-   */
   dnsMatchRule?: string;
-  /**
-   * @remarks
-   * The domain name or IP address of the DNS server.
-   * 
-   * @example
-   * 192.168.XX.XX
-   */
   dnsServer?: string;
-  /**
-   * @remarks
-   * The type of the DNS record. This parameter is returned only if the TaskType parameter is set to DNS. Valid values:
-   * 
-   * *   A (default): a record that specifies an IP address related to the specified host name or domain name.
-   * *   CNAME: a record that maps multiple domain names to a domain name.
-   * *   NS: a record that specifies a DNS server used to parse domain names.
-   * *   MX: a record that links domain names to the address of a mail server.
-   * *   TXT: a record that stores the text information of host name or domain names. The text must be 1 to 512 bytes in length. The TXT record serves as a Sender Policy Framework (SPF) record to fight against spam.
-   * *   AAAA: a record that maps a domain name to the relevant IPv6 address.
-   * 
-   * @example
-   * A
-   */
   dnsType?: string;
-  /**
-   * @remarks
-   * Indicates whether the DNS server of the carrier is used.
-   * 
-   * *   true (default): The DNS server of the carrier is used.
-   * *   false: The DNS server of the carrier is not used. The default DNS server or the specified DNS server is used.
-   * 
-   * @example
-   * true
-   */
   enableOperatorDns?: boolean;
-  /**
-   * @remarks
-   * The packet loss rate.
-   * 
-   * >  This parameter is returned only if the TaskType parameter is set to PING.
-   * 
-   * @example
-   * 0.5
-   */
   failureRate?: number;
-  /**
-   * @remarks
-   * The header of the HTTP request. An HTTP header is a key-value pair in which the key and the value are separated by a colon (:). The format is `key1:value1`. Each HTTP header occupies a line.
-   * 
-   * @example
-   * testKey:testValue
-   */
   header?: string;
-  /**
-   * @remarks
-   * The HTTP request method. Valid values:
-   * 
-   * *   get
-   * *   post
-   * *   head
-   * 
-   * @example
-   * get
-   */
   httpMethod?: string;
-  /**
-   * @remarks
-   * Indicates whether the password is decoded by using the Base64 algorithm. Valid values:
-   * 
-   * *   true: The password is decoded by using the Base64 algorithm.
-   * *   false (default): The password is not decoded by using the Base64 algorithm.
-   * 
-   * @example
-   * false
-   */
   isBase64Encode?: string;
-  /**
-   * @remarks
-   * Indicates whether the alert rule is included. Valid values:
-   * 
-   * *   0: The alert rule is included.
-   * *   1: The alert rule is not included.
-   * 
-   * @example
-   * 0
-   */
   matchRule?: number;
-  /**
-   * @remarks
-   * The password of the SMTP, POP3, or FTP protocol.
-   * 
-   * @example
-   * 123****
-   */
   password?: string;
-  /**
-   * @remarks
-   * The number of hops for the PING protocol.
-   * 
-   * @example
-   * 20
-   */
   pingNum?: number;
-  /**
-   * @remarks
-   * The port number of the TCP, UDP, SMTP, or POP3 protocol.
-   * 
-   * @example
-   * 80
-   */
   port?: number;
-  /**
-   * @remarks
-   * The protocol type of DNS detection. Valid values:
-   * 
-   * *   udp (default)
-   * *   tcp
-   * *   tcp-tls
-   * 
-   * @example
-   * udp
-   */
   protocol?: string;
-  /**
-   * @remarks
-   * Indicates whether the PROXY protocol is enabled. Valid values:
-   * 
-   * *   false (default): The PROXY protocol is disabled.
-   * *   true: The PROXY protocol is enabled.
-   * 
-   * @example
-   * false
-   */
   proxyProtocol?: boolean;
-  /**
-   * @remarks
-   * The content of the HTTP request.
-   * 
-   * @example
-   * cf0f85
-   */
   requestContent?: string;
-  /**
-   * @remarks
-   * The format of the HTTP request. Valid values:
-   * 
-   * *   hex: hexadecimal
-   * *   txt: text
-   * 
-   * @example
-   * hex
-   */
   requestFormat?: string;
-  /**
-   * @remarks
-   * The response to the HTTP request.
-   * 
-   * *   Hexadecimal format: If the request content is a byte string and cannot be represented in printable characters, you can convert the byte string to printable characters in the hexadecimal format. If you convert the byte string to printable characters in the hexadecimal format, one byte is converted to two hexadecimal characters. For example, (byte)1 is converted to `01` and (byte)27 is converted to `1B`. If the request content is a binary array in the Java format, for example, `{(byte)1, (byte)27}`, you can convert the binary array to `011b` or `011B`. Hexadecimal characters are not case-sensitive in site monitoring tasks. You can enter `011B` in the request content and set the request_format parameter to hex.
-   * *   Text format: Common text refers to strings that consist of printable characters.
-   * 
-   * @example
-   * cf0f85
-   */
   responseContent?: string;
-  /**
-   * @remarks
-   * The format of the HTTP response. Valid values:
-   * 
-   * *   hex: hexadecimal
-   * *   txt: text
-   * 
-   * @example
-   * hex
-   */
   responseFormat?: string;
-  /**
-   * @remarks
-   * The number of times a failed detection request is retried.
-   * 
-   * @example
-   * 1
-   */
   retryDelay?: number;
-  /**
-   * @remarks
-   * The timeout period. Unit: milliseconds.
-   * 
-   * @example
-   * 3000
-   */
   timeOut?: number;
-  /**
-   * @remarks
-   * Indicates whether redirects are followed if the status code 301 or 302 is returned. Valid values:
-   * 
-   * *   true: Redirects are not followed.
-   * *   false (default): Redirects are followed.
-   * 
-   * @example
-   * false
-   */
   unfollowRedirect?: boolean;
-  /**
-   * @remarks
-   * The username of the FTP, SMTP, or POP3 protocol.
-   * 
-   * @example
-   * testUser
-   */
   username?: string;
   static names(): { [key: string]: string } {
     return {
@@ -488,88 +174,15 @@ export class DescribeSiteMonitorListResponseBodySiteMonitorsSiteMonitorOptionsJs
 }
 
 export class DescribeSiteMonitorListResponseBodySiteMonitorsSiteMonitor extends $dara.Model {
-  /**
-   * @remarks
-   * The URL or IP address that is monitored by the site monitoring task.
-   * 
-   * @example
-   * https://aliyun.com
-   */
   address?: string;
-  /**
-   * @remarks
-   * The detection point type. Valid values:
-   * 
-   * *   PC
-   * *   MOBILE
-   * 
-   * @example
-   * PC
-   */
   agentGroup?: string;
-  /**
-   * @remarks
-   * The time when the site monitoring task was created.
-   * 
-   * @example
-   * 2021-11-01 11:05:18
-   */
   createTime?: string;
-  /**
-   * @remarks
-   * The interval at which detection requests are sent. Unit: minutes.
-   * 
-   * @example
-   * 1
-   */
   interval?: string;
-  /**
-   * @remarks
-   * The extended options of the site monitoring task. The options vary based on the specified protocol. For more information, see [CreateSiteMonitor](https://help.aliyun.com/document_detail/115048.html).
-   */
   optionsJson?: DescribeSiteMonitorListResponseBodySiteMonitorsSiteMonitorOptionsJson;
-  /**
-   * @remarks
-   * The ID of the site monitoring task.
-   * 
-   * @example
-   * f5783760-1b39-4b6b-80e8-453d962a****
-   */
   taskId?: string;
-  /**
-   * @remarks
-   * The name of the site monitoring task.
-   * 
-   * @example
-   * 域名检测_example.com.cn
-   */
   taskName?: string;
-  /**
-   * @remarks
-   * The task status. Valid values:
-   * 
-   * *   1: The task is enabled.
-   * *   2: The task is disabled.
-   * 
-   * @example
-   * 1
-   */
   taskState?: string;
-  /**
-   * @remarks
-   * The protocol that is used by the site monitoring task. Valid values: HTTP, PING, TCP, UDP, DNS, SMTP, POP3, and FTP.
-   * 
-   * @example
-   * TCP
-   */
   taskType?: string;
-  /**
-   * @remarks
-   * The time when the site monitoring task was updated.
-   * 
-   * @example
-   * 2022-03-08 17:14:31
-   */
   updateTime?: string;
   static names(): { [key: string]: string } {
     return {
@@ -642,9 +255,9 @@ export class DescribeSiteMonitorListResponseBodySiteMonitors extends $dara.Model
 export class DescribeSiteMonitorListResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The status code.
+   * The HTTP status code.
    * 
-   * >  The status code 200 indicates that the request was successful.
+   * > The value 200 indicates success.
    * 
    * @example
    * 200
@@ -682,17 +295,14 @@ export class DescribeSiteMonitorListResponseBody extends $dara.Model {
    * A80DB41C-AF6C-50E1-ADB5-66DCBA3D266B
    */
   requestId?: string;
-  /**
-   * @remarks
-   * The site monitoring tasks that are returned.
-   */
   siteMonitors?: DescribeSiteMonitorListResponseBodySiteMonitors;
   /**
    * @remarks
-   * Indicates whether the request was successful. Valid values:
+   * Indicates whether the operation was successful. Valid values:
+   * 
+   * - true: Successful.
    * 
-   * *   true
-   * *   false
+   * - false: Failed.
    * 
    * @example
    * true
@@ -700,7 +310,7 @@ export class DescribeSiteMonitorListResponseBody extends $dara.Model {
   success?: string;
   /**
    * @remarks
-   * The total number of entries returned.
+   * The total number of entries.
    * 
    * @example
    * 1

package/src/models/DescribeSiteMonitorLogRequest.ts

@@ -4,32 +4,46 @@ import * as $dara from '@darabonba/typescript';
 
 export class DescribeSiteMonitorLogRequest extends $dara.Model {
   /**
+   * @remarks
+   * The type of the browser.
+   * 
    * @example
    * Chrome
    */
   browser?: string;
+  /**
+   * @remarks
+   * This parameter is deprecated. You do not need to specify this parameter.
+   * 
+   * @example
+   * 无
+   */
   browserInfo?: string;
   /**
    * @remarks
-   * The city identification code.
+   * The city ID.
    * 
    * @example
    * 546
    */
   city?: string;
   /**
+   * @remarks
+   * The type of the device. This parameter specifies the screen size for impersonation.
+   * 
    * @example
    * laptop
    */
   device?: string;
   /**
    * @remarks
-   * The end of the time range to query. Valid values:
+   * The end of the time range to query. The following formats are supported:
+   * 
+   * - UNIX timestamp: the number of milliseconds that have elapsed since January 1, 1970.
    * 
-   * *   UNIX timestamp: the number of milliseconds that have elapsed since 00:00:00 Thursday, January 1, 1970
-   * *   UTC time: the UTC time that follows the YYYY-MM-DDThh:mm:ssZ format
+   * - UTC format: YYYY-MM-DDThh:mm:ssZ.
    * 
-   * >  We recommend that you use UNIX timestamps to prevent time zone-related issues.
+   * > Use UNIX timestamps to prevent time zone-related issues.
    * 
    * @example
    * 1638422475687
@@ -37,9 +51,9 @@ export class DescribeSiteMonitorLogRequest extends $dara.Model {
   endTime?: string;
   /**
    * @remarks
-   * The filter condition.
+   * The filter expression for detection results.
    * 
-   * You can specify a simple expression, for example, `TotalTime>100`. In this case, the operation returns only the data for instant test tasks whose total response time exceeds 100 milliseconds.
+   * Simple expressions are supported. For example, you can use the `TotalTime>100` expression to query the detection data whose total response time exceeds 100 milliseconds.
    * 
    * @example
    * TotalTime>100
@@ -47,7 +61,7 @@ export class DescribeSiteMonitorLogRequest extends $dara.Model {
   filter?: string;
   /**
    * @remarks
-   * The carrier identification code.
+   * The carrier ID.
    * 
    * @example
    * 465
@@ -55,7 +69,7 @@ export class DescribeSiteMonitorLogRequest extends $dara.Model {
   isp?: string;
   /**
    * @remarks
-   * The number of entries to return on each page. Valid values: 1 to 1440.
+   * The number of entries to return on each page for a paged query. Valid values: 1 to 1440.
    * 
    * @example
    * 1000
@@ -63,7 +77,7 @@ export class DescribeSiteMonitorLogRequest extends $dara.Model {
   length?: number;
   /**
    * @remarks
-   * The name of the metric.
+   * The metric.
    * 
    * Only the `ProbeLog` metric is supported.
    * 
@@ -73,7 +87,7 @@ export class DescribeSiteMonitorLogRequest extends $dara.Model {
   metricName?: string;
   /**
    * @remarks
-   * The token that is used to initiate the next request if the response of the current request is truncated. You can use the token to initiate another request and obtain the remaining records.``
+   * If the response is truncated, use the `NextToken` parameter to retrieve the next page of results.
    * 
    * @example
    * IWBjqMYSy0is7zSMGu16****
@@ -82,15 +96,13 @@ export class DescribeSiteMonitorLogRequest extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
-   * The start of the time range to query. The following formats are supported:
+   * The beginning of the time range to query. The following formats are supported:
    * 
-   * *   UNIX timestamp: the number of milliseconds that have elapsed since 00:00:00 Thursday, January 1, 1970
-   * *   UTC time: the UTC time that follows the YYYY-MM-DDThh:mm:ssZ format
+   * - UNIX timestamp: the number of milliseconds that have elapsed since January 1, 1970.
    * 
-   * > 
+   * - UTC format: YYYY-MM-DDThh:mm:ssZ.
    * 
-   * *   The specified time range includes the end time and excludes the start time. The start time must be earlier than the end time.\\
-   *     We recommend that you use UNIX timestamps to prevent time zone-related issues.
+   * > * The start time and end time follow the (StartTime, EndTime] pattern. The value of StartTime cannot be the same as or later than the value of EndTime.<br> - Use UNIX timestamps to prevent time zone-related issues.<br>
    * 
    * @example
    * 1638422474389
@@ -98,7 +110,7 @@ export class DescribeSiteMonitorLogRequest extends $dara.Model {
   startTime?: string;
   /**
    * @remarks
-   * The IDs of the instant test tasks. Separate multiple task IDs with commas (,).
+   * The ID of the detection task. You can specify multiple task IDs. Separate them with commas (,).
    * 
    * This parameter is required.
    * 

package/src/models/DescribeSiteMonitorLogResponseBody.ts

@@ -5,11 +5,9 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeSiteMonitorLogResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The HTTP status code.
+   * The status code.
    * 
-   * **
-   * 
-   * **Description** The status code 200 indicates that the request was successful.
+   * > A status code of 200 indicates that the operation was successful.
    * 
    * @example
    * 200
@@ -17,10 +15,10 @@ export class DescribeSiteMonitorLogResponseBody extends $dara.Model {
   code?: string;
   /**
    * @remarks
-   * The logs of the instant test tasks.
+   * The detection logs of the one-time detection task.
    * 
    * @example
-   * [{\\\\"redirectCount\\\\":0.0,\\\\"SSLConnectTime\\\\":0.0,\\\\"pingDetail\\\\":\\\\"\\\\",\\\\"HTTPConnectTime\\\\":0.0,\\\\"isp\\\\":\\\\"465\\\\",\\\\"errorCode\\\\":611,\\\\"ispCN\\\\":\\\\"Alibaba\\\\",\\\\"resolution\\\\":\\\\"\\\\",\\\\"areaEN\\\\":\\\\"HuaBei\\\\",\\\\"taskEndTimestamp\\\\":1638422475687,\\\\"targetIspEN\\\\":\\\\"\\\\",\\\\"TotalTime\\\\":1.0,\\\\"taskStartTimestamp\\\\":1638422474389,\\\\"countryCN\\\\":\\\\"China\\\\",\\\\"provinceEN\\\\":\\\\"Beijing\\\\",\\\\"countryEN\\\\":\\\\"China\\\\",\\\\"targetCityEN\\\\":\\\\"\\\\",\\\\"curlConnectTime\\\\":0.0,\\\\"ips\\\\":\\\\"\\\\",\\\\"route\\\\":\\\\"\\\\",\\\\"tcpConnectTime\\\\":0.0,\\\\"cityEN\\\\":\\\\"Beijing\\\\",\\\\"HTTPDownloadSpeed\\\\":0.0,\\\\"HTTPDownloadTime\\\\":0.0,\\\\"HTTPResponseCode\\\\":0.0,\\\\"areaCN\\\\":\\\\"North China\\\\",\\\\"city\\\\":\\\\"546\\\\",\\\\"expection\\\\":\\\\"\\\\",\\\\"suorceIp\\\\":\\\\"192.168.XX.XX \\\\",\\\\"ispEN\\\\":\\\\"Alibaba\\\\",\\\\"HTTPDNSTime\\\\":1.0,\\\\"targetIsp\\\\":\\\\"\\\\",\\\\"curlStarttransferTime\\\\":0.0,\\\\"provinceCN\\\\":\\\\"Beijing\\\\",\\\\"timestamp\\\\":1638422474000,\\\\"redirectTime\\\\":0.0,\\\\"targetCity\\\\":\\\\"\\\\", \\\\"expect\\\\":\\\\"\\\\",\\\\"HTTPDownloadSize\\\\":0.0,\\\\"localDns\\\\":\\\\"192.168.XX.XX\\\\",\\\\"cityCN\\\\":\\\\"Beijing\\\\",\\\\"taskId\\\\":\\\\"afa5c3ce-f944-4363-9edb-ce919a29\\*\\*\\*\\*\\\\"}]
+   * [{\\"redirectCount\\":0.0,\\"SSLConnectTime\\":0.0,\\"pingDetail\\":\\"\\",\\"HTTPConnectTime\\":0.0,\\"isp\\":\\"465\\",\\"errorCode\\":611,\\"ispCN\\":\\"阿里巴巴\\",\\"resolution\\":\\"\\",\\"areaEN\\":\\"HuaBei\\",\\"taskEndTimestamp\\":1638422475687,\\"targetIspEN\\":\\"\\",\\"TotalTime\\":1.0,\\"taskStartTimestamp\\":1638422474389,\\"countryCN\\":\\"中国\\",\\"provinceEN\\":\\"Beijing\\",\\"countryEN\\":\\"China\\",\\"targetCityEN\\":\\"\\",\\"curlConnectTime\\":0.0,\\"ips\\":\\"\\",\\"route\\":\\"\\",\\"tcpConnectTime\\":0.0,\\"cityEN\\":\\"Beijing\\",\\"HTTPDownloadSpeed\\":0.0,\\"HTTPDownloadTime\\":0.0,\\"HTTPResponseCode\\":0.0,\\"areaCN\\":\\"华北\\",\\"city\\":\\"546\\",\\"expection\\":\\"\\",\\"suorceIp\\":\\"192.168.XX.XX \\",\\"ispEN\\":\\"Alibaba\\",\\"HTTPDNSTime\\":1.0,\\"targetIsp\\":\\"\\",\\"curlStarttransferTime\\":0.0,\\"provinceCN\\":\\"北京市\\",\\"timestamp\\":1638422474000,\\"redirectTime\\":0.0,\\"targetCity\\":\\"\\", \\"expect\\":\\"\\",\\"HTTPDownloadSize\\":0.0,\\"localDns\\":\\"192.168.XX.XX\\",\\"cityCN\\":\\"北京市\\",\\"taskId\\":\\"afa5c3ce-f944-4363-9edb-ce919a29****\\"}]
    */
   data?: string;
   /**
@@ -33,7 +31,7 @@ export class DescribeSiteMonitorLogResponseBody extends $dara.Model {
   message?: string;
   /**
    * @remarks
-   * A pagination token. It can be used in the next request to retrieve a new page of results.
+   * The token that is used to query the next page.
    * 
    * @example
    * IWBjqMYSy0is7zSMGu16****
@@ -49,10 +47,11 @@ export class DescribeSiteMonitorLogResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * Indicates whether the request was successful. Valid values:
+   * Indicates whether the operation was successful. Valid values:
+   * 
+   * - true: The operation was successful.
    * 
-   * *   true
-   * *   false
+   * - false: The operation failed.
    * 
    * @example
    * true