openstack_cli 0.13.5

// 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`.

//! Create ManageableSnapshot command
//!
//! Wraps invoking of the `v3/manageable_snapshots` with `POST` method

use clap::Args;
use eyre::{OptionExt, WrapErr};
use tracing::info;

use openstack_sdk::AsyncOpenStack;

use crate::Cli;
use crate::OpenStackCliError;
use crate::output::OutputProcessor;

use crate::common::parse_key_val;
use openstack_sdk::api::QueryAsync;
use openstack_sdk::api::block_storage::v3::manageable_snapshot::create;
use openstack_types::block_storage::v3::manageable_snapshot::response::create::ManageableSnapshotResponse;
use serde_json::Value;

/// Instruct Cinder to manage a storage snapshot object.
///
/// Manages an existing backend storage snapshot object (e.g. a Linux logical
/// volume or a SAN disk) by creating the Cinder objects required to manage it,
/// and possibly renaming the backend storage snapshot object (driver
/// dependent).
///
/// From an API perspective, this operation behaves very much like a snapshot
/// creation operation.
///
/// Required HTTP Body:
///
/// ```text
/// {
///   "snapshot":
///   {
///     "volume_id": "<Cinder volume already exists in volume backend>",
///     "ref":
///        "<Driver-specific reference to the existing storage object>"
///   }
/// }
/// ```
///
/// See the appropriate Cinder drivers' implementations of the manage_snapshot
/// method to find out the accepted format of 'ref'. For example,in LVM driver,
/// it will be the logic volume name of snapshot which you want to manage.
///
/// This API call will return with an error if any of the above elements are
/// missing from the request, or if the 'volume_id' element refers to a cinder
/// volume that could not be found.
///
/// The snapshot will later enter the error state if it is discovered that
/// 'ref' is bad.
///
/// Optional elements to 'snapshot' are:
///
/// ```text
/// name           A name for the new snapshot.
/// description    A description for the new snapshot.
/// metadata       Key/value pairs to be associated with the new snapshot.
/// ```
#[derive(Args)]
pub struct ManageableSnapshotCommand {
    /// Request Query parameters
    #[command(flatten)]
    query: QueryParameters,

    /// Path parameters
    #[command(flatten)]
    path: PathParameters,

    /// A `snapshot` object.
    #[command(flatten)]
    snapshot: Snapshot,
}

/// Query parameters
#[derive(Args)]
struct QueryParameters {}

/// Path parameters
#[derive(Args)]
struct PathParameters {}
/// Snapshot Body data
#[derive(Args, Clone)]
struct Snapshot {
    /// A description for the snapshot. Default is `None`.
    #[arg(help_heading = "Body parameters", long)]
    description: Option<String>,

    /// Set explicit NULL for the description
    #[arg(help_heading = "Body parameters", long, action = clap::ArgAction::SetTrue, conflicts_with = "description")]
    no_description: bool,

    /// One or more metadata key and value pairs for the snapshot.
    #[arg(help_heading = "Body parameters", long, value_name="key=value", value_parser=parse_key_val::<String, String>)]
    metadata: Option<Vec<(String, String)>>,

    /// The name of the snapshot. Default is `None`.
    #[arg(help_heading = "Body parameters", long)]
    name: Option<String>,

    /// Set explicit NULL for the name
    #[arg(help_heading = "Body parameters", long, action = clap::ArgAction::SetTrue, conflicts_with = "name")]
    no_name: bool,

    /// A reference to the existing volume. The internal structure of this
    /// reference depends on the volume driver implementation. For details
    /// about the required elements in the structure, see the documentation for
    /// the volume driver.
    #[arg(help_heading = "Body parameters", long, value_name="JSON", value_parser=crate::common::parse_json)]
    _ref: Option<Value>,

    /// The UUID of the volume.
    #[arg(help_heading = "Body parameters", long)]
    volume_id: String,
}

impl ManageableSnapshotCommand {
    /// Perform command action
    pub async fn take_action(
        &self,
        parsed_args: &Cli,
        client: &mut AsyncOpenStack,
    ) -> Result<(), OpenStackCliError> {
        info!("Create ManageableSnapshot");

        let op = OutputProcessor::from_args(
            parsed_args,
            Some("block-storage.manageable_snapshot"),
            Some("create"),
        );
        op.validate_args(parsed_args)?;

        let mut ep_builder = create::Request::builder();

        // Set body parameters
        // Set Request.snapshot data
        let args = &self.snapshot;
        let mut snapshot_builder = create::SnapshotBuilder::default();
        if let Some(val) = &args.description {
            snapshot_builder.description(Some(val.into()));
        } else if args.no_description {
            snapshot_builder.description(None);
        }

        if let Some(val) = &args.metadata {
            snapshot_builder.metadata(val.iter().cloned());
        }

        if let Some(val) = &args.name {
            snapshot_builder.name(Some(val.into()));
        } else if args.no_name {
            snapshot_builder.name(None);
        }

        if let Some(val) = &args._ref {
            snapshot_builder._ref(val.clone());
        }

        snapshot_builder.volume_id(&args.volume_id);

        ep_builder.snapshot(
            snapshot_builder
                .build()
                .wrap_err("error preparing the request data")?,
        );

        let ep = ep_builder
            .build()
            .map_err(|x| OpenStackCliError::EndpointBuild(x.to_string()))?;

        let data = ep.query_async(client).await?;
        op.output_single::<ManageableSnapshotResponse>(data)?;
        // Show command specific hints
        op.show_command_hint()?;
        Ok(())
    }
}