outscale_api/models/update_route_request.rs
1/*
2 * 3DS OUTSCALE API
3 *
4 * 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 the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).<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).
5 *
6 * The version of the OpenAPI document: 1.35.3
7 * Contact: support@outscale.com
8 * Generated by: https://openapi-generator.tech
9 */
10
11#[derive(Clone, Debug, PartialEq, Default, Serialize, Deserialize)]
12pub struct UpdateRouteRequest {
13 /// The IP range used for the destination match, in CIDR notation (for example, `10.0.0.0/24`).
14 #[serde(rename = "DestinationIpRange")]
15 pub destination_ip_range: String,
16 /// If true, checks whether you have the required permissions to perform the action.
17 #[serde(rename = "DryRun", skip_serializing_if = "Option::is_none")]
18 pub dry_run: Option<bool>,
19 /// The ID of an internet service or virtual gateway attached to your Net.
20 #[serde(rename = "GatewayId", skip_serializing_if = "Option::is_none")]
21 pub gateway_id: Option<String>,
22 /// The ID of a NAT service.
23 #[serde(rename = "NatServiceId", skip_serializing_if = "Option::is_none")]
24 pub nat_service_id: Option<String>,
25 /// The ID of a Net peering.
26 #[serde(rename = "NetPeeringId", skip_serializing_if = "Option::is_none")]
27 pub net_peering_id: Option<String>,
28 /// The ID of a network interface card (NIC).
29 #[serde(rename = "NicId", skip_serializing_if = "Option::is_none")]
30 pub nic_id: Option<String>,
31 /// The ID of the route table.
32 #[serde(rename = "RouteTableId")]
33 pub route_table_id: String,
34 /// The ID of a NAT VM in your Net.
35 #[serde(rename = "VmId", skip_serializing_if = "Option::is_none")]
36 pub vm_id: Option<String>,
37}
38
39impl UpdateRouteRequest {
40 pub fn new(destination_ip_range: String, route_table_id: String) -> UpdateRouteRequest {
41 UpdateRouteRequest {
42 destination_ip_range,
43 dry_run: None,
44 gateway_id: None,
45 nat_service_id: None,
46 net_peering_id: None,
47 nic_id: None,
48 route_table_id,
49 vm_id: None,
50 }
51 }
52}