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

openstack_cli_network/v2/vpn/ikepolicy/
list.rs
