@alicloud/dataworks-public20240518 9.9.2 → 9.9.3

package/src/models/ListImagesRequest.ts

@@ -5,11 +5,9 @@ import * as $dara from '@darabonba/typescript';
 export class ListImagesRequest extends $dara.Model {
   /**
    * @remarks
-   * The accessibility:
-   * 
-   * - Public: Visible to all members.
-   * 
-   * - Private: Visible only to the creator.
+   * The accessibility of the image. Valid values:
+   * - Public: The image is visible to all users.
+   * - Private: The image is visible only to the creator.
    * 
    * @example
    * Public
@@ -17,7 +15,7 @@ export class ListImagesRequest extends $dara.Model {
   accessibility?: string;
   /**
    * @remarks
-   * The image name, used for fuzzy search.
+   * The image name used for fuzzy match.
    * 
    * @example
    * image
@@ -38,7 +36,7 @@ export class ListImagesRequest extends $dara.Model {
   pageNumber?: number;
   /**
    * @remarks
-   * The page size.
+   * The number of entries per page.
    * 
    * @example
    * 10
@@ -51,22 +49,20 @@ export class ListImagesRequest extends $dara.Model {
   projectIds?: number[];
   /**
    * @remarks
-   * The list of image provider types.
+   * The list of image reference data types.
    */
   providerTypes?: string[];
   /**
    * @remarks
-   * Specifies whether to search all images.
+   * Specifies whether to search for all images.
    */
   searchAll?: boolean;
   /**
    * @remarks
-   * The list of sort fields. You can sort by scheduled time, start time, and other fields. The format is "SortField+SortOrder(Desc/Asc)", where Asc is the default and can be omitted. Valid values of sort fields:
-   * 
-   * - CreateTime (Desc/Asc): The creation time.
-   * 
-   * - Name (Desc/Asc): The image name.
-   *   Default value: CreateTime Asc.
+   * The list of sort fields. Fields such as scheduled time and start time are supported. The format is "sort field + sort order (Desc/Asc)". Asc can be omitted. Valid values for sort fields:
+   * - CreateTime (Desc/Asc): creation time.
+   * - Name (Desc/Asc): image name.
+   * Default value: CreateTime Asc.
    * 
    * @example
    * CreatedTime Desc
@@ -74,7 +70,7 @@ export class ListImagesRequest extends $dara.Model {
   sortBy?: string;
   /**
    * @remarks
-   * The list of image publish stages to query.
+   * The list of image publishing stages to query.
    */
   stages?: string[];
   /**

package/src/models/ListImagesResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ListImagesResponseBodyPagingInfoImageListBuildConfigPackageInstallationScripts extends $dara.Model {
   /**
    * @remarks
-   * The script content. If the content specifies package names, separate them with commas (,).
+   * The script content. If the content consists of installation package names, separate the names with commas (,).
    * 
    * @example
    * requests
@@ -53,7 +53,7 @@ export class ListImagesResponseBodyPagingInfoImageListBuildConfig extends $dara.
   buildType?: string;
   /**
    * @remarks
-   * The list of pre-installation scripts.
+   * The list of pre-installation execution scripts.
    */
   packageInstallationScripts?: ListImagesResponseBodyPagingInfoImageListBuildConfigPackageInstallationScripts[];
   static names(): { [key: string]: string } {
@@ -85,9 +85,8 @@ export class ListImagesResponseBodyPagingInfoImageListBuildConfig extends $dara.
 export class ListImagesResponseBodyPagingInfoImageListSupported extends $dara.Model {
   /**
    * @remarks
-   * The supported module:
-   * 
-   * - Scheduler: Scheduling.
+   * The supported module. Valid values:
+   * - Scheduler: the scheduling module.
    * 
    * @example
    * Scheduler
@@ -127,11 +126,9 @@ export class ListImagesResponseBodyPagingInfoImageListSupported extends $dara.Mo
 export class ListImagesResponseBodyPagingInfoImageList extends $dara.Model {
   /**
    * @remarks
-   * The accessibility:
-   * 
-   * - Public: Visible to all members.
-   * 
-   * - Private: Visible only to the creator.
+   * The accessibility of the image. Valid values:
+   * - Public: The image is visible to all users.
+   * - Private: The image is visible only to the creator.
    * 
    * @example
    * Public
@@ -139,7 +136,7 @@ export class ListImagesResponseBodyPagingInfoImageList extends $dara.Model {
   accessibility?: string;
   /**
    * @remarks
-   * The VPC ID associated with the ACR instance.
+   * The ID of the VPC associated with the ACR instance.
    * 
    * @example
    * vpc-xxx
@@ -168,7 +165,7 @@ export class ListImagesResponseBodyPagingInfoImageList extends $dara.Model {
   buildConfig?: ListImagesResponseBodyPagingInfoImageListBuildConfig;
   /**
    * @remarks
-   * The creation time, represented as a 64-bit timestamp.
+   * The creation time. This value is a 64-bit timestamp.
    * 
    * @example
    * 1727055811000
@@ -192,7 +189,7 @@ export class ListImagesResponseBodyPagingInfoImageList extends $dara.Model {
   description?: string;
   /**
    * @remarks
-   * Indicates whether synchronization with MaxCompute is enabled.
+   * Indicates whether MaxCompute synchronization is enabled.
    * 
    * @example
    * false
@@ -240,7 +237,7 @@ export class ListImagesResponseBodyPagingInfoImageList extends $dara.Model {
   isDefault?: boolean;
   /**
    * @remarks
-   * The last modification time, represented as a 64-bit timestamp.
+   * The last modification time. This value is a 64-bit timestamp.
    * 
    * @example
    * 1727055811000
@@ -272,7 +269,7 @@ export class ListImagesResponseBodyPagingInfoImageList extends $dara.Model {
   namespace?: string;
   /**
    * @remarks
-   * Indicates whether the image is an official image.
+   * Specifies whether the image is an official image.
    * 
    * @example
    * true
@@ -280,7 +277,7 @@ export class ListImagesResponseBodyPagingInfoImageList extends $dara.Model {
   official?: boolean;
   /**
    * @remarks
-   * The image ID assigned by the provider.
+   * The image ID of the image provider.
    * 
    * @example
    * acr_image_id
@@ -288,10 +285,8 @@ export class ListImagesResponseBodyPagingInfoImageList extends $dara.Model {
   providerImageId?: string;
   /**
    * @remarks
-   * The image provider type:
-   * 
+   * The image reference data type. Valid values:
    * - ACR: ACR image repository.
-   * 
    * - DataWorks: DataWorks official image.
    * 
    * @example
@@ -300,32 +295,19 @@ export class ListImagesResponseBodyPagingInfoImageList extends $dara.Model {
   providerType?: string;
   /**
    * @remarks
-   * The publish stage:
-   * 
+   * The publishing status. Valid values:
    * - Untest: Not tested.
-   * 
-   * - Testing: Being tested.
-   * 
+   * - Testing: Testing.
    * - TestFailed: Test failed.
-   * 
-   * - Unpublished: Not published.
-   * 
-   * - Publishing: Being published.
-   * 
+   * - Unpublished: Unpublished.
+   * - Publishing: Publishing.
    * - Published: Published.
-   * 
    * - PublishFailed: Publish failed.
-   * 
-   * - Building: Being built.
-   * 
+   * - Building: Building.
    * - BuildSuccess: Build succeeded.
-   * 
    * - BuildFailed: Build failed.
-   * 
-   * - Accelerating: Being accelerated.
-   * 
+   * - Accelerating: Accelerating.
    * - AccelerateSuccess: Acceleration succeeded.
-   * 
    * - AccelerateFailed: Acceleration failed.
    * 
    * @example
@@ -350,14 +332,10 @@ export class ListImagesResponseBodyPagingInfoImageList extends $dara.Model {
   size?: string;
   /**
    * @remarks
-   * The image status:
-   * 
+   * The image status. Valid values:
    * - Disabled: The image is disabled.
-   * 
    * - Expired: The image has expired.
-   * 
    * - Available: The image is available.
-   * 
    * - ReadOnly: The image is read-only.
    * 
    * @example
@@ -459,7 +437,7 @@ export class ListImagesResponseBodyPagingInfoImageList extends $dara.Model {
 export class ListImagesResponseBodyPagingInfo extends $dara.Model {
   /**
    * @remarks
-   * The list of image details.
+   * The list of retrieved image details.
    */
   imageList?: ListImagesResponseBodyPagingInfoImageList[];
   /**
@@ -472,7 +450,7 @@ export class ListImagesResponseBodyPagingInfo extends $dara.Model {
   pageNumber?: number;
   /**
    * @remarks
-   * The page size.
+   * The number of entries per page.
    * 
    * @example
    * 10
@@ -480,7 +458,7 @@ export class ListImagesResponseBodyPagingInfo extends $dara.Model {
   pageSize?: number;
   /**
    * @remarks
-   * The total number of entries.
+   * The total number of data entries.
    * 
    * @example
    * 10
@@ -519,12 +497,12 @@ export class ListImagesResponseBodyPagingInfo extends $dara.Model {
 export class ListImagesResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The pagination information.
+   * The paginated list.
    */
   pagingInfo?: ListImagesResponseBodyPagingInfo;
   /**
    * @remarks
-   * The request ID, which is used to locate logs and troubleshoot issues.
+   * The ID of the request, which is used to locate logs and troubleshoot issues.
    * 
    * @example
    * 6A6CBE87-9F91-1323-B680-E7A7065XXXXX
@@ -532,7 +510,7 @@ export class ListImagesResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * Indicates whether the request was successful.
+   * Indicates whether the request is successful.
    * 
    * @example
    * true

package/src/models/ListImagesShrinkRequest.ts

@@ -5,11 +5,9 @@ import * as $dara from '@darabonba/typescript';
 export class ListImagesShrinkRequest extends $dara.Model {
   /**
    * @remarks
-   * The accessibility:
-   * 
-   * - Public: Visible to all members.
-   * 
-   * - Private: Visible only to the creator.
+   * The accessibility of the image. Valid values:
+   * - Public: The image is visible to all users.
+   * - Private: The image is visible only to the creator.
    * 
    * @example
    * Public
@@ -17,7 +15,7 @@ export class ListImagesShrinkRequest extends $dara.Model {
   accessibility?: string;
   /**
    * @remarks
-   * The image name, used for fuzzy search.
+   * The image name used for fuzzy match.
    * 
    * @example
    * image
@@ -38,7 +36,7 @@ export class ListImagesShrinkRequest extends $dara.Model {
   pageNumber?: number;
   /**
    * @remarks
-   * The page size.
+   * The number of entries per page.
    * 
    * @example
    * 10
@@ -51,22 +49,20 @@ export class ListImagesShrinkRequest extends $dara.Model {
   projectIdsShrink?: string;
   /**
    * @remarks
-   * The list of image provider types.
+   * The list of image reference data types.
    */
   providerTypesShrink?: string;
   /**
    * @remarks
-   * Specifies whether to search all images.
+   * Specifies whether to search for all images.
    */
   searchAll?: boolean;
   /**
    * @remarks
-   * The list of sort fields. You can sort by scheduled time, start time, and other fields. The format is "SortField+SortOrder(Desc/Asc)", where Asc is the default and can be omitted. Valid values of sort fields:
-   * 
-   * - CreateTime (Desc/Asc): The creation time.
-   * 
-   * - Name (Desc/Asc): The image name.
-   *   Default value: CreateTime Asc.
+   * The list of sort fields. Fields such as scheduled time and start time are supported. The format is "sort field + sort order (Desc/Asc)". Asc can be omitted. Valid values for sort fields:
+   * - CreateTime (Desc/Asc): creation time.
+   * - Name (Desc/Asc): image name.
+   * Default value: CreateTime Asc.
    * 
    * @example
    * CreatedTime Desc
@@ -74,7 +70,7 @@ export class ListImagesShrinkRequest extends $dara.Model {
   sortBy?: string;
   /**
    * @remarks
-   * The list of image publish stages to query.
+   * The list of image publishing stages to query.
    */
   stagesShrink?: string;
   /**

package/src/models/ListLineageRelationshipsRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ListLineageRelationshipsRequest extends $dara.Model {
   /**
    * @remarks
-   * The destination entity ID. You can use the table or field ID returned by the ListTables or ListColumns operation, or use a custom entity ID.
+   * The ID of the destination entity. You can refer to the table or field ID returned by the ListTables or ListColumns operation, or use a custom entity ID.
    * 
    * This parameter is required.
    * 
@@ -15,7 +15,7 @@ export class ListLineageRelationshipsRequest extends $dara.Model {
   dstEntityId?: string;
   /**
    * @remarks
-   * The destination entity name. Fuzzy match is supported.
+   * The name of the destination entity. Fuzzy match is supported.
    * 
    * @example
    * dstName
@@ -42,7 +42,7 @@ export class ListLineageRelationshipsRequest extends $dara.Model {
   pageNumber?: number;
   /**
    * @remarks
-   * The page size. Default value: 10. Maximum value: 100.
+   * The number of entries per page. Default value: 10. Maximum value: 100.
    * 
    * @example
    * 10
@@ -50,7 +50,7 @@ export class ListLineageRelationshipsRequest extends $dara.Model {
   pageSize?: number;
   /**
    * @remarks
-   * The sort field. Default value: Name.
+   * The field used for sorting. Default value: Name.
    * 
    * @example
    * Name
@@ -58,9 +58,9 @@ export class ListLineageRelationshipsRequest extends $dara.Model {
   sortBy?: string;
   /**
    * @remarks
-   * The source entity ID. You can use the table or field ID returned by the ListTables or ListColumns operation, or use a custom entity ID.
+   * The ID of the source entity. You can refer to the table or field ID returned by the ListTables or ListColumns operation, or use a custom entity ID.
    * 
-   * To obtain a table or field entity ID, first call ListCrawlers to obtain the MetaEntityId of the metadata crawler. For types that contain a data catalog level, such as DLF and StarRocks, call ListCatalogs to obtain the catalog ID. Then call ListDatabases to obtain the database ID. If necessary, call ListSchemas to obtain the schema ID. Finally, call ListTables or ListColumns to obtain the table or field ID.
+   * To obtain the entity ID of a table or field, first call ListCrawlers to obtain the MetaEntityId of the metadata crawler. For types that include a data catalog hierarchy, such as DLF and StarRocks, call ListCatalogs to obtain the catalog ID. Then, call ListDatabases to obtain the database ID, and call ListSchemas to obtain the schema ID if necessary. Finally, call ListTables or ListColumns to obtain the table or field ID.
    * 
    * This parameter is required.
    * 
@@ -70,7 +70,7 @@ export class ListLineageRelationshipsRequest extends $dara.Model {
   srcEntityId?: string;
   /**
    * @remarks
-   * The source entity name. Fuzzy match is supported.
+   * The name of the source entity. Fuzzy match is supported.
    * 
    * @example
    * srcName

package/src/models/ListLineageRelationshipsResponseBody.ts

@@ -19,7 +19,7 @@ export class ListLineageRelationshipsResponseBodyPagingInfo extends $dara.Model
   pageNumber?: number;
   /**
    * @remarks
-   * The page size.
+   * The number of entries per page.
    * 
    * @example
    * 10
@@ -71,7 +71,7 @@ export class ListLineageRelationshipsResponseBody extends $dara.Model {
   pagingInfo?: ListLineageRelationshipsResponseBodyPagingInfo;
   /**
    * @remarks
-   * The request ID. You can use this ID to locate and troubleshoot issues.
+   * The ID of the request. You can use the ID to troubleshoot issues.
    * 
    * @example
    * SDFSDFSDF-SDFSDF-SDFDSF-SDFSDF
@@ -79,7 +79,7 @@ export class ListLineageRelationshipsResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * Indicates whether the request was successful.
+   * Indicates whether the request is successful.
    * 
    * @example
    * true

package/src/models/ListLineagesRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ListLineagesRequest extends $dara.Model {
   /**
    * @remarks
-   * The destination entity ID. You can use the table or column ID returned by the ListTables or ListColumns operation, or a custom entity ID.
+   * The destination entity ID. You can refer to the table or column ID returned by the ListTables or ListColumns operation, or use a custom entity ID.
    * 
    * @example
    * dlf-table::catalog_id:database_name::table_name
@@ -29,9 +29,9 @@ export class ListLineagesRequest extends $dara.Model {
   needAttachRelationship?: boolean;
   /**
    * @remarks
-   * The sort direction. Default value: Asc. Valid values:
-   * - Asc: ascending order.
-   * - Desc: descending order.
+   * The sort order. Default value: Asc. Valid values:
+   * - Asc: ascending order
+   * - Desc: descending order
    * 
    * @example
    * Asc
@@ -47,7 +47,7 @@ export class ListLineagesRequest extends $dara.Model {
   pageNumber?: number;
   /**
    * @remarks
-   * The page size. Default value: 10. Maximum value: 100.
+   * The number of entries per page. Default value: 10. Maximum value: 100.
    * 
    * @example
    * 10
@@ -56,7 +56,7 @@ export class ListLineagesRequest extends $dara.Model {
   recentDays?: number;
   /**
    * @remarks
-   * The sort field. Default value: Name, which sorts by lineage entity name.
+   * The sort field. Default value: Name. The entities are sorted by lineage entity name.
    * 
    * @example
    * Name
@@ -64,7 +64,7 @@ export class ListLineagesRequest extends $dara.Model {
   sortBy?: string;
   /**
    * @remarks
-   * The source entity ID. You can use the table or column ID returned by the ListTables or ListColumns operation, or a custom entity ID.
+   * The source entity ID. You can refer to the table or column ID returned by the ListTables or ListColumns operation, or use a custom entity ID.
    * 
    * @example
    * maxcompute-table:::project_name:[schema_name]:table_name

package/src/models/ListLineagesResponseBody.ts

@@ -57,12 +57,12 @@ export class ListLineagesResponseBodyPagingInfoLineages extends $dara.Model {
 export class ListLineagesResponseBodyPagingInfo extends $dara.Model {
   /**
    * @remarks
-   * The lineage information list.
+   * The list of lineage information.
    */
   lineages?: ListLineagesResponseBodyPagingInfoLineages[];
   /**
    * @remarks
-   * The page number of the returned data, used for pagination.
+   * The page number of the returned data, which is used for pagination.
    * 
    * @example
    * 1
@@ -70,7 +70,7 @@ export class ListLineagesResponseBodyPagingInfo extends $dara.Model {
   pageNumber?: number;
   /**
    * @remarks
-   * The page size. Default value: 10.
+   * The number of entries per page. Default value: 10.
    * 
    * @example
    * 10
@@ -117,7 +117,7 @@ export class ListLineagesResponseBodyPagingInfo extends $dara.Model {
 export class ListLineagesResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The paging result.
+   * The pagination result.
    */
   pagingInfo?: ListLineagesResponseBodyPagingInfo;
   /**
@@ -130,7 +130,7 @@ export class ListLineagesResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * Indicates whether the request was successful.
+   * Indicates whether the request is successful.
    * 
    * @example
    * true

package/src/models/ListNetworksRequest.ts

@@ -21,28 +21,22 @@ export class ListNetworksRequest extends $dara.Model {
   pageSize?: number;
   /**
    * @remarks
-   * The ID of the resource group.
+   * The unique identifier of the general resource group.
    * 
    * This parameter is required.
    * 
    * @example
-   * Serverless_res_group_524257424564736_6831777003XXXXX
+   * Serverless_res_group_524257424564736_6831777003****
    */
   resourceGroupId?: string;
   /**
    * @remarks
-   * The fields used for sorting. Fields such as scheduled time and start time are supported. The value of this parameter is in the Sort field + Sort by (Desc/Asc) format. By default, results are sorted in ascending order. Valid values:
-   * 
-   * 
-   * 
-   * 
-   * - Id (Desc/Asc): the network ID
-   * - Status (Desc/Asc): the network status
-   * - CreateUser (Desc/Asc): the user who created the network
-   * - CreateTime (Desc/Asc): the time when the network was created
-   * 
-   * 
+   * The sort fields. Supports fields such as scheduled time and start time. The format is sort field + sort order (Desc/Asc), where Asc can be omitted. Valid values for sort fields:
    * 
+   * - Id (Desc/Asc): Network ID
+   * - Status (Desc/Asc): Network status
+   * - CreateUser (Desc/Asc): Creator
+   * - CreateTime (Desc/Asc): Creation time
    * 
    * Default value: CreateTime Asc.
    * 

package/src/models/ListNetworksResponseBody.ts

@@ -13,7 +13,7 @@ export class ListNetworksResponseBodyPagingInfoNetworkList extends $dara.Model {
   createTime?: number;
   /**
    * @remarks
-   * The ID of the user who creates the network resource.
+   * The ID of the user who created the network resource.
    * 
    * @example
    * 11075500042XXXXX
@@ -21,7 +21,7 @@ export class ListNetworksResponseBodyPagingInfoNetworkList extends $dara.Model {
   createUser?: string;
   /**
    * @remarks
-   * The network ID.
+   * The ID of the network resource.
    * 
    * @example
    * 1000
@@ -29,7 +29,7 @@ export class ListNetworksResponseBodyPagingInfoNetworkList extends $dara.Model {
   id?: number;
   /**
    * @remarks
-   * The ID of the serverless resource group.
+   * The unique identifier of the general resource group to which the network resource belongs.
    * 
    * @example
    * Serverless_res_group_524257424564736_6831777003XXXXX
@@ -37,7 +37,7 @@ export class ListNetworksResponseBodyPagingInfoNetworkList extends $dara.Model {
   resourceGroupId?: string;
   /**
    * @remarks
-   * The security group ID.
+   * The security group ID of the network resource.
    * 
    * @example
    * sg-2ze13vamugr7jenXXXXX
@@ -45,7 +45,7 @@ export class ListNetworksResponseBodyPagingInfoNetworkList extends $dara.Model {
   securityGroupId?: string;
   /**
    * @remarks
-   * The status of the network resource. Valid values: Pending: waiting; Creating: being created; Running: running normally; Deleting: being deleted; Deleted: deleted.
+   * The current status of the network resource. A value of Pending indicates that the resource is waiting. A value of Creating indicates that the resource is being created. A value of Running indicates that the resource is running normally. A value of Deleting indicates that the resource is being deleted. A value of Deleted indicates that the resource is deleted.
    * 
    * @example
    * Running
@@ -53,7 +53,7 @@ export class ListNetworksResponseBodyPagingInfoNetworkList extends $dara.Model {
   status?: string;
   /**
    * @remarks
-   * The ID of the virtual private cloud (VPC).
+   * The VPC ID of the network resource.
    * 
    * @example
    * vpc-m2et4f3oc8msfbccXXXXX
@@ -61,7 +61,7 @@ export class ListNetworksResponseBodyPagingInfoNetworkList extends $dara.Model {
   vpcId?: string;
   /**
    * @remarks
-   * The VSwitch ID.
+   * The vSwitch ID of the network resource.
    * 
    * @example
    * vsw-uf8usrhs7hjd9amsXXXXX
@@ -105,7 +105,7 @@ export class ListNetworksResponseBodyPagingInfoNetworkList extends $dara.Model {
 export class ListNetworksResponseBodyPagingInfo extends $dara.Model {
   /**
    * @remarks
-   * The network resources of the serverless resource group.
+   * The list of detailed information about the network resources in the general resource group.
    */
   networkList?: ListNetworksResponseBodyPagingInfoNetworkList[];
   /**
@@ -126,7 +126,7 @@ export class ListNetworksResponseBodyPagingInfo extends $dara.Model {
   pageSize?: number;
   /**
    * @remarks
-   * The total number of entries that meet the conditions.
+   * The total number of entries.
    * 
    * @example
    * 100
@@ -170,7 +170,7 @@ export class ListNetworksResponseBody extends $dara.Model {
   pagingInfo?: ListNetworksResponseBodyPagingInfo;
   /**
    * @remarks
-   * The ID of the request. It is used to locate logs and troubleshoot problems.
+   * The ID of the request. You can use the ID to locate logs and troubleshoot issues.
    * 
    * @example
    * 6A6CBE87-9F91-1323-B680-E7A7065XXXXX
@@ -178,7 +178,7 @@ export class ListNetworksResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * Indicates whether the request was successful.
+   * Indicates whether the request is successful.
    * 
    * @example
    * true