openstack_cli_network/v2/rbac_policy/
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 RbacPolicies command
19//!
20//! Wraps invoking of the `v2.0/rbac-policies` 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::rbac_policy::list;
32use openstack_sdk::api::{Pagination, paged};
33use openstack_types::network::v2::rbac_policy::response;
34
35/// List RBAC policies that belong to a given tenant.
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 RBAC policies")]
55pub struct RbacPoliciesCommand {
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    /// action query parameter for /v2.0/rbac-policies API
73    #[arg(help_heading = "Query parameters", long)]
74    action: Option<String>,
75
76    /// id query parameter for /v2.0/rbac-policies 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    /// object_id query parameter for /v2.0/rbac-policies API
98    #[arg(help_heading = "Query parameters", long)]
99    object_id: Option<String>,
100
101    /// object_type query parameter for /v2.0/rbac-policies API
102    #[arg(help_heading = "Query parameters", long)]
103    object_type: Option<String>,
104
105    /// Reverse the page direction
106    #[arg(action=clap::ArgAction::Set, help_heading = "Query parameters", long)]
107    page_reverse: Option<bool>,
108
109    /// Sort direction. This is an optional feature and may be silently ignored
110    /// by the server.
111    #[arg(action=clap::ArgAction::Append, help_heading = "Query parameters", long)]
112    sort_dir: Option<Vec<String>>,
113
114    /// Sort results by the attribute. This is an optional feature and may be
115    /// silently ignored by the server.
116    #[arg(action=clap::ArgAction::Append, help_heading = "Query parameters", long)]
117    sort_key: Option<Vec<String>>,
118
119    /// target_tenant query parameter for /v2.0/rbac-policies API
120    #[arg(help_heading = "Query parameters", long)]
121    target_tenant: Option<String>,
122
123    /// tenant_id query parameter for /v2.0/rbac-policies API
124    #[arg(help_heading = "Query parameters", long)]
125    tenant_id: Option<String>,
126}
127
128/// Path parameters
129#[derive(Args)]
130struct PathParameters {}
131
132impl RbacPoliciesCommand {
133    /// Perform command action
134    pub async fn take_action<C: CliArgs>(
135        &self,
136        parsed_args: &C,
137        client: &mut AsyncOpenStack,
138    ) -> Result<(), OpenStackCliError> {
139        info!("List RbacPolicies");
140
141        let op = OutputProcessor::from_args(parsed_args, Some("network.rbac_policy"), Some("list"));
142        op.validate_args(parsed_args)?;
143
144        let mut ep_builder = list::Request::builder();
145
146        // Set query parameters
147        if let Some(val) = &self.query.limit {
148            ep_builder.limit(*val);
149        }
150        if let Some(val) = &self.query.marker {
151            ep_builder.marker(val);
152        }
153        if let Some(val) = &self.query.page_reverse {
154            ep_builder.page_reverse(*val);
155        }
156        if let Some(val) = &self.query.action {
157            ep_builder.action(val);
158        }
159        if let Some(val) = &self.query.id {
160            ep_builder.id(val);
161        }
162        if let Some(val) = &self.query.object_id {
163            ep_builder.object_id(val);
164        }
165        if let Some(val) = &self.query.object_type {
166            ep_builder.object_type(val);
167        }
168        if let Some(val) = &self.query.target_tenant {
169            ep_builder.target_tenant(val);
170        }
171        if let Some(val) = &self.query.tenant_id {
172            ep_builder.tenant_id(val);
173        }
174        if let Some(val) = &self.query.sort_dir {
175            ep_builder.sort_dir(val.iter());
176        }
177        if let Some(val) = &self.query.sort_key {
178            ep_builder.sort_key(val.iter());
179        }
180
181        let ep = ep_builder
182            .build()
183            .map_err(|x| OpenStackCliError::EndpointBuild(x.to_string()))?;
184
185        let data: Vec<serde_json::Value> = paged(ep, Pagination::Limit(self.max_items))
186            .query_async(client)
187            .await?;
188
189        op.output_list::<response::list::RbacPolicyResponse>(data.clone())?;
190        // Show command specific hints
191        op.show_command_hint()?;
192        Ok(())
193    }
194}
openstack_cli_network/v2/rbac_policy/list.rs

openstack_cli_network/v2/rbac_policy/
list.rs
