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 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450
use anyhow::Result;
use crate::Client;
pub struct Instances {
pub client: Client,
}
impl Instances {
#[doc(hidden)]
pub fn new(client: Client) -> Self {
Instances { client }
}
/**
* This function performs a `GET` to the `/organizations/{organization_name}/projects/{project_name}/instances` endpoint.
*
* List instances in a project.
*
* **Parameters:**
*
* * `limit: u32` -- A count of bytes, typically used either for memory or storage capacity
*
* The maximum supported byte count is [`i64::MAX`]. This makes it somewhat inconvenient to define constructors: a u32 constructor can be infallible, but an i64 constructor can fail (if the value is negative) and a u64 constructor can fail (if the value is larger than i64::MAX). We provide all of these for consumers' convenience.
* * `page_token: &str` -- human-readable free-form text about a resource.
* * `sort_by: crate::types::NameSortModeAscending` -- Supported set of sort modes for scanning by name only
*
* Currently, we only support scanning in ascending order.
* * `organization_name: &str` -- human-readable free-form text about a resource.
* * `project_name: &str` -- human-readable free-form text about a resource.
*/
pub async fn project_get(
&self,
limit: u32,
page_token: &str,
sort_by: crate::types::NameSortModeAscending,
organization_name: &str,
project_name: &str,
) -> Result<Vec<crate::types::Instance>> {
let mut query_args: Vec<(String, String)> = Default::default();
if !limit.to_string().is_empty() {
query_args.push(("limit".to_string(), limit.to_string()));
}
if !page_token.is_empty() {
query_args.push(("page_token".to_string(), page_token.to_string()));
}
if !sort_by.to_string().is_empty() {
query_args.push(("sort_by".to_string(), sort_by.to_string()));
}
let query_ = serde_urlencoded::to_string(&query_args).unwrap();
let url = format!(
"/organizations/{}/projects/{}/instances?{}",
crate::progenitor_support::encode_path(organization_name),
crate::progenitor_support::encode_path(project_name),
query_
);
let resp: crate::types::InstanceResultsPage = self.client.get(&url, None).await?;
// Return our response data.
Ok(resp.items)
}
/**
* This function performs a `GET` to the `/organizations/{organization_name}/projects/{project_name}/instances` endpoint.
*
* As opposed to `project_get`, this function returns all the pages of the request at once.
*
* List instances in a project.
*/
pub async fn project_get_all(
&self,
sort_by: crate::types::NameSortModeAscending,
organization_name: &str,
project_name: &str,
) -> Result<Vec<crate::types::Instance>> {
let mut query_args: Vec<(String, String)> = Default::default();
if !sort_by.to_string().is_empty() {
query_args.push(("sort_by".to_string(), sort_by.to_string()));
}
let query_ = serde_urlencoded::to_string(&query_args).unwrap();
let url = format!(
"/organizations/{}/projects/{}/instances?{}",
crate::progenitor_support::encode_path(organization_name),
crate::progenitor_support::encode_path(project_name),
query_
);
let mut resp: crate::types::InstanceResultsPage = self.client.get(&url, None).await?;
let mut items = resp.items;
let mut page = resp.next_page;
// Paginate if we should.
while !page.is_empty() {
if !url.contains('?') {
resp = self
.client
.get(&format!("{}?page={}", url, page), None)
.await?;
} else {
resp = self
.client
.get(&format!("{}&page={}", url, page), None)
.await?;
}
items.append(&mut resp.items);
if !resp.next_page.is_empty() && resp.next_page != page {
page = resp.next_page.to_string();
} else {
page = "".to_string();
}
}
// Return our response data.
Ok(items)
}
/**
* This function performs a `POST` to the `/organizations/{organization_name}/projects/{project_name}/instances` endpoint.
*
* Create an instance in a project.
* * TODO-correctness This is supposed to be async. Is that right? We can create the instance immediately -- it's just not booted yet. Maybe the boot operation is what's a separate operation_id. What about the response code (201 Created vs 202 Accepted)? Is that orthogonal? Things can return a useful response, including an operation id, with either response code. Maybe a "reboot" operation would return a 202 Accepted because there's no actual resource created?
*
* **Parameters:**
*
* * `organization_name: &str` -- human-readable free-form text about a resource.
* * `project_name: &str` -- human-readable free-form text about a resource.
*/
pub async fn project_post(
&self,
organization_name: &str,
project_name: &str,
body: &crate::types::InstanceCreate,
) -> Result<crate::types::Instance> {
let url = format!(
"/organizations/{}/projects/{}/instances",
crate::progenitor_support::encode_path(organization_name),
crate::progenitor_support::encode_path(project_name),
);
self.client
.post(&url, Some(reqwest::Body::from(serde_json::to_vec(body)?)))
.await
}
/**
* This function performs a `GET` to the `/organizations/{organization_name}/projects/{project_name}/instances/{instance_name}` endpoint.
*
* Get an instance in a project.
*
* **Parameters:**
*
* * `instance_name: &str` -- human-readable free-form text about a resource.
* * `organization_name: &str` -- human-readable free-form text about a resource.
* * `project_name: &str` -- human-readable free-form text about a resource.
*/
pub async fn project_get_instances(
&self,
instance_name: &str,
organization_name: &str,
project_name: &str,
) -> Result<crate::types::Instance> {
let url = format!(
"/organizations/{}/projects/{}/instances/{}",
crate::progenitor_support::encode_path(organization_name),
crate::progenitor_support::encode_path(project_name),
crate::progenitor_support::encode_path(instance_name),
);
self.client.get(&url, None).await
}
/**
* This function performs a `DELETE` to the `/organizations/{organization_name}/projects/{project_name}/instances/{instance_name}` endpoint.
*
* Delete an instance from a project.
*
* **Parameters:**
*
* * `instance_name: &str` -- human-readable free-form text about a resource.
* * `organization_name: &str` -- human-readable free-form text about a resource.
* * `project_name: &str` -- human-readable free-form text about a resource.
*/
pub async fn project_delete(
&self,
instance_name: &str,
organization_name: &str,
project_name: &str,
) -> Result<()> {
let url = format!(
"/organizations/{}/projects/{}/instances/{}",
crate::progenitor_support::encode_path(organization_name),
crate::progenitor_support::encode_path(project_name),
crate::progenitor_support::encode_path(instance_name),
);
self.client.delete(&url, None).await
}
/**
* This function performs a `GET` to the `/organizations/{organization_name}/projects/{project_name}/instances/{instance_name}/disks` endpoint.
*
* List disks attached to this instance.
*
* **Parameters:**
*
* * `limit: u32` -- A count of bytes, typically used either for memory or storage capacity
*
* The maximum supported byte count is [`i64::MAX`]. This makes it somewhat inconvenient to define constructors: a u32 constructor can be infallible, but an i64 constructor can fail (if the value is negative) and a u64 constructor can fail (if the value is larger than i64::MAX). We provide all of these for consumers' convenience.
* * `page_token: &str` -- human-readable free-form text about a resource.
* * `sort_by: crate::types::NameSortModeAscending` -- Supported set of sort modes for scanning by name only
*
* Currently, we only support scanning in ascending order.
* * `instance_name: &str` -- human-readable free-form text about a resource.
* * `organization_name: &str` -- human-readable free-form text about a resource.
* * `project_name: &str` -- human-readable free-form text about a resource.
*/
pub async fn disks_get(
&self,
limit: u32,
page_token: &str,
sort_by: crate::types::NameSortModeAscending,
instance_name: &str,
organization_name: &str,
project_name: &str,
) -> Result<Vec<crate::types::Disk>> {
let mut query_args: Vec<(String, String)> = Default::default();
if !limit.to_string().is_empty() {
query_args.push(("limit".to_string(), limit.to_string()));
}
if !page_token.is_empty() {
query_args.push(("page_token".to_string(), page_token.to_string()));
}
if !sort_by.to_string().is_empty() {
query_args.push(("sort_by".to_string(), sort_by.to_string()));
}
let query_ = serde_urlencoded::to_string(&query_args).unwrap();
let url = format!(
"/organizations/{}/projects/{}/instances/{}/disks?{}",
crate::progenitor_support::encode_path(organization_name),
crate::progenitor_support::encode_path(project_name),
crate::progenitor_support::encode_path(instance_name),
query_
);
let resp: crate::types::DiskResultsPage = self.client.get(&url, None).await?;
// Return our response data.
Ok(resp.items)
}
/**
* This function performs a `GET` to the `/organizations/{organization_name}/projects/{project_name}/instances/{instance_name}/disks` endpoint.
*
* As opposed to `disks_get`, this function returns all the pages of the request at once.
*
* List disks attached to this instance.
*/
pub async fn disks_get_all(
&self,
sort_by: crate::types::NameSortModeAscending,
instance_name: &str,
organization_name: &str,
project_name: &str,
) -> Result<Vec<crate::types::Disk>> {
let mut query_args: Vec<(String, String)> = Default::default();
if !sort_by.to_string().is_empty() {
query_args.push(("sort_by".to_string(), sort_by.to_string()));
}
let query_ = serde_urlencoded::to_string(&query_args).unwrap();
let url = format!(
"/organizations/{}/projects/{}/instances/{}/disks?{}",
crate::progenitor_support::encode_path(organization_name),
crate::progenitor_support::encode_path(project_name),
crate::progenitor_support::encode_path(instance_name),
query_
);
let mut resp: crate::types::DiskResultsPage = self.client.get(&url, None).await?;
let mut items = resp.items;
let mut page = resp.next_page;
// Paginate if we should.
while !page.is_empty() {
if !url.contains('?') {
resp = self
.client
.get(&format!("{}?page={}", url, page), None)
.await?;
} else {
resp = self
.client
.get(&format!("{}&page={}", url, page), None)
.await?;
}
items.append(&mut resp.items);
if !resp.next_page.is_empty() && resp.next_page != page {
page = resp.next_page.to_string();
} else {
page = "".to_string();
}
}
// Return our response data.
Ok(items)
}
/**
* This function performs a `POST` to the `/organizations/{organization_name}/projects/{project_name}/instances/{instance_name}/disks/attach` endpoint.
*
* **Parameters:**
*
* * `instance_name: &str` -- human-readable free-form text about a resource.
* * `organization_name: &str` -- human-readable free-form text about a resource.
* * `project_name: &str` -- human-readable free-form text about a resource.
*/
pub async fn disks_attach(
&self,
instance_name: &str,
organization_name: &str,
project_name: &str,
body: &crate::types::DiskIdentifier,
) -> Result<crate::types::Disk> {
let url = format!(
"/organizations/{}/projects/{}/instances/{}/disks/attach",
crate::progenitor_support::encode_path(organization_name),
crate::progenitor_support::encode_path(project_name),
crate::progenitor_support::encode_path(instance_name),
);
self.client
.post(&url, Some(reqwest::Body::from(serde_json::to_vec(body)?)))
.await
}
/**
* This function performs a `POST` to the `/organizations/{organization_name}/projects/{project_name}/instances/{instance_name}/disks/detach` endpoint.
*
* **Parameters:**
*
* * `instance_name: &str` -- human-readable free-form text about a resource.
* * `organization_name: &str` -- human-readable free-form text about a resource.
* * `project_name: &str` -- human-readable free-form text about a resource.
*/
pub async fn disks_detach(
&self,
instance_name: &str,
organization_name: &str,
project_name: &str,
body: &crate::types::DiskIdentifier,
) -> Result<crate::types::Disk> {
let url = format!(
"/organizations/{}/projects/{}/instances/{}/disks/detach",
crate::progenitor_support::encode_path(organization_name),
crate::progenitor_support::encode_path(project_name),
crate::progenitor_support::encode_path(instance_name),
);
self.client
.post(&url, Some(reqwest::Body::from(serde_json::to_vec(body)?)))
.await
}
/**
* This function performs a `POST` to the `/organizations/{organization_name}/projects/{project_name}/instances/{instance_name}/reboot` endpoint.
*
* Reboot an instance.
*
* **Parameters:**
*
* * `instance_name: &str` -- human-readable free-form text about a resource.
* * `organization_name: &str` -- human-readable free-form text about a resource.
* * `project_name: &str` -- human-readable free-form text about a resource.
*/
pub async fn project_reboot(
&self,
instance_name: &str,
organization_name: &str,
project_name: &str,
) -> Result<crate::types::Instance> {
let url = format!(
"/organizations/{}/projects/{}/instances/{}/reboot",
crate::progenitor_support::encode_path(organization_name),
crate::progenitor_support::encode_path(project_name),
crate::progenitor_support::encode_path(instance_name),
);
self.client.post(&url, None).await
}
/**
* This function performs a `POST` to the `/organizations/{organization_name}/projects/{project_name}/instances/{instance_name}/start` endpoint.
*
* Boot an instance.
*
* **Parameters:**
*
* * `instance_name: &str` -- human-readable free-form text about a resource.
* * `organization_name: &str` -- human-readable free-form text about a resource.
* * `project_name: &str` -- human-readable free-form text about a resource.
*/
pub async fn project_start(
&self,
instance_name: &str,
organization_name: &str,
project_name: &str,
) -> Result<crate::types::Instance> {
let url = format!(
"/organizations/{}/projects/{}/instances/{}/start",
crate::progenitor_support::encode_path(organization_name),
crate::progenitor_support::encode_path(project_name),
crate::progenitor_support::encode_path(instance_name),
);
self.client.post(&url, None).await
}
/**
* This function performs a `POST` to the `/organizations/{organization_name}/projects/{project_name}/instances/{instance_name}/stop` endpoint.
*
* Halt an instance.
*
* **Parameters:**
*
* * `instance_name: &str` -- human-readable free-form text about a resource.
* * `organization_name: &str` -- human-readable free-form text about a resource.
* * `project_name: &str` -- human-readable free-form text about a resource.
*/
pub async fn project_stop(
&self,
instance_name: &str,
organization_name: &str,
project_name: &str,
) -> Result<crate::types::Instance> {
let url = format!(
"/organizations/{}/projects/{}/instances/{}/stop",
crate::progenitor_support::encode_path(organization_name),
crate::progenitor_support::encode_path(project_name),
crate::progenitor_support::encode_path(instance_name),
);
self.client.post(&url, None).await
}
}
