openstack_sdk_identity/v3/registered_limit/
head.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//! List registered limits.
19//!
20//! GET /v3/registered_limits
21//!
22use derive_builder::Builder;
23use http::{HeaderMap, HeaderName, HeaderValue};
24
25use openstack_sdk_core::api::rest_endpoint_prelude::*;
26
27use std::borrow::Cow;
28
29#[derive(Builder, Debug, Clone)]
30#[builder(setter(strip_option))]
31pub struct Request<'a> {
32    /// The ID of the region.
33    #[builder(default, setter(into))]
34    region_id: Option<Cow<'a, str>>,
35
36    /// The resource name.
37    #[builder(default, setter(into))]
38    resource_name: Option<Cow<'a, str>>,
39
40    /// Filters the response by a service ID.
41    #[builder(default, setter(into))]
42    service_id: Option<Cow<'a, str>>,
43
44    #[builder(setter(name = "_headers"), default, private)]
45    _headers: Option<HeaderMap>,
46}
47impl<'a> Request<'a> {
48    /// Create a builder for the endpoint.
49    pub fn builder() -> RequestBuilder<'a> {
50        RequestBuilder::default()
51    }
52}
53
54impl<'a> RequestBuilder<'a> {
55    /// Add a single header to the Registered_Limit.
56    pub fn header<K, V>(&mut self, header_name: K, header_value: V) -> &mut Self
57    where
58        K: Into<HeaderName>,
59        V: Into<HeaderValue>,
60    {
61        self._headers
62            .get_or_insert(None)
63            .get_or_insert_with(HeaderMap::new)
64            .insert(header_name.into(), header_value.into());
65        self
66    }
67
68    /// Add multiple headers.
69    pub fn headers<I, T>(&mut self, iter: I) -> &mut Self
70    where
71        I: Iterator<Item = T>,
72        T: Into<(Option<HeaderName>, HeaderValue)>,
73    {
74        self._headers
75            .get_or_insert(None)
76            .get_or_insert_with(HeaderMap::new)
77            .extend(iter.map(Into::into));
78        self
79    }
80}
81
82impl RestEndpoint for Request<'_> {
83    fn method(&self) -> http::Method {
84        http::Method::HEAD
85    }
86
87    fn endpoint(&self) -> Cow<'static, str> {
88        "registered_limits".to_string().into()
89    }
90
91    fn parameters(&self) -> QueryParams<'_> {
92        let mut params = QueryParams::default();
93        params.push_opt("region_id", self.region_id.as_ref());
94        params.push_opt("resource_name", self.resource_name.as_ref());
95        params.push_opt("service_id", self.service_id.as_ref());
96
97        params
98    }
99
100    fn service_type(&self) -> ServiceType {
101        ServiceType::Identity
102    }
103
104    fn response_key(&self) -> Option<Cow<'static, str>> {
105        None
106    }
107
108    /// Returns headers to be set into the request
109    fn request_headers(&self) -> Option<&HeaderMap> {
110        self._headers.as_ref()
111    }
112
113    /// Returns required API version
114    fn api_version(&self) -> Option<ApiVersion> {
115        Some(ApiVersion::new(3, 0))
116    }
117}
118
119#[cfg(test)]
120mod tests {
121    use super::*;
122    use http::{HeaderName, HeaderValue};
123    use httpmock::MockServer;
124    #[cfg(feature = "sync")]
125    use openstack_sdk_core::api::RawQuery;
126    use openstack_sdk_core::test::client::FakeOpenStackClient;
127    use openstack_sdk_core::types::ServiceType;
128
129    #[test]
130    fn test_service_type() {
131        assert_eq!(
132            Request::builder().build().unwrap().service_type(),
133            ServiceType::Identity
134        );
135    }
136
137    #[test]
138    fn test_response_key() {
139        assert!(Request::builder().build().unwrap().response_key().is_none())
140    }
141
142    #[cfg(feature = "sync")]
143    #[test]
144    fn endpoint() {
145        let server = MockServer::start();
146        let client = FakeOpenStackClient::new(server.base_url());
147        let mock = server.mock(|when, then| {
148            when.method(httpmock::Method::HEAD)
149                .path("/registered_limits".to_string());
150
151            then.status(200).header("content-type", "application/json");
152        });
153
154        let endpoint = Request::builder().build().unwrap();
155        let _ = endpoint.raw_query(&client).unwrap();
156        mock.assert();
157    }
158
159    #[cfg(feature = "sync")]
160    #[test]
161    fn endpoint_headers() {
162        let server = MockServer::start();
163        let client = FakeOpenStackClient::new(server.base_url());
164        let mock = server.mock(|when, then| {
165            when.method(httpmock::Method::HEAD)
166                .path("/registered_limits".to_string())
167                .header("foo", "bar")
168                .header("not_foo", "not_bar");
169            then.status(200).header("content-type", "application/json");
170        });
171
172        let endpoint = Request::builder()
173            .headers(
174                [(
175                    Some(HeaderName::from_static("foo")),
176                    HeaderValue::from_static("bar"),
177                )]
178                .into_iter(),
179            )
180            .header(
181                HeaderName::from_static("not_foo"),
182                HeaderValue::from_static("not_bar"),
183            )
184            .build()
185            .unwrap();
186        let _ = endpoint.raw_query(&client).unwrap();
187        mock.assert();
188    }
189}
openstack_sdk_identity/v3/registered_limit/head.rs

openstack_sdk_identity/v3/registered_limit/
head.rs
