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
// 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`.
//! Update an existing pool.
//!
//! If the request is valid, the service returns the `Accepted (202)` response
//! code. To confirm the update, check that the pool provisioning status is
//! `ACTIVE`. If the status is `PENDING_UPDATE`, use a GET operation to poll
//! the pool object for changes.
//!
//! This operation returns the updated pool object with the `ACTIVE`,
//! `PENDING_UPDATE`, or `ERROR` provisioning status.
//!
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;
#[derive(Debug, Deserialize, Clone, Serialize)]
pub enum LbAlgorithm {
#[serde(rename = "LEAST_CONNECTIONS")]
LeastConnections,
#[serde(rename = "ROUND_ROBIN")]
RoundRobin,
#[serde(rename = "SOURCE_IP")]
SourceIp,
#[serde(rename = "SOURCE_IP_PORT")]
SourceIpPort,
}
#[derive(Debug, Deserialize, Clone, Serialize)]
pub enum Type {
#[serde(rename = "APP_COOKIE")]
AppCookie,
#[serde(rename = "HTTP_COOKIE")]
HttpCookie,
#[serde(rename = "SOURCE_IP")]
SourceIp,
}
/// A JSON object specifying the session persistence for the pool or `null` for
/// no session persistence. See
/// [Pool Session Persistence](#session-persistence). Default is `null`.
///
#[derive(Builder, Debug, Deserialize, Clone, Serialize)]
#[builder(setter(strip_option))]
pub struct SessionPersistence<'a> {
#[serde(skip_serializing_if = "Option::is_none")]
#[builder(default, setter(into))]
pub(crate) cookie_name: Option<Cow<'a, str>>,
#[serde(skip_serializing_if = "Option::is_none")]
#[builder(default, setter(into))]
pub(crate) persistence_granularity: Option<Cow<'a, str>>,
#[serde(skip_serializing_if = "Option::is_none")]
#[builder(default)]
pub(crate) persistence_timeout: Option<i32>,
#[serde(rename = "type", skip_serializing_if = "Option::is_none")]
#[builder(default)]
pub(crate) _type: Option<Type>,
}
/// Defines attributes that are acceptable of a PUT request.
///
#[derive(Builder, Debug, Deserialize, Clone, Serialize)]
#[builder(setter(strip_option))]
pub struct Pool<'a> {
/// The administrative state of the resource, which is up (`true`) or down
/// (`false`). Default is `true`.
///
#[serde(skip_serializing_if = "Option::is_none")]
#[builder(default)]
pub(crate) admin_state_up: Option<bool>,
/// A list of ALPN protocols. Available protocols: http/1.0, http/1.1, h2
///
/// **New in version 2.24**
///
#[serde(skip_serializing_if = "Option::is_none")]
#[builder(default, setter(into))]
pub(crate) alpn_protocols: Option<Vec<Cow<'a, str>>>,
/// The reference of the
/// [key manager service](https://docs.openstack.org/castellan/latest/)
/// secret containing a PEM format CA certificate bundle for `tls_enabled`
/// pools.
///
/// **New in version 2.8**
///
#[serde(skip_serializing_if = "Option::is_none")]
#[builder(default, setter(into))]
pub(crate) ca_tls_container_ref: Option<Cow<'a, str>>,
/// The reference of the
/// [key manager service](https://docs.openstack.org/castellan/latest/)
/// secret containing a PEM format CA revocation list file for
/// `tls_enabled` pools.
///
#[serde(skip_serializing_if = "Option::is_none")]
#[builder(default, setter(into))]
pub(crate) crl_container_ref: Option<Cow<'a, str>>,
/// A human-readable description for the resource.
///
#[serde(skip_serializing_if = "Option::is_none")]
#[builder(default, setter(into))]
pub(crate) description: Option<Cow<'a, str>>,
/// The load balancing algorithm for the pool. One of `LEAST_CONNECTIONS`,
/// `ROUND_ROBIN`, or `SOURCE_IP`.
///
#[serde(skip_serializing_if = "Option::is_none")]
#[builder(default)]
pub(crate) lb_algorithm: Option<LbAlgorithm>,
/// Human-readable name of the resource.
///
#[serde(skip_serializing_if = "Option::is_none")]
#[builder(default, setter(into))]
pub(crate) name: Option<Cow<'a, str>>,
/// A JSON object specifying the session persistence for the pool or `null`
/// for no session persistence. See
/// [Pool Session Persistence](#session-persistence). Default is `null`.
///
#[serde(skip_serializing_if = "Option::is_none")]
#[builder(default, setter(into))]
pub(crate) session_persistence: Option<SessionPersistence<'a>>,
/// A list of simple strings assigned to the resource.
///
/// **New in version 2.5**
///
#[serde(skip_serializing_if = "Option::is_none")]
#[builder(default, setter(into))]
pub(crate) tags: Option<Vec<Cow<'a, str>>>,
/// List of ciphers in OpenSSL format (colon-separated). See
/// <https://www.openssl.org/docs/man1.1.1/man1/ciphers.html>
///
/// **New in version 2.15**
///
#[serde(skip_serializing_if = "Option::is_none")]
#[builder(default, setter(into))]
pub(crate) tls_ciphers: Option<Cow<'a, str>>,
/// The reference to the
/// [key manager service](https://docs.openstack.org/castellan/latest/)
/// secret containing a PKCS12 format certificate/key bundle for
/// `tls_enabled` pools for TLS client authentication to the member
/// servers.
///
/// **New in version 2.8**
///
#[serde(skip_serializing_if = "Option::is_none")]
#[builder(default, setter(into))]
pub(crate) tls_container_ref: Option<Cow<'a, str>>,
/// When `true` connections to backend member servers will use TLS
/// encryption. Default is `false`.
///
/// **New in version 2.8**
///
#[serde(skip_serializing_if = "Option::is_none")]
#[builder(default)]
pub(crate) tls_enabled: Option<bool>,
/// A list of TLS protocol versions. Available versions: SSLv3, TLSv1,
/// TLSv1.1, TLSv1.2, TLSv1.3
///
/// **New in version 2.17**
///
#[serde(skip_serializing_if = "Option::is_none")]
#[builder(default, setter(into))]
pub(crate) tls_versions: Option<Vec<Cow<'a, str>>>,
}
#[derive(Builder, Debug, Clone)]
#[builder(setter(strip_option))]
pub struct Request<'a> {
/// Defines attributes that are acceptable of a PUT request.
///
#[builder(setter(into))]
pub(crate) pool: Pool<'a>,
/// pool_id parameter for /v2/lbaas/pools/{pool_id} API
///
#[builder(default, setter(into))]
id: Cow<'a, str>,
#[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 Pool.
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::PUT
}
fn endpoint(&self) -> Cow<'static, str> {
format!("lbaas/pools/{id}", id = self.id.as_ref(),).into()
}
fn parameters(&self) -> QueryParams {
QueryParams::default()
}
fn body(&self) -> Result<Option<(&'static str, Vec<u8>)>, BodyError> {
let mut params = JsonBodyParams::default();
params.push("pool", serde_json::to_value(&self.pool)?);
params.into_body()
}
fn service_type(&self) -> ServiceType {
ServiceType::LoadBalancer
}
fn response_key(&self) -> Option<Cow<'static, str>> {
Some("pool".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, 0))
}
}
#[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()
.pool(PoolBuilder::default().build().unwrap())
.build()
.unwrap()
.service_type(),
ServiceType::LoadBalancer
);
}
#[test]
fn test_response_key() {
assert_eq!(
Request::builder()
.pool(PoolBuilder::default().build().unwrap())
.build()
.unwrap()
.response_key()
.unwrap(),
"pool"
);
}
#[cfg(feature = "sync")]
#[test]
fn endpoint() {
let client = MockServerClient::new();
let mock = client.server.mock(|when, then| {
when.method(httpmock::Method::PUT)
.path(format!("/lbaas/pools/{id}", id = "id",));
then.status(200)
.header("content-type", "application/json")
.json_body(json!({ "pool": {} }));
});
let endpoint = Request::builder()
.id("id")
.pool(PoolBuilder::default().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::PUT)
.path(format!("/lbaas/pools/{id}", id = "id",))
.header("foo", "bar")
.header("not_foo", "not_bar");
then.status(200)
.header("content-type", "application/json")
.json_body(json!({ "pool": {} }));
});
let endpoint = Request::builder()
.id("id")
.pool(PoolBuilder::default().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();
}
}