volcengine_rust_sdk/service/ecs/
api_stop_instances_models.rs

1/*
2 * @Author: Jerry.Yang
3 * @Date: 2024-10-28 17:13:35
4 * @LastEditors: Jerry.Yang
5 * @LastEditTime: 2025-02-05 16:50:23
6 * @Description: API model for stopping instances in ECS (Elastic Compute Service)
7 */
8use crate::volcengine::error::error;
9use crate::volcengine::request::request::RequestVolcengine;
10use crate::volcengine::request::{request, response};
11use std::collections::HashMap;
12use volcengine_sdk_protobuf::protobuf::ecs_instance;
13
14// Implementation of the ApiRequest trait for the StopInstancesReq struct.
15// This allows the struct to be used as a request object in API calls to stop multiple ECS instances.
16impl request::ApiRequest for ecs_instance::StopInstancesReq {
17    /// Converts the request into a HashMap of key-value pairs for use in HTTP requests.
18    /// This method is typically used when sending the request to the API server to stop multiple instances.
19    fn to_hashmap(&self) -> HashMap<String, String> {
20        request::Request::format_request_to_hashmap(self)
21    }
22
23    /// Prepares the request body as a byte vector.
24    /// For this request, the body is an empty vector since it's a GET request.
25    fn to_body(&self) -> Vec<u8> {
26        let result = Vec::new();
27        result
28    }
29}
30
31// Implementation of the ApiResponse trait for the StopInstancesResp struct.
32// This allows the struct to parse HTTP responses and convert them into a structured object containing information about the stopped instances.
33impl response::ApiResponse for ecs_instance::StopInstancesResp {
34    /// Converts the HTTP response into a structured response object.
35    /// This method handles parsing the JSON response from the API server and updating the current object with the parsed data.
36    async fn to_struct(&mut self, http_response: reqwest::Response) -> Result<(), error::Error> {
37        // Parse the JSON response from the HTTP response.
38        // The `json()` method deserializes the response body into the target type.
39        let parsed_response: volcengine_sdk_protobuf::protobuf::ecs_instance::StopInstancesResp =
40            http_response
41                .json()
42                .await
43                .map_err(|e| error::Error::ErrParseResponse(e))?; // Handle JSON parsing errors
44
45        // Replace the current `self` with the parsed response.
46        *self = parsed_response;
47
48        // Return Ok(()) to indicate successful parsing.
49        Ok(())
50    }
51}