/*
* 3DS OUTSCALE API
*
* Welcome to the OUTSCALE API documentation.<br /> The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.<br /><br /> Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.<br /> Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.<br /><br /> Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/About-the-APIs.html) between AWS and the OUTSCALE API.<br /> You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.<br /><br /> An OpenAPI description of this API is also available for download: <button>[GitHub repository](https://github.com/outscale/osc-api)</button><br /> # Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.<br /> The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).<br /><br /> In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.<br /> > For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.<br /> For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). > If you try to sign requests with an invalid access key four times in a row, further authentication attempts will be prevented for 1 minute. This lockout time increases 1 minute every four failed attempts, for up to 10 minutes. ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.<br /> This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.<br /> In most cases, however, you can use the Cockpit web interface to retrieve them.<br /> > For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. > If you try to sign requests with an invalid password four times in a row, further authentication attempts will be prevented for 1 minute. This lockout time increases 1 minute every four failed attempts, for up to 10 minutes. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.<br /> ### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.<br /> For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). # Pagination Tutorial You can learn more about the pagination methods for read calls in the dedicated [pagination tutorial](https://docs.outscale.com/en/userguide/Tutorial-Paginating-an-API-Request.html). # Error Codes Reference You can learn more about errors returned by the API in the dedicated [errors page](api-errors.html).
*
* The version of the OpenAPI document: 1.36.3
* Contact: support@outscale.com
* Generated by: https://openapi-generator.tech
*/
/// Snapshot : Information about the snapshot.
#[derive(Clone, Debug, PartialEq, Default, Serialize, Deserialize)]
pub struct Snapshot {
/// The account alias of the owner of the snapshot.
#[serde(rename = "AccountAlias", skip_serializing_if = "Option::is_none")]
pub account_alias: Option<String>,
/// The account ID of the owner of the snapshot.
#[serde(rename = "AccountId", skip_serializing_if = "Option::is_none")]
pub account_id: Option<String>,
/// The idempotency token provided when creating the snapshot.
#[serde(rename = "ClientToken", skip_serializing_if = "Option::is_none")]
pub client_token: Option<String>,
/// The date and time (UTC) at which the snapshot was created.
#[serde(rename = "CreationDate", skip_serializing_if = "Option::is_none")]
pub creation_date: Option<String>,
/// The description of the snapshot.
#[serde(rename = "Description", skip_serializing_if = "Option::is_none")]
pub description: Option<String>,
#[serde(
rename = "PermissionsToCreateVolume",
skip_serializing_if = "Option::is_none"
)]
pub permissions_to_create_volume: Option<Box<crate::models::PermissionsOnResource>>,
/// The progress of the snapshot, as a percentage.
#[serde(rename = "Progress", skip_serializing_if = "Option::is_none")]
pub progress: Option<i32>,
/// The ID of the snapshot.
#[serde(rename = "SnapshotId", skip_serializing_if = "Option::is_none")]
pub snapshot_id: Option<String>,
/// The state of the snapshot (`in-queue` \\| `pending` \\| `completed` \\| `error` \\| `deleting`).
#[serde(rename = "State", skip_serializing_if = "Option::is_none")]
pub state: Option<String>,
/// One or more tags associated with the snapshot.
#[serde(rename = "Tags", skip_serializing_if = "Option::is_none")]
pub tags: Option<Vec<crate::models::ResourceTag>>,
/// The ID of the volume used to create the snapshot.
#[serde(rename = "VolumeId", skip_serializing_if = "Option::is_none")]
pub volume_id: Option<String>,
/// The size of the volume used to create the snapshot, in gibibytes (GiB).
#[serde(rename = "VolumeSize", skip_serializing_if = "Option::is_none")]
pub volume_size: Option<i32>,
}
impl Snapshot {
/// Information about the snapshot.
pub fn new() -> Snapshot {
Snapshot {
account_alias: None,
account_id: None,
client_token: None,
creation_date: None,
description: None,
permissions_to_create_volume: None,
progress: None,
snapshot_id: None,
state: None,
tags: None,
volume_id: None,
volume_size: None,
}
}
}