openstack_cli_network/v2/vpn/vpnservice/
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//! List Vpnservices command
19//!
20//! Wraps invoking of the `v2.0/vpn/vpnservices` with `GET` method
21
22use clap::Args;
23use tracing::info;
24
25use openstack_cli_core::cli::CliArgs;
26use openstack_cli_core::error::OpenStackCliError;
27use openstack_cli_core::output::OutputProcessor;
28use openstack_sdk::AsyncOpenStack;
29
30use openstack_sdk::api::QueryAsync;
31use openstack_sdk::api::network::v2::vpn::vpnservice::list;
32use openstack_sdk::api::{Pagination, paged};
33use openstack_types::network::v2::vpn::vpnservice::response;
34
35/// Lists all VPN services.
36///
37/// The list might be empty.
38///
39/// Standard query parameters are supported on the URI. For more information,
40/// see [Filtering and Column Selection](#filtering).
41///
42/// Use the `fields` query parameter to control which fields are returned in
43/// the response body. For more information, see [Fields](#fields).
44///
45/// Pagination query parameters are supported if Neutron configuration supports
46/// it by overriding `allow_pagination=false`. For more information, see
47/// [Pagination](#pagination).
48///
49/// Sorting query parameters are supported if Neutron configuration supports it
50/// with `allow_sorting=true`. For more information, see [Sorting](#sorting).
51///
52/// Normal response codes: 200
53///
54/// Error response codes: 401, 403
55#[derive(Args)]
56#[command(about = "List VPN services")]
57pub struct VpnservicesCommand {
58    /// Request Query parameters
59    #[command(flatten)]
60    query: QueryParameters,
61
62    /// Path parameters
63    #[command(flatten)]
64    path: PathParameters,
65
66    /// Total limit of entities count to return. Use this when there are too many entries.
67    #[arg(long, default_value_t = 10000)]
68    max_items: usize,
69}
70
71/// Query parameters
72#[derive(Args)]
73struct QueryParameters {
74    /// Requests a page size of items. Returns a number of items up to a limit
75    /// value. Use the limit parameter to make an initial limited request and
76    /// use the ID of the last-seen item from the response as the marker
77    /// parameter value in a subsequent limited request.
78    #[arg(
79        help_heading = "Query parameters",
80        long("page-size"),
81        visible_alias("limit")
82    )]
83    limit: Option<u32>,
84
85    /// The ID of the last-seen item. Use the limit parameter to make an
86    /// initial limited request and use the ID of the last-seen item from the
87    /// response as the marker parameter value in a subsequent limited request.
88    #[arg(help_heading = "Query parameters", long)]
89    marker: Option<String>,
90
91    /// Reverse the page direction
92    #[arg(action=clap::ArgAction::Set, help_heading = "Query parameters", long)]
93    page_reverse: Option<bool>,
94
95    /// Sort direction. This is an optional feature and may be silently ignored
96    /// by the server.
97    #[arg(action=clap::ArgAction::Append, help_heading = "Query parameters", long)]
98    sort_dir: Option<Vec<String>>,
99
100    /// Sort results by the attribute. This is an optional feature and may be
101    /// silently ignored by the server.
102    #[arg(action=clap::ArgAction::Append, help_heading = "Query parameters", long)]
103    sort_key: Option<Vec<String>>,
104}
105
106/// Path parameters
107#[derive(Args)]
108struct PathParameters {}
109
110impl VpnservicesCommand {
111    /// Perform command action
112    pub async fn take_action<C: CliArgs>(
113        &self,
114        parsed_args: &C,
115        client: &mut AsyncOpenStack,
116    ) -> Result<(), OpenStackCliError> {
117        info!("List Vpnservices");
118
119        let op =
120            OutputProcessor::from_args(parsed_args, Some("network.vpn/vpnservice"), Some("list"));
121        op.validate_args(parsed_args)?;
122
123        let mut ep_builder = list::Request::builder();
124
125        // Set query parameters
126        if let Some(val) = &self.query.limit {
127            ep_builder.limit(*val);
128        }
129        if let Some(val) = &self.query.marker {
130            ep_builder.marker(val);
131        }
132        if let Some(val) = &self.query.page_reverse {
133            ep_builder.page_reverse(*val);
134        }
135        if let Some(val) = &self.query.sort_dir {
136            ep_builder.sort_dir(val.iter());
137        }
138        if let Some(val) = &self.query.sort_key {
139            ep_builder.sort_key(val.iter());
140        }
141
142        let ep = ep_builder
143            .build()
144            .map_err(|x| OpenStackCliError::EndpointBuild(x.to_string()))?;
145
146        let data: Vec<serde_json::Value> = paged(ep, Pagination::Limit(self.max_items))
147            .query_async(client)
148            .await?;
149
150        op.output_list::<response::list::VpnserviceResponse>(data.clone())?;
151        // Show command specific hints
152        op.show_command_hint()?;
153        Ok(())
154    }
155}
openstack_cli_network/v2/vpn/vpnservice/list.rs

openstack_cli_network/v2/vpn/vpnservice/
list.rs
