1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
use std::future::Future;
#[cfg(feature = "tracing")]
use crate::TRACING_TARGET_SERVICE;
use crate::model::{
NetworkVolume, NetworkVolumeCreateInput, NetworkVolumeUpdateInput, NetworkVolumes,
};
use crate::{Result, RunpodClient};
/// Trait for managing network volumes.
///
/// Provides methods for creating, listing, retrieving, updating, and deleting network volumes.
/// This trait is implemented on the [`RunpodClient`](crate::client::RunpodClient).
pub trait VolumesService {
/// Creates a new network volume.
///
/// # Arguments
///
/// * `input` - Configuration for the new network volume
///
/// # Returns
///
/// Returns the created network volume information.
///
/// # Example
///
/// ```no_run
/// # use runpod_sdk::{RunpodClient, RunpodConfig, Result};
/// # use runpod_sdk::model::NetworkVolumeCreateInput;
/// # use runpod_sdk::service::VolumesService;
/// # async fn example() -> Result<()> {
/// let config = RunpodConfig::builder().with_api_key("your-api-key").build()?;
/// let client = RunpodClient::new(config)?;
///
/// let input = NetworkVolumeCreateInput {
/// name: "My Volume".to_string(),
/// size: 50,
/// data_center_id: "EU-RO-1".to_string(),
/// };
///
/// let volume = client.create_volume(input).await?;
/// println!("Created volume: {}", volume.id);
/// # Ok(())
/// # }
/// ```
fn create_volume(
&self,
input: NetworkVolumeCreateInput,
) -> impl Future<Output = Result<NetworkVolume>>;
/// Lists all network volumes.
///
/// # Returns
///
/// Returns a vector of all network volumes associated with the account.
///
/// # Example
///
/// ```no_run
/// # use runpod_sdk::{RunpodClient, RunpodConfig, Result};
/// # use runpod_sdk::service::VolumesService;
/// # async fn example() -> Result<()> {
/// let config = RunpodConfig::builder().with_api_key("your-api-key").build()?;
/// let client = RunpodClient::new(config)?;
///
/// let volumes = client.list_volumes().await?;
/// println!("Found {} volumes", volumes.len());
/// # Ok(())
/// # }
/// ```
fn list_volumes(&self) -> impl Future<Output = Result<NetworkVolumes>>;
/// Gets a specific network volume by ID.
///
/// # Arguments
///
/// * `volume_id` - The unique identifier of the network volume
///
/// # Returns
///
/// Returns the network volume information.
///
/// # Example
///
/// ```no_run
/// # use runpod_sdk::{RunpodClient, RunpodConfig, Result};
/// # use runpod_sdk::service::VolumesService;
/// # async fn example() -> Result<()> {
/// let config = RunpodConfig::builder().with_api_key("your-api-key").build()?;
/// let client = RunpodClient::new(config)?;
///
/// let volume = client.get_volume("volume_id").await?;
/// println!("Volume: {:?}", volume);
/// # Ok(())
/// # }
/// ```
fn get_volume(&self, volume_id: &str) -> impl Future<Output = Result<NetworkVolume>>;
/// Updates an existing network volume.
///
/// # Arguments
///
/// * `volume_id` - The unique identifier of the volume to update
/// * `input` - Update parameters for the network volume
///
/// # Returns
///
/// Returns the updated network volume information.
///
/// # Example
///
/// ```no_run
/// # use runpod_sdk::{RunpodClient, RunpodConfig, Result};
/// # use runpod_sdk::model::NetworkVolumeUpdateInput;
/// # use runpod_sdk::service::VolumesService;
/// # async fn example() -> Result<()> {
/// let config = RunpodConfig::builder().with_api_key("your-api-key").build()?;
/// let client = RunpodClient::new(config)?;
///
/// let input = NetworkVolumeUpdateInput {
/// name: Some("Updated Volume".to_string()),
/// ..Default::default()
/// };
///
/// let volume = client.update_volume("volume_id", input).await?;
/// println!("Updated volume: {}", volume.id);
/// # Ok(())
/// # }
/// ```
fn update_volume(
&self,
volume_id: &str,
input: NetworkVolumeUpdateInput,
) -> impl Future<Output = Result<NetworkVolume>>;
/// Deletes a network volume.
///
/// This operation will permanently remove the network volume and all its data.
///
/// # Arguments
///
/// * `volume_id` - The unique identifier of the volume to delete
///
/// # Example
///
/// ```no_run
/// # use runpod_sdk::{RunpodClient, RunpodConfig, Result};
/// # use runpod_sdk::service::VolumesService;
/// # async fn example() -> Result<()> {
/// let config = RunpodConfig::builder().with_api_key("your-api-key").build()?;
/// let client = RunpodClient::new(config)?;
///
/// client.delete_volume("volume_id").await?;
/// println!("Volume deleted");
/// # Ok(())
/// # }
/// ```
fn delete_volume(&self, volume_id: &str) -> impl Future<Output = Result<()>>;
}
impl VolumesService for RunpodClient {
async fn create_volume(&self, input: NetworkVolumeCreateInput) -> Result<NetworkVolume> {
#[cfg(feature = "tracing")]
tracing::debug!(target: TRACING_TARGET_SERVICE, "Creating network volume");
let response = self.post("/networkvolumes").json(&input).send().await?;
let response = response.error_for_status()?;
let volume: NetworkVolume = response.json().await?;
#[cfg(feature = "tracing")]
tracing::debug!(target: TRACING_TARGET_SERVICE, volume_id = %volume.id, "Network volume created successfully");
Ok(volume)
}
async fn list_volumes(&self) -> Result<NetworkVolumes> {
#[cfg(feature = "tracing")]
tracing::debug!(target: TRACING_TARGET_SERVICE, "Listing network volumes");
let response = self.get("/networkvolumes").send().await?;
let response = response.error_for_status()?;
let volumes: NetworkVolumes = response.json().await?;
#[cfg(feature = "tracing")]
tracing::debug!(
count = volumes.len(),
"Network volumes retrieved successfully"
);
Ok(volumes)
}
async fn get_volume(&self, volume_id: &str) -> Result<NetworkVolume> {
#[cfg(feature = "tracing")]
tracing::debug!(target: TRACING_TARGET_SERVICE, "Getting network volume");
let path = format!("/networkvolumes/{}", volume_id);
let response = self.get(&path).send().await?;
let response = response.error_for_status()?;
let volume: NetworkVolume = response.json().await?;
#[cfg(feature = "tracing")]
tracing::debug!(target: TRACING_TARGET_SERVICE, "Network volume retrieved successfully");
Ok(volume)
}
async fn update_volume(
&self,
volume_id: &str,
input: NetworkVolumeUpdateInput,
) -> Result<NetworkVolume> {
#[cfg(feature = "tracing")]
tracing::debug!(target: TRACING_TARGET_SERVICE, "Updating network volume");
let path = format!("/networkvolumes/{}", volume_id);
let response = self.patch(&path).json(&input).send().await?;
let response = response.error_for_status()?;
let volume: NetworkVolume = response.json().await?;
#[cfg(feature = "tracing")]
tracing::debug!(target: TRACING_TARGET_SERVICE, "Network volume updated successfully");
Ok(volume)
}
async fn delete_volume(&self, volume_id: &str) -> Result<()> {
#[cfg(feature = "tracing")]
tracing::debug!(target: TRACING_TARGET_SERVICE, "Deleting network volume");
let path = format!("/networkvolumes/{}", volume_id);
let response = self.delete(&path).send().await?;
response.error_for_status()?;
#[cfg(feature = "tracing")]
tracing::debug!(target: TRACING_TARGET_SERVICE, "Network volume deleted successfully");
Ok(())
}
}