openstack_sdk/api/compute/v2/limit/
list.rs

1// Licensed under the Apache License, Version 2.0 (the "License");
2// you may not use this file except in compliance with the License.
3// You may obtain a copy of the License at
4//
5//     http://www.apache.org/licenses/LICENSE-2.0
6//
7// Unless required by applicable law or agreed to in writing, software
8// distributed under the License is distributed on an "AS IS" BASIS,
9// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
10// See the License for the specific language governing permissions and
11// limitations under the License.
12//
13// SPDX-License-Identifier: Apache-2.0
14//
15// WARNING: This file is automatically generated from OpenAPI schema using
16// `openstack-codegenerator`.
17
18//! Shows rate and absolute limits for the project.
19//!
20//! Normal response codes: 200
21//!
22//! Error response codes: unauthorized(401), forbidden(403)
23//!
24use derive_builder::Builder;
25use http::{HeaderMap, HeaderName, HeaderValue};
26
27use crate::api::rest_endpoint_prelude::*;
28
29use std::borrow::Cow;
30
31#[derive(Builder, Debug, Clone)]
32#[builder(setter(strip_option))]
33pub struct Request<'a> {
34    #[builder(default, setter(into))]
35    tenant_id: Option<Cow<'a, str>>,
36
37    #[builder(setter(name = "_headers"), default, private)]
38    _headers: Option<HeaderMap>,
39}
40impl<'a> Request<'a> {
41    /// Create a builder for the endpoint.
42    pub fn builder() -> RequestBuilder<'a> {
43        RequestBuilder::default()
44    }
45}
46
47impl RequestBuilder<'_> {
48    /// Add a single header to the Limit.
49    pub fn header(&mut self, header_name: &'static str, header_value: &'static str) -> &mut Self
50where {
51        self._headers
52            .get_or_insert(None)
53            .get_or_insert_with(HeaderMap::new)
54            .insert(header_name, HeaderValue::from_static(header_value));
55        self
56    }
57
58    /// Add multiple headers.
59    pub fn headers<I, T>(&mut self, iter: I) -> &mut Self
60    where
61        I: Iterator<Item = T>,
62        T: Into<(Option<HeaderName>, HeaderValue)>,
63    {
64        self._headers
65            .get_or_insert(None)
66            .get_or_insert_with(HeaderMap::new)
67            .extend(iter.map(Into::into));
68        self
69    }
70}
71
72impl RestEndpoint for Request<'_> {
73    fn method(&self) -> http::Method {
74        http::Method::GET
75    }
76
77    fn endpoint(&self) -> Cow<'static, str> {
78        "limits".to_string().into()
79    }
80
81    fn parameters(&self) -> QueryParams {
82        let mut params = QueryParams::default();
83        params.push_opt("tenant_id", self.tenant_id.as_ref());
84
85        params
86    }
87
88    fn service_type(&self) -> ServiceType {
89        ServiceType::Compute
90    }
91
92    fn response_key(&self) -> Option<Cow<'static, str>> {
93        Some("limits".into())
94    }
95
96    /// Returns headers to be set into the request
97    fn request_headers(&self) -> Option<&HeaderMap> {
98        self._headers.as_ref()
99    }
100
101    /// Returns required API version
102    fn api_version(&self) -> Option<ApiVersion> {
103        Some(ApiVersion::new(2, 1))
104    }
105}
106
107#[cfg(test)]
108mod tests {
109    use super::*;
110    #[cfg(feature = "sync")]
111    use crate::api::Query;
112    use crate::test::client::FakeOpenStackClient;
113    use crate::types::ServiceType;
114    use http::{HeaderName, HeaderValue};
115    use httpmock::MockServer;
116    use serde_json::json;
117
118    #[test]
119    fn test_service_type() {
120        assert_eq!(
121            Request::builder().build().unwrap().service_type(),
122            ServiceType::Compute
123        );
124    }
125
126    #[test]
127    fn test_response_key() {
128        assert_eq!(
129            Request::builder().build().unwrap().response_key().unwrap(),
130            "limits"
131        );
132    }
133
134    #[cfg(feature = "sync")]
135    #[test]
136    fn endpoint() {
137        let server = MockServer::start();
138        let client = FakeOpenStackClient::new(server.base_url());
139        let mock = server.mock(|when, then| {
140            when.method(httpmock::Method::GET)
141                .path("/limits".to_string());
142
143            then.status(200)
144                .header("content-type", "application/json")
145                .json_body(json!({ "limits": {} }));
146        });
147
148        let endpoint = Request::builder().build().unwrap();
149        let _: serde_json::Value = endpoint.query(&client).unwrap();
150        mock.assert();
151    }
152
153    #[cfg(feature = "sync")]
154    #[test]
155    fn endpoint_headers() {
156        let server = MockServer::start();
157        let client = FakeOpenStackClient::new(server.base_url());
158        let mock = server.mock(|when, then| {
159            when.method(httpmock::Method::GET)
160                .path("/limits".to_string())
161                .header("foo", "bar")
162                .header("not_foo", "not_bar");
163            then.status(200)
164                .header("content-type", "application/json")
165                .json_body(json!({ "limits": {} }));
166        });
167
168        let endpoint = Request::builder()
169            .headers(
170                [(
171                    Some(HeaderName::from_static("foo")),
172                    HeaderValue::from_static("bar"),
173                )]
174                .into_iter(),
175            )
176            .header("not_foo", "not_bar")
177            .build()
178            .unwrap();
179        let _: serde_json::Value = endpoint.query(&client).unwrap();
180        mock.assert();
181    }
182}
openstack_sdk/api/compute/v2/limit/list.rs

openstack_sdk/api/compute/v2/limit/
list.rs
