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
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
// SPDX-License-Identifier: Apache-2.0
//
// WARNING: This file is automatically generated from OpenAPI schema using
// `openstack-codegenerator`.
//! Creates a flavor.
//!
//! Creating a flavor is typically only available to administrators of a cloud
//! because this has implications for scheduling efficiently in the cloud.
//!
//! Normal response codes: 200
//!
//! Error response codes: badRequest(400), unauthorized(401), forbidden(403),
//! conflict(409)
//!
use derive_builder::Builder;
use http::{HeaderMap, HeaderName, HeaderValue};
use crate::api::rest_endpoint_prelude::*;
use serde::Deserialize;
use serde::Serialize;
use std::borrow::Cow;
/// The ID and links for the flavor for your server instance. A flavor is a
/// combination of memory, disk size, and CPUs.
///
#[derive(Builder, Debug, Deserialize, Clone, Serialize)]
#[builder(setter(strip_option))]
pub struct Flavor<'a> {
/// The size of a dedicated swap disk that will be allocated, in MiB. If 0
/// (the default), no dedicated swap disk will be created.
///
#[serde()]
#[builder(setter(into))]
pub(crate) disk: Cow<'a, str>,
/// Only alphanumeric characters with hyphen ‘-’, underscore ‘\_’, spaces
/// and dots ‘.’ are permitted. If an ID is not provided, then a default
/// UUID will be assigned.
///
#[serde(skip_serializing_if = "Option::is_none")]
#[builder(default, setter(into))]
pub(crate) id: Option<Option<Cow<'a, str>>>,
/// The display name of a flavor.
///
#[serde()]
#[builder(setter(into))]
pub(crate) name: Cow<'a, str>,
/// Whether the flavor is public (available to all projects) or scoped to a
/// set of projects. Default is True if not specified.
///
#[serde(
rename = "os-flavor-access:is_public",
skip_serializing_if = "Option::is_none"
)]
#[builder(default)]
pub(crate) os_flavor_access_is_public: Option<bool>,
/// The size of a dedicated swap disk that will be allocated, in MiB. If 0
/// (the default), no dedicated swap disk will be created.
///
#[serde(
rename = "OS-FLV-EXT-DATA:ephemeral",
skip_serializing_if = "Option::is_none"
)]
#[builder(default, setter(into))]
pub(crate) os_flv_ext_data_ephemeral: Option<Cow<'a, str>>,
/// The number of virtual CPUs that will be allocated to the server.
///
#[serde()]
#[builder(setter(into))]
pub(crate) ram: Cow<'a, str>,
/// The receive / transmit factor (as a float) that will be set on ports if
/// the network backend supports the QOS extension. Otherwise it will be
/// ignored. It defaults to 1.0.
///
#[serde(skip_serializing_if = "Option::is_none")]
#[builder(default, setter(into))]
pub(crate) rxtx_factor: Option<Cow<'a, str>>,
/// The size of a dedicated swap disk that will be allocated, in MiB. If 0
/// (the default), no dedicated swap disk will be created.
///
#[serde(skip_serializing_if = "Option::is_none")]
#[builder(default, setter(into))]
pub(crate) swap: Option<Cow<'a, str>>,
/// The number of virtual CPUs that will be allocated to the server.
///
#[serde()]
#[builder(setter(into))]
pub(crate) vcpus: Cow<'a, str>,
}
#[derive(Builder, Debug, Clone)]
#[builder(setter(strip_option))]
pub struct Request<'a> {
/// The ID and links for the flavor for your server instance. A flavor is a
/// combination of memory, disk size, and CPUs.
///
#[builder(setter(into))]
pub(crate) flavor: Flavor<'a>,
#[builder(setter(name = "_headers"), default, private)]
_headers: Option<HeaderMap>,
}
impl<'a> Request<'a> {
/// Create a builder for the endpoint.
pub fn builder() -> RequestBuilder<'a> {
RequestBuilder::default()
}
}
impl<'a> RequestBuilder<'a> {
/// Add a single header to the Flavor.
pub fn header(&mut self, header_name: &'static str, header_value: &'static str) -> &mut Self
where {
self._headers
.get_or_insert(None)
.get_or_insert_with(HeaderMap::new)
.insert(header_name, HeaderValue::from_static(header_value));
self
}
/// Add multiple headers.
pub fn headers<I, T>(&mut self, iter: I) -> &mut Self
where
I: Iterator<Item = T>,
T: Into<(Option<HeaderName>, HeaderValue)>,
{
self._headers
.get_or_insert(None)
.get_or_insert_with(HeaderMap::new)
.extend(iter.map(Into::into));
self
}
}
impl<'a> RestEndpoint for Request<'a> {
fn method(&self) -> http::Method {
http::Method::POST
}
fn endpoint(&self) -> Cow<'static, str> {
"flavors".to_string().into()
}
fn parameters(&self) -> QueryParams {
QueryParams::default()
}
fn body(&self) -> Result<Option<(&'static str, Vec<u8>)>, BodyError> {
let mut params = JsonBodyParams::default();
params.push("flavor", serde_json::to_value(&self.flavor)?);
params.into_body()
}
fn service_type(&self) -> ServiceType {
ServiceType::Compute
}
fn response_key(&self) -> Option<Cow<'static, str>> {
Some("flavor".into())
}
/// Returns headers to be set into the request
fn request_headers(&self) -> Option<&HeaderMap> {
self._headers.as_ref()
}
/// Returns required API version
fn api_version(&self) -> Option<ApiVersion> {
Some(ApiVersion::new(2, 1))
}
}
#[cfg(test)]
mod tests {
#![allow(unused_imports)]
use super::*;
#[cfg(feature = "sync")]
use crate::api::Query;
#[cfg(feature = "sync")]
use crate::test::client::MockServerClient;
use crate::types::ServiceType;
use http::{HeaderName, HeaderValue};
use serde_json::json;
#[test]
fn test_service_type() {
assert_eq!(
Request::builder()
.flavor(
FlavorBuilder::default()
.disk("foo")
.name("foo")
.ram("foo")
.vcpus("foo")
.build()
.unwrap()
)
.build()
.unwrap()
.service_type(),
ServiceType::Compute
);
}
#[test]
fn test_response_key() {
assert_eq!(
Request::builder()
.flavor(
FlavorBuilder::default()
.disk("foo")
.name("foo")
.ram("foo")
.vcpus("foo")
.build()
.unwrap()
)
.build()
.unwrap()
.response_key()
.unwrap(),
"flavor"
);
}
#[cfg(feature = "sync")]
#[test]
fn endpoint() {
let client = MockServerClient::new();
let mock = client.server.mock(|when, then| {
when.method(httpmock::Method::POST)
.path("/flavors".to_string());
then.status(200)
.header("content-type", "application/json")
.json_body(json!({ "flavor": {} }));
});
let endpoint = Request::builder()
.flavor(
FlavorBuilder::default()
.disk("foo")
.name("foo")
.ram("foo")
.vcpus("foo")
.build()
.unwrap(),
)
.build()
.unwrap();
let _: serde_json::Value = endpoint.query(&client).unwrap();
mock.assert();
}
#[cfg(feature = "sync")]
#[test]
fn endpoint_headers() {
let client = MockServerClient::new();
let mock = client.server.mock(|when, then| {
when.method(httpmock::Method::POST)
.path("/flavors".to_string())
.header("foo", "bar")
.header("not_foo", "not_bar");
then.status(200)
.header("content-type", "application/json")
.json_body(json!({ "flavor": {} }));
});
let endpoint = Request::builder()
.flavor(
FlavorBuilder::default()
.disk("foo")
.name("foo")
.ram("foo")
.vcpus("foo")
.build()
.unwrap(),
)
.headers(
[(
Some(HeaderName::from_static("foo")),
HeaderValue::from_static("bar"),
)]
.into_iter(),
)
.header("not_foo", "not_bar")
.build()
.unwrap();
let _: serde_json::Value = endpoint.query(&client).unwrap();
mock.assert();
}
}