1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
// SPDX-License-Identifier: Apache-2.0
//
// WARNING: This file is automatically generated from OpenAPI schema using
// `openstack-codegenerator`.
//! List Volumes command
//!
//! Wraps invoking of the `v3/volumes/detail` with `GET` method
use clap::Args;
use tracing::info;
use openstack_sdk::AsyncOpenStack;
use crate::Cli;
use crate::OpenStackCliError;
use crate::output::OutputProcessor;
use openstack_sdk::api::QueryAsync;
use openstack_sdk::api::block_storage::v3::volume::list_detailed;
use openstack_sdk::api::{Pagination, paged};
use openstack_types::block_storage::v3::volume::response::list_detailed::VolumeResponse;
/// Returns a detailed list of volumes.
#[derive(Args)]
pub struct VolumesCommand {
/// Request Query parameters
#[command(flatten)]
query: QueryParameters,
/// Path parameters
#[command(flatten)]
path: PathParameters,
/// Total limit of entities count to return. Use this when there are too many entries.
#[arg(long, default_value_t = 10000)]
max_items: usize,
}
/// Query parameters
#[derive(Args)]
struct QueryParameters {
/// Shows details for all project. Admin only.
#[arg(action=clap::ArgAction::Set, help_heading = "Query parameters", long)]
all_tenants: Option<bool>,
/// Filters results by consumes_quota field. Resources that don’t use
/// quotas are usually temporary internal resources created to perform an
/// operation. Default is to not filter by it. Filtering by this option may
/// not be always possible in a cloud, see List Resource Filters to
/// determine whether this filter is available in your cloud.
#[arg(action=clap::ArgAction::Set, help_heading = "Query parameters", long)]
consumes_quota: Option<bool>,
/// Filters results by a time that resources are created at with time
/// comparison operators: gt/gte/eq/neq/lt/lte.
#[arg(help_heading = "Query parameters", long)]
created_at: Option<String>,
/// Requests a page size of items. Returns a number of items up to a limit
/// value. Use the limit parameter to make an initial limited request and
/// use the ID of the last-seen item from the response as the marker
/// parameter value in a subsequent limited request.
#[arg(
help_heading = "Query parameters",
long("page-size"),
visible_alias("limit")
)]
limit: Option<i32>,
/// The ID of the last-seen item. Use the limit parameter to make an
/// initial limited request and use the ID of the last-seen item from the
/// response as the marker parameter value in a subsequent limited request.
#[arg(help_heading = "Query parameters", long)]
marker: Option<String>,
/// Used in conjunction with limit to return a slice of items. offset is
/// where to start in the list.
#[arg(help_heading = "Query parameters", long)]
offset: Option<i32>,
/// Comma-separated list of sort keys and optional sort directions in the
/// form of < key > [: < direction > ]. A valid direction is asc
/// (ascending) or desc (descending).
#[arg(help_heading = "Query parameters", long)]
sort: Option<String>,
/// Sorts by one or more sets of attribute and sort direction combinations.
/// If you omit the sort direction in a set, default is desc. Deprecated in
/// favour of the combined sort parameter.
#[arg(help_heading = "Query parameters", long, value_parser = ["asc","desc"])]
sort_dir: Option<String>,
/// Sorts by an attribute. A valid value is name, status, container_format,
/// disk_format, size, id, created_at, or updated_at. Default is
/// created_at. The API uses the natural sorting direction of the sort_key
/// attribute value. Deprecated in favour of the combined sort parameter.
#[arg(help_heading = "Query parameters", long)]
sort_key: Option<String>,
/// Filters results by a time that resources are updated at with time
/// comparison operators: gt/gte/eq/neq/lt/lte.
#[arg(help_heading = "Query parameters", long)]
updated_at: Option<String>,
/// Whether to show count in API response or not, default is False.
#[arg(action=clap::ArgAction::Set, help_heading = "Query parameters", long)]
with_count: Option<bool>,
}
/// Path parameters
#[derive(Args)]
struct PathParameters {}
impl VolumesCommand {
/// Perform command action
pub async fn take_action(
&self,
parsed_args: &Cli,
client: &mut AsyncOpenStack,
) -> Result<(), OpenStackCliError> {
info!("List Volumes");
let op =
OutputProcessor::from_args(parsed_args, Some("block-storage.volume"), Some("list"));
op.validate_args(parsed_args)?;
let mut ep_builder = list_detailed::Request::builder();
// Set query parameters
if let Some(val) = &self.query.all_tenants {
ep_builder.all_tenants(*val);
}
if let Some(val) = &self.query.consumes_quota {
ep_builder.consumes_quota(*val);
}
if let Some(val) = &self.query.created_at {
ep_builder.created_at(val);
}
if let Some(val) = &self.query.limit {
ep_builder.limit(*val);
}
if let Some(val) = &self.query.marker {
ep_builder.marker(val);
}
if let Some(val) = &self.query.offset {
ep_builder.offset(*val);
}
if let Some(val) = &self.query.sort {
ep_builder.sort(val);
}
if let Some(val) = &self.query.sort_dir {
ep_builder.sort_dir(val);
}
if let Some(val) = &self.query.sort_key {
ep_builder.sort_key(val);
}
if let Some(val) = &self.query.updated_at {
ep_builder.updated_at(val);
}
if let Some(val) = &self.query.with_count {
ep_builder.with_count(*val);
}
let ep = ep_builder
.build()
.map_err(|x| OpenStackCliError::EndpointBuild(x.to_string()))?;
let data: Vec<serde_json::Value> = paged(ep, Pagination::Limit(self.max_items))
.query_async(client)
.await?;
op.output_list::<VolumeResponse>(data)?;
// Show command specific hints
op.show_command_hint()?;
Ok(())
}
}