openstack_cli_network/v2/segment/
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 Segments command
19//!
20//! Wraps invoking of the `v2.0/segments` 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::segment::list;
32use openstack_sdk::api::{Pagination, paged};
33use openstack_types::network::v2::segment::response;
34
35/// Lists segments to which the project has access.
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
53#[derive(Args)]
54#[command(about = "List segments")]
55pub struct SegmentsCommand {
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    /// description query parameter for /v2.0/segments API
73    #[arg(help_heading = "Query parameters", long)]
74    description: Option<String>,
75
76    /// id query parameter for /v2.0/segments API
77    #[arg(help_heading = "Query parameters", long)]
78    id: Option<String>,
79
80    /// Requests a page size of items. Returns a number of items up to a limit
81    /// value. Use the limit parameter to make an initial limited request and
82    /// use the ID of the last-seen item from the response as the marker
83    /// parameter value in a subsequent limited request.
84    #[arg(
85        help_heading = "Query parameters",
86        long("page-size"),
87        visible_alias("limit")
88    )]
89    limit: Option<u32>,
90
91    /// The ID of the last-seen item. Use the limit parameter to make an
92    /// initial limited request and use the ID of the last-seen item from the
93    /// response as the marker parameter value in a subsequent limited request.
94    #[arg(help_heading = "Query parameters", long)]
95    marker: Option<String>,
96
97    /// name query parameter for /v2.0/segments API
98    #[arg(help_heading = "Query parameters", long)]
99    name: Option<String>,
100
101    /// network_id query parameter for /v2.0/segments API
102    #[arg(help_heading = "Query parameters", long)]
103    network_id: Option<String>,
104
105    /// network_type query parameter for /v2.0/segments API
106    #[arg(help_heading = "Query parameters", long)]
107    network_type: Option<String>,
108
109    /// Reverse the page direction
110    #[arg(action=clap::ArgAction::Set, help_heading = "Query parameters", long)]
111    page_reverse: Option<bool>,
112
113    /// physical_network query parameter for /v2.0/segments API
114    #[arg(help_heading = "Query parameters", long)]
115    physical_network: Option<String>,
116
117    /// revision_number query parameter for /v2.0/segments API
118    #[arg(help_heading = "Query parameters", long)]
119    revision_number: Option<String>,
120
121    /// Sort direction. This is an optional feature and may be silently ignored
122    /// by the server.
123    #[arg(action=clap::ArgAction::Append, help_heading = "Query parameters", long)]
124    sort_dir: Option<Vec<String>>,
125
126    /// Sort results by the attribute. This is an optional feature and may be
127    /// silently ignored by the server.
128    #[arg(action=clap::ArgAction::Append, help_heading = "Query parameters", long)]
129    sort_key: Option<Vec<String>>,
130}
131
132/// Path parameters
133#[derive(Args)]
134struct PathParameters {}
135
136impl SegmentsCommand {
137    /// Perform command action
138    pub async fn take_action<C: CliArgs>(
139        &self,
140        parsed_args: &C,
141        client: &mut AsyncOpenStack,
142    ) -> Result<(), OpenStackCliError> {
143        info!("List Segments");
144
145        let op = OutputProcessor::from_args(parsed_args, Some("network.segment"), Some("list"));
146        op.validate_args(parsed_args)?;
147
148        let mut ep_builder = list::Request::builder();
149
150        // Set query parameters
151        if let Some(val) = &self.query.limit {
152            ep_builder.limit(*val);
153        }
154        if let Some(val) = &self.query.marker {
155            ep_builder.marker(val);
156        }
157        if let Some(val) = &self.query.page_reverse {
158            ep_builder.page_reverse(*val);
159        }
160        if let Some(val) = &self.query.description {
161            ep_builder.description(val);
162        }
163        if let Some(val) = &self.query.id {
164            ep_builder.id(val);
165        }
166        if let Some(val) = &self.query.name {
167            ep_builder.name(val);
168        }
169        if let Some(val) = &self.query.network_id {
170            ep_builder.network_id(val);
171        }
172        if let Some(val) = &self.query.network_type {
173            ep_builder.network_type(val);
174        }
175        if let Some(val) = &self.query.physical_network {
176            ep_builder.physical_network(val);
177        }
178        if let Some(val) = &self.query.revision_number {
179            ep_builder.revision_number(val);
180        }
181        if let Some(val) = &self.query.sort_dir {
182            ep_builder.sort_dir(val.iter());
183        }
184        if let Some(val) = &self.query.sort_key {
185            ep_builder.sort_key(val.iter());
186        }
187
188        let ep = ep_builder
189            .build()
190            .map_err(|x| OpenStackCliError::EndpointBuild(x.to_string()))?;
191
192        let data: Vec<serde_json::Value> = paged(ep, Pagination::Limit(self.max_items))
193            .query_async(client)
194            .await?;
195
196        op.output_list::<response::list::SegmentResponse>(data.clone())?;
197        // Show command specific hints
198        op.show_command_hint()?;
199        Ok(())
200    }
201}
openstack_cli_network/v2/segment/list.rs

openstack_cli_network/v2/segment/
list.rs
