2022-07-03 02:09:38 +00:00
#[allow(unused_imports)]
2022-07-08 01:35:36 +00:00
use progenitor_client::{encode_path, RequestBuilderExt};
2022-03-15 23:11:47 +00:00
pub use progenitor_client::{ByteStream, Error, ResponseValue};
2023-01-04 19:14:37 +00:00
#[allow(unused_imports)]
use reqwest::header::{HeaderMap, HeaderValue};
2021-12-10 02:15:24 +00:00
pub mod types {
use serde::{Deserialize, Serialize};
2022-07-18 18:55:21 +00:00
#[allow(unused_imports)]
use std::convert::TryFrom;
2023-02-01 05:28:12 +00:00
///Describes properties that should uniquely identify a Gimlet.
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "Describes properties that should uniquely identify a
/// Gimlet.", "type": "object",
/// "required": [
/// "part",
/// "revision",
/// "serial"
/// ],
/// "properties": {
/// "part": {
/// "type": "string"
/// },
/// "revision": {
/// "type": "integer",
/// "format": "int64"
/// },
/// "serial": {
/// "type": "string"
/// }
/// }
///}
/// ```
/// </details>
2023-02-01 05:28:12 +00:00
#[derive(Clone, Debug, Deserialize, Serialize)]
pub struct Baseboard {
pub part: String,
pub revision: i64,
pub serial: String,
}
2023-02-05 01:22:55 +00:00
impl From<&Baseboard> for Baseboard {
fn from(value: &Baseboard) -> Self {
value.clone()
}
}
2022-07-27 04:23:01 +00:00
///A type storing a range over `T`.
///
///This type supports ranges similar to the `RangeTo`, `Range` and
/// `RangeFrom` types in the standard library. Those cover `(..end)`,
/// `(start..end)`, and `(start..)` respectively.
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "A type storing a range over `T`.\n\nThis type supports
/// ranges similar to the `RangeTo`, `Range` and `RangeFrom` types in the
/// standard library. Those cover `(..end)`, `(start..end)`, and `(start..)`
/// respectively.", "oneOf": [
/// {
/// "description": "A range unbounded below and exclusively above,
/// `..end`.", "type": "object",
/// "required": [
/// "end",
/// "type"
/// ],
/// "properties": {
/// "end": {
/// "type": "number",
/// "format": "double"
/// },
/// "type": {
/// "type": "string",
/// "enum": [
/// "range_to"
/// ]
/// }
/// }
/// },
/// {
/// "description": "A range bounded inclusively below and exclusively
/// above, `start..end`.", "type": "object",
/// "required": [
/// "end",
/// "start",
/// "type"
/// ],
/// "properties": {
/// "end": {
/// "type": "number",
/// "format": "double"
/// },
/// "start": {
/// "type": "number",
/// "format": "double"
/// },
/// "type": {
/// "type": "string",
/// "enum": [
/// "range"
/// ]
/// }
/// }
/// },
/// {
/// "description": "A range bounded inclusively below and unbounded
/// above, `start..`.", "type": "object",
/// "required": [
/// "start",
/// "type"
/// ],
/// "properties": {
/// "start": {
/// "type": "number",
/// "format": "double"
/// },
/// "type": {
/// "type": "string",
/// "enum": [
/// "range_from"
/// ]
/// }
/// }
/// }
/// ]
///}
/// ```
/// </details>
2022-07-27 04:23:01 +00:00
#[derive(Clone, Debug, Deserialize, Serialize)]
#[serde(tag = "type")]
pub enum BinRangedouble {
///A range unbounded below and exclusively above, `..end`.
#[serde(rename = "range_to")]
RangeTo { end: f64 },
///A range bounded inclusively below and exclusively above,
/// `start..end`.
#[serde(rename = "range")]
Range { end: f64, start: f64 },
///A range bounded inclusively below and unbounded above, `start..`.
#[serde(rename = "range_from")]
RangeFrom { start: f64 },
}
2023-02-05 01:22:55 +00:00
impl From<&BinRangedouble> for BinRangedouble {
fn from(value: &BinRangedouble) -> Self {
value.clone()
}
}
2022-07-27 04:23:01 +00:00
///A type storing a range over `T`.
///
///This type supports ranges similar to the `RangeTo`, `Range` and
/// `RangeFrom` types in the standard library. Those cover `(..end)`,
/// `(start..end)`, and `(start..)` respectively.
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "A type storing a range over `T`.\n\nThis type supports
/// ranges similar to the `RangeTo`, `Range` and `RangeFrom` types in the
/// standard library. Those cover `(..end)`, `(start..end)`, and `(start..)`
/// respectively.", "oneOf": [
/// {
/// "description": "A range unbounded below and exclusively above,
/// `..end`.", "type": "object",
/// "required": [
/// "end",
/// "type"
/// ],
/// "properties": {
/// "end": {
/// "type": "integer",
/// "format": "int64"
/// },
/// "type": {
/// "type": "string",
/// "enum": [
/// "range_to"
/// ]
/// }
/// }
/// },
/// {
/// "description": "A range bounded inclusively below and exclusively
/// above, `start..end`.", "type": "object",
/// "required": [
/// "end",
/// "start",
/// "type"
/// ],
/// "properties": {
/// "end": {
/// "type": "integer",
/// "format": "int64"
/// },
/// "start": {
/// "type": "integer",
/// "format": "int64"
/// },
/// "type": {
/// "type": "string",
/// "enum": [
/// "range"
/// ]
/// }
/// }
/// },
/// {
/// "description": "A range bounded inclusively below and unbounded
/// above, `start..`.", "type": "object",
/// "required": [
/// "start",
/// "type"
/// ],
/// "properties": {
/// "start": {
/// "type": "integer",
/// "format": "int64"
/// },
/// "type": {
/// "type": "string",
/// "enum": [
/// "range_from"
/// ]
/// }
/// }
/// }
/// ]
///}
/// ```
/// </details>
2022-07-27 04:23:01 +00:00
#[derive(Clone, Debug, Deserialize, Serialize)]
#[serde(tag = "type")]
pub enum BinRangeint64 {
///A range unbounded below and exclusively above, `..end`.
#[serde(rename = "range_to")]
RangeTo { end: i64 },
///A range bounded inclusively below and exclusively above,
/// `start..end`.
#[serde(rename = "range")]
Range { end: i64, start: i64 },
///A range bounded inclusively below and unbounded above, `start..`.
#[serde(rename = "range_from")]
RangeFrom { start: i64 },
}
2023-02-05 01:22:55 +00:00
impl From<&BinRangeint64> for BinRangeint64 {
fn from(value: &BinRangeint64) -> Self {
value.clone()
}
}
2022-07-27 04:23:01 +00:00
///Type storing bin edges and a count of samples within it.
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "Type storing bin edges and a count of samples within
/// it.", "type": "object",
/// "required": [
/// "count",
/// "range"
/// ],
/// "properties": {
/// "count": {
/// "description": "The total count of samples in this bin.",
/// "type": "integer",
/// "format": "uint64",
/// "minimum": 0.0
/// },
/// "range": {
/// "description": "The range of the support covered by this bin.",
/// "allOf": [
/// {
/// "$ref": "#/components/schemas/BinRangedouble"
/// }
/// ]
/// }
/// }
///}
/// ```
/// </details>
2022-07-27 04:23:01 +00:00
#[derive(Clone, Debug, Deserialize, Serialize)]
pub struct Bindouble {
///The total count of samples in this bin.
pub count: u64,
///The range of the support covered by this bin.
pub range: BinRangedouble,
}
2023-02-05 01:22:55 +00:00
impl From<&Bindouble> for Bindouble {
fn from(value: &Bindouble) -> Self {
value.clone()
}
}
2022-07-27 04:23:01 +00:00
///Type storing bin edges and a count of samples within it.
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "Type storing bin edges and a count of samples within
/// it.", "type": "object",
/// "required": [
/// "count",
/// "range"
/// ],
/// "properties": {
/// "count": {
/// "description": "The total count of samples in this bin.",
/// "type": "integer",
/// "format": "uint64",
/// "minimum": 0.0
/// },
/// "range": {
/// "description": "The range of the support covered by this bin.",
/// "allOf": [
/// {
/// "$ref": "#/components/schemas/BinRangeint64"
/// }
/// ]
/// }
/// }
///}
/// ```
/// </details>
2022-07-27 04:23:01 +00:00
#[derive(Clone, Debug, Deserialize, Serialize)]
pub struct Binint64 {
///The total count of samples in this bin.
pub count: u64,
///The range of the support covered by this bin.
pub range: BinRangeint64,
}
2023-02-05 01:22:55 +00:00
impl From<&Binint64> for Binint64 {
fn from(value: &Binint64) -> Self {
value.clone()
}
}
2023-12-13 09:14:28 +00:00
///BlockSize
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "title": "disk block size in bytes",
/// "type": "integer",
/// "enum": [
/// 512,
/// 2048,
/// 4096
/// ]
///}
/// ```
/// </details>
2023-02-01 05:28:12 +00:00
#[derive(Clone, Debug, Serialize)]
2022-05-23 15:49:37 +00:00
pub struct BlockSize(i64);
impl std::ops::Deref for BlockSize {
type Target = i64;
2023-01-25 17:19:15 +00:00
fn deref(&self) -> &i64 {
2022-05-23 15:49:37 +00:00
&self.0
}
}
2023-02-05 01:22:55 +00:00
impl From<BlockSize> for i64 {
fn from(value: BlockSize) -> Self {
value.0
}
}
impl From<&BlockSize> for BlockSize {
fn from(value: &BlockSize) -> Self {
value.clone()
}
}
2022-05-23 15:49:37 +00:00
impl std::convert::TryFrom<i64> for BlockSize {
type Error = &'static str;
2023-01-25 17:19:15 +00:00
fn try_from(value: i64) -> Result<Self, &'static str> {
2022-05-23 15:49:37 +00:00
if ![512_i64, 2048_i64, 4096_i64].contains(&value) {
Err("invalid value")
} else {
Ok(Self(value))
}
}
}
2023-02-01 05:28:12 +00:00
impl<'de> serde::Deserialize<'de> for BlockSize {
fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where
D: serde::Deserializer<'de>,
{
2023-08-08 15:30:34 +00:00
Self::try_from(<i64>::deserialize(deserializer)?)
2023-02-01 05:28:12 +00:00
.map_err(|e| <D::Error as serde::de::Error>::custom(e.to_string()))
}
}
2022-07-03 02:09:38 +00:00
///A count of bytes, typically used either for memory or storage capacity
///
///The maximum supported byte count is [`i64::MAX`]. This makes it
/// somewhat inconvenient to define constructors: a u32 constructor can be
/// infallible, but an i64 constructor can fail (if the value is negative)
/// and a u64 constructor can fail (if the value is larger than i64::MAX).
/// We provide all of these for consumers' convenience.
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "A count of bytes, typically used either for memory or
/// storage capacity\n\nThe maximum supported byte count is [`i64::MAX`].
/// This makes it somewhat inconvenient to define constructors: a u32
/// constructor can be infallible, but an i64 constructor can fail (if the
/// value is negative) and a u64 constructor can fail (if the value is
/// larger than i64::MAX). We provide all of these for consumers'
/// convenience.", "type": "integer",
/// "format": "uint64",
/// "minimum": 0.0
///}
/// ```
/// </details>
2022-07-12 17:57:06 +00:00
#[derive(Clone, Debug, Deserialize, Serialize)]
2021-12-10 02:15:24 +00:00
pub struct ByteCount(pub u64);
impl std::ops::Deref for ByteCount {
type Target = u64;
2023-01-25 17:19:15 +00:00
fn deref(&self) -> &u64 {
2021-12-10 02:15:24 +00:00
&self.0
}
}
2023-02-05 01:22:55 +00:00
impl From<ByteCount> for u64 {
fn from(value: ByteCount) -> Self {
value.0
}
}
impl From<&ByteCount> for ByteCount {
fn from(value: &ByteCount) -> Self {
value.clone()
}
}
impl From<u64> for ByteCount {
fn from(value: u64) -> Self {
Self(value)
}
}
impl std::str::FromStr for ByteCount {
type Err = <u64 as std::str::FromStr>::Err;
fn from_str(value: &str) -> Result<Self, Self::Err> {
Ok(Self(value.parse()?))
}
}
impl std::convert::TryFrom<&str> for ByteCount {
type Error = <u64 as std::str::FromStr>::Err;
fn try_from(value: &str) -> Result<Self, Self::Error> {
value.parse()
}
}
impl std::convert::TryFrom<&String> for ByteCount {
type Error = <u64 as std::str::FromStr>::Err;
fn try_from(value: &String) -> Result<Self, Self::Error> {
value.parse()
}
}
impl std::convert::TryFrom<String> for ByteCount {
type Error = <u64 as std::str::FromStr>::Err;
fn try_from(value: String) -> Result<Self, Self::Error> {
value.parse()
}
}
impl ToString for ByteCount {
fn to_string(&self) -> String {
self.0.to_string()
}
}
2023-02-01 05:28:12 +00:00
///Client view of a [`Certificate`]
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "Client view of a [`Certificate`]",
/// "type": "object",
/// "required": [
/// "description",
/// "id",
/// "name",
/// "service",
/// "time_created",
/// "time_modified"
/// ],
/// "properties": {
/// "description": {
/// "description": "human-readable free-form text about a resource",
/// "type": "string"
/// },
/// "id": {
/// "description": "unique, immutable, system-controlled identifier for
/// each resource", "type": "string",
/// "format": "uuid"
/// },
/// "name": {
/// "description": "unique, mutable, user-controlled identifier for
/// each resource", "allOf": [
/// {
/// "$ref": "#/components/schemas/Name"
/// }
/// ]
/// },
/// "service": {
/// "$ref": "#/components/schemas/ServiceUsingCertificate"
/// },
/// "time_created": {
/// "description": "timestamp when this resource was created",
/// "type": "string",
/// "format": "date-time"
/// },
/// "time_modified": {
/// "description": "timestamp when this resource was last modified",
/// "type": "string",
/// "format": "date-time"
/// }
/// }
///}
/// ```
/// </details>
2023-02-01 05:28:12 +00:00
#[derive(Clone, Debug, Deserialize, Serialize)]
pub struct Certificate {
///human-readable free-form text about a resource
pub description: String,
///unique, immutable, system-controlled identifier for each resource
pub id: uuid::Uuid,
///unique, mutable, user-controlled identifier for each resource
pub name: Name,
pub service: ServiceUsingCertificate,
///timestamp when this resource was created
pub time_created: chrono::DateTime<chrono::offset::Utc>,
///timestamp when this resource was last modified
pub time_modified: chrono::DateTime<chrono::offset::Utc>,
}
2023-02-05 01:22:55 +00:00
impl From<&Certificate> for Certificate {
fn from(value: &Certificate) -> Self {
value.clone()
}
}
2023-02-01 05:28:12 +00:00
///Create-time parameters for a
/// [`Certificate`](crate::external_api::views::Certificate)
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "Create-time parameters for a
/// [`Certificate`](crate::external_api::views::Certificate)",
/// "type": "object",
/// "required": [
/// "cert",
/// "description",
/// "key",
/// "name",
/// "service"
/// ],
/// "properties": {
/// "cert": {
/// "description": "PEM file containing public certificate chain",
/// "type": "array",
/// "items": {
/// "type": "integer",
/// "format": "uint8",
/// "minimum": 0.0
/// }
/// },
/// "description": {
/// "type": "string"
/// },
/// "key": {
/// "description": "PEM file containing private key",
/// "type": "array",
/// "items": {
/// "type": "integer",
/// "format": "uint8",
/// "minimum": 0.0
/// }
/// },
/// "name": {
/// "$ref": "#/components/schemas/Name"
/// },
/// "service": {
/// "description": "The service using this certificate",
/// "allOf": [
/// {
/// "$ref": "#/components/schemas/ServiceUsingCertificate"
/// }
/// ]
/// }
/// }
///}
/// ```
/// </details>
2023-02-01 05:28:12 +00:00
#[derive(Clone, Debug, Deserialize, Serialize)]
pub struct CertificateCreate {
///PEM file containing public certificate chain
pub cert: Vec<u8>,
pub description: String,
///PEM file containing private key
pub key: Vec<u8>,
pub name: Name,
///The service using this certificate
pub service: ServiceUsingCertificate,
}
2023-02-05 01:22:55 +00:00
impl From<&CertificateCreate> for CertificateCreate {
fn from(value: &CertificateCreate) -> Self {
value.clone()
}
}
2023-02-01 05:28:12 +00:00
///A single page of results
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "A single page of results",
/// "type": "object",
/// "required": [
/// "items"
/// ],
/// "properties": {
/// "items": {
/// "description": "list of items on this page of results",
/// "type": "array",
/// "items": {
/// "$ref": "#/components/schemas/Certificate"
/// }
/// },
/// "next_page": {
/// "description": "token used to fetch the next page of results (if
/// any)", "type": [
/// "string",
/// "null"
/// ]
/// }
/// }
///}
/// ```
/// </details>
2023-02-01 05:28:12 +00:00
#[derive(Clone, Debug, Deserialize, Serialize)]
pub struct CertificateResultsPage {
///list of items on this page of results
pub items: Vec<Certificate>,
///token used to fetch the next page of results (if any)
#[serde(default, skip_serializing_if = "Option::is_none")]
pub next_page: Option<String>,
}
2023-02-05 01:22:55 +00:00
impl From<&CertificateResultsPage> for CertificateResultsPage {
fn from(value: &CertificateResultsPage) -> Self {
value.clone()
}
}
2023-02-01 05:28:12 +00:00
///Identity-related metadata that's included in "asset" public API objects
/// (which generally have no name or description)
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "Identity-related metadata that's included in \"asset\"
/// public API objects (which generally have no name or description)",
/// "type": "object",
/// "required": [
/// "component_type",
/// "id",
/// "time_created",
/// "time_modified",
/// "version"
/// ],
/// "properties": {
/// "component_type": {
/// "$ref": "#/components/schemas/UpdateableComponentType"
/// },
/// "id": {
/// "description": "unique, immutable, system-controlled identifier for
/// each resource", "type": "string",
/// "format": "uuid"
/// },
/// "time_created": {
/// "description": "timestamp when this resource was created",
/// "type": "string",
/// "format": "date-time"
/// },
/// "time_modified": {
/// "description": "timestamp when this resource was last modified",
/// "type": "string",
/// "format": "date-time"
/// },
/// "version": {
/// "$ref": "#/components/schemas/SemverVersion"
/// }
/// }
///}
/// ```
/// </details>
2023-02-01 05:28:12 +00:00
#[derive(Clone, Debug, Deserialize, Serialize)]
pub struct ComponentUpdate {
pub component_type: UpdateableComponentType,
///unique, immutable, system-controlled identifier for each resource
pub id: uuid::Uuid,
///timestamp when this resource was created
pub time_created: chrono::DateTime<chrono::offset::Utc>,
///timestamp when this resource was last modified
pub time_modified: chrono::DateTime<chrono::offset::Utc>,
pub version: SemverVersion,
}
2023-02-05 01:22:55 +00:00
impl From<&ComponentUpdate> for ComponentUpdate {
fn from(value: &ComponentUpdate) -> Self {
value.clone()
}
}
2023-02-01 05:28:12 +00:00
///A single page of results
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "A single page of results",
/// "type": "object",
/// "required": [
/// "items"
/// ],
/// "properties": {
/// "items": {
/// "description": "list of items on this page of results",
/// "type": "array",
/// "items": {
/// "$ref": "#/components/schemas/ComponentUpdate"
/// }
/// },
/// "next_page": {
/// "description": "token used to fetch the next page of results (if
/// any)", "type": [
/// "string",
/// "null"
/// ]
/// }
/// }
///}
/// ```
/// </details>
2023-02-01 05:28:12 +00:00
#[derive(Clone, Debug, Deserialize, Serialize)]
pub struct ComponentUpdateResultsPage {
///list of items on this page of results
pub items: Vec<ComponentUpdate>,
///token used to fetch the next page of results (if any)
#[serde(default, skip_serializing_if = "Option::is_none")]
pub next_page: Option<String>,
}
2023-02-05 01:22:55 +00:00
impl From<&ComponentUpdateResultsPage> for ComponentUpdateResultsPage {
fn from(value: &ComponentUpdateResultsPage) -> Self {
value.clone()
}
}
2022-07-27 04:23:01 +00:00
///A cumulative or counter data type.
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "A cumulative or counter data type.",
/// "type": "object",
/// "required": [
/// "start_time",
/// "value"
/// ],
/// "properties": {
/// "start_time": {
/// "type": "string",
/// "format": "date-time"
/// },
/// "value": {
/// "type": "number",
/// "format": "double"
/// }
/// }
///}
/// ```
/// </details>
2022-07-27 04:23:01 +00:00
#[derive(Clone, Debug, Deserialize, Serialize)]
pub struct Cumulativedouble {
pub start_time: chrono::DateTime<chrono::offset::Utc>,
pub value: f64,
}
2023-02-05 01:22:55 +00:00
impl From<&Cumulativedouble> for Cumulativedouble {
fn from(value: &Cumulativedouble) -> Self {
value.clone()
}
}
2022-07-27 04:23:01 +00:00
///A cumulative or counter data type.
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "A cumulative or counter data type.",
/// "type": "object",
/// "required": [
/// "start_time",
/// "value"
/// ],
/// "properties": {
/// "start_time": {
/// "type": "string",
/// "format": "date-time"
/// },
/// "value": {
/// "type": "integer",
/// "format": "int64"
/// }
/// }
///}
/// ```
/// </details>
2022-07-27 04:23:01 +00:00
#[derive(Clone, Debug, Deserialize, Serialize)]
pub struct Cumulativeint64 {
pub start_time: chrono::DateTime<chrono::offset::Utc>,
pub value: i64,
}
2023-02-05 01:22:55 +00:00
impl From<&Cumulativeint64> for Cumulativeint64 {
fn from(value: &Cumulativeint64) -> Self {
value.clone()
}
}
2022-07-27 04:23:01 +00:00
///A `Datum` is a single sampled data point from a metric.
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "A `Datum` is a single sampled data point from a
/// metric.", "oneOf": [
/// {
/// "type": "object",
/// "required": [
/// "datum",
/// "type"
/// ],
/// "properties": {
/// "datum": {
/// "type": "boolean"
/// },
/// "type": {
/// "type": "string",
/// "enum": [
/// "bool"
/// ]
/// }
/// }
/// },
/// {
/// "type": "object",
/// "required": [
/// "datum",
/// "type"
/// ],
/// "properties": {
/// "datum": {
/// "type": "integer",
/// "format": "int64"
/// },
/// "type": {
/// "type": "string",
/// "enum": [
/// "i64"
/// ]
/// }
/// }
/// },
/// {
/// "type": "object",
/// "required": [
/// "datum",
/// "type"
/// ],
/// "properties": {
/// "datum": {
/// "type": "number",
/// "format": "double"
/// },
/// "type": {
/// "type": "string",
/// "enum": [
/// "f64"
/// ]
/// }
/// }
/// },
/// {
/// "type": "object",
/// "required": [
/// "datum",
/// "type"
/// ],
/// "properties": {
/// "datum": {
/// "type": "string"
/// },
/// "type": {
/// "type": "string",
/// "enum": [
/// "string"
/// ]
/// }
/// }
/// },
/// {
/// "type": "object",
/// "required": [
/// "datum",
/// "type"
/// ],
/// "properties": {
/// "datum": {
/// "type": "array",
/// "items": {
/// "type": "integer",
/// "format": "uint8",
/// "minimum": 0.0
/// }
/// },
/// "type": {
/// "type": "string",
/// "enum": [
/// "bytes"
/// ]
/// }
/// }
/// },
/// {
/// "type": "object",
/// "required": [
/// "datum",
/// "type"
/// ],
/// "properties": {
/// "datum": {
/// "$ref": "#/components/schemas/Cumulativeint64"
/// },
/// "type": {
/// "type": "string",
/// "enum": [
/// "cumulative_i64"
/// ]
/// }
/// }
/// },
/// {
/// "type": "object",
/// "required": [
/// "datum",
/// "type"
/// ],
/// "properties": {
/// "datum": {
/// "$ref": "#/components/schemas/Cumulativedouble"
/// },
/// "type": {
/// "type": "string",
/// "enum": [
/// "cumulative_f64"
/// ]
/// }
/// }
/// },
/// {
/// "type": "object",
/// "required": [
/// "datum",
/// "type"
/// ],
/// "properties": {
/// "datum": {
/// "$ref": "#/components/schemas/Histogramint64"
/// },
/// "type": {
/// "type": "string",
/// "enum": [
/// "histogram_i64"
/// ]
/// }
/// }
/// },
/// {
/// "type": "object",
/// "required": [
/// "datum",
/// "type"
/// ],
/// "properties": {
/// "datum": {
/// "$ref": "#/components/schemas/Histogramdouble"
/// },
/// "type": {
/// "type": "string",
/// "enum": [
/// "histogram_f64"
/// ]
/// }
/// }
/// }
/// ]
///}
/// ```
/// </details>
2022-07-27 04:23:01 +00:00
#[derive(Clone, Debug, Deserialize, Serialize)]
#[serde(tag = "type", content = "datum")]
pub enum Datum {
#[serde(rename = "bool")]
Bool(bool),
#[serde(rename = "i64")]
I64(i64),
#[serde(rename = "f64")]
F64(f64),
#[serde(rename = "string")]
String(String),
#[serde(rename = "bytes")]
Bytes(Vec<u8>),
#[serde(rename = "cumulative_i64")]
CumulativeI64(Cumulativeint64),
#[serde(rename = "cumulative_f64")]
CumulativeF64(Cumulativedouble),
#[serde(rename = "histogram_i64")]
HistogramI64(Histogramint64),
#[serde(rename = "histogram_f64")]
HistogramF64(Histogramdouble),
}
2023-02-05 01:22:55 +00:00
impl From<&Datum> for Datum {
fn from(value: &Datum) -> Self {
value.clone()
}
}
2023-03-17 22:39:46 +00:00
impl From<bool> for Datum {
fn from(value: bool) -> Self {
Self::Bool(value)
}
}
impl From<i64> for Datum {
fn from(value: i64) -> Self {
Self::I64(value)
}
}
impl From<f64> for Datum {
fn from(value: f64) -> Self {
Self::F64(value)
}
}
impl From<Vec<u8>> for Datum {
fn from(value: Vec<u8>) -> Self {
Self::Bytes(value)
}
}
impl From<Cumulativeint64> for Datum {
fn from(value: Cumulativeint64) -> Self {
Self::CumulativeI64(value)
}
}
impl From<Cumulativedouble> for Datum {
fn from(value: Cumulativedouble) -> Self {
Self::CumulativeF64(value)
}
}
impl From<Histogramint64> for Datum {
fn from(value: Histogramint64) -> Self {
Self::HistogramI64(value)
}
}
impl From<Histogramdouble> for Datum {
fn from(value: Histogramdouble) -> Self {
Self::HistogramF64(value)
}
}
2022-07-03 02:09:38 +00:00
///The type of an individual datum of a metric.
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "The type of an individual datum of a metric.",
/// "type": "string",
/// "enum": [
/// "bool",
/// "i64",
/// "f64",
/// "string",
/// "bytes",
/// "cumulative_i64",
/// "cumulative_f64",
/// "histogram_i64",
/// "histogram_f64"
/// ]
///}
/// ```
/// </details>
2022-07-12 17:57:06 +00:00
#[derive(Clone, Copy, Debug, Deserialize, Eq, Hash, Ord, PartialEq, PartialOrd, Serialize)]
2022-01-05 20:02:46 +00:00
pub enum DatumType {
2022-05-23 15:49:37 +00:00
#[serde(rename = "bool")]
2022-01-05 20:02:46 +00:00
Bool,
2022-05-23 15:49:37 +00:00
#[serde(rename = "i64")]
2022-01-05 20:02:46 +00:00
I64,
2022-05-23 15:49:37 +00:00
#[serde(rename = "f64")]
2022-01-05 20:02:46 +00:00
F64,
2022-05-23 15:49:37 +00:00
#[serde(rename = "string")]
2022-01-05 20:02:46 +00:00
String,
2022-05-23 15:49:37 +00:00
#[serde(rename = "bytes")]
2022-01-05 20:02:46 +00:00
Bytes,
2022-05-23 15:49:37 +00:00
#[serde(rename = "cumulative_i64")]
2022-01-05 20:02:46 +00:00
CumulativeI64,
2022-05-23 15:49:37 +00:00
#[serde(rename = "cumulative_f64")]
2022-01-05 20:02:46 +00:00
CumulativeF64,
2022-05-23 15:49:37 +00:00
#[serde(rename = "histogram_i64")]
2022-01-05 20:02:46 +00:00
HistogramI64,
2022-05-23 15:49:37 +00:00
#[serde(rename = "histogram_f64")]
2022-01-05 20:02:46 +00:00
HistogramF64,
}
2023-02-05 01:22:55 +00:00
impl From<&DatumType> for DatumType {
fn from(value: &DatumType) -> Self {
value.clone()
}
}
2022-01-05 20:02:46 +00:00
impl ToString for DatumType {
fn to_string(&self) -> String {
2022-03-08 07:22:44 +00:00
match *self {
2022-07-12 17:57:06 +00:00
Self::Bool => "bool".to_string(),
Self::I64 => "i64".to_string(),
Self::F64 => "f64".to_string(),
Self::String => "string".to_string(),
Self::Bytes => "bytes".to_string(),
Self::CumulativeI64 => "cumulative_i64".to_string(),
Self::CumulativeF64 => "cumulative_f64".to_string(),
Self::HistogramI64 => "histogram_i64".to_string(),
Self::HistogramF64 => "histogram_f64".to_string(),
2022-05-23 15:49:37 +00:00
}
}
}
2022-07-12 17:57:06 +00:00
impl std::str::FromStr for DatumType {
type Err = &'static str;
2023-01-25 17:19:15 +00:00
fn from_str(value: &str) -> Result<Self, &'static str> {
2022-07-12 17:57:06 +00:00
match value {
"bool" => Ok(Self::Bool),
"i64" => Ok(Self::I64),
"f64" => Ok(Self::F64),
"string" => Ok(Self::String),
"bytes" => Ok(Self::Bytes),
"cumulative_i64" => Ok(Self::CumulativeI64),
"cumulative_f64" => Ok(Self::CumulativeF64),
"histogram_i64" => Ok(Self::HistogramI64),
"histogram_f64" => Ok(Self::HistogramF64),
_ => Err("invalid value"),
}
}
}
2023-01-25 17:19:15 +00:00
impl std::convert::TryFrom<&str> for DatumType {
type Error = &'static str;
fn try_from(value: &str) -> Result<Self, &'static str> {
value.parse()
}
}
impl std::convert::TryFrom<&String> for DatumType {
type Error = &'static str;
fn try_from(value: &String) -> Result<Self, &'static str> {
value.parse()
}
}
2023-01-30 20:17:51 +00:00
impl std::convert::TryFrom<String> for DatumType {
type Error = &'static str;
fn try_from(value: String) -> Result<Self, &'static str> {
value.parse()
}
}
2023-12-13 09:14:28 +00:00
///DerEncodedKeyPair
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "type": "object",
/// "required": [
/// "private_key",
/// "public_cert"
/// ],
/// "properties": {
/// "private_key": {
/// "description": "request signing private key (base64 encoded der
/// file)", "type": "string"
/// },
/// "public_cert": {
/// "description": "request signing public certificate (base64 encoded
/// der file)", "type": "string"
/// }
/// }
///}
/// ```
/// </details>
2022-07-12 17:57:06 +00:00
#[derive(Clone, Debug, Deserialize, Serialize)]
2022-07-08 01:35:36 +00:00
pub struct DerEncodedKeyPair {
///request signing private key (base64 encoded der file)
pub private_key: String,
///request signing public certificate (base64 encoded der file)
pub public_cert: String,
}
2023-02-05 01:22:55 +00:00
impl From<&DerEncodedKeyPair> for DerEncodedKeyPair {
fn from(value: &DerEncodedKeyPair) -> Self {
value.clone()
}
}
2023-12-13 09:14:28 +00:00
///DeviceAccessTokenRequest
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "type": "object",
/// "required": [
/// "client_id",
/// "device_code",
/// "grant_type"
/// ],
/// "properties": {
/// "client_id": {
/// "type": "string",
/// "format": "uuid"
/// },
/// "device_code": {
/// "type": "string"
/// },
/// "grant_type": {
/// "type": "string"
/// }
/// }
///}
/// ```
/// </details>
2022-07-12 17:57:06 +00:00
#[derive(Clone, Debug, Deserialize, Serialize)]
2022-07-08 01:35:36 +00:00
pub struct DeviceAccessTokenRequest {
pub client_id: uuid::Uuid,
pub device_code: String,
pub grant_type: String,
}
2023-02-05 01:22:55 +00:00
impl From<&DeviceAccessTokenRequest> for DeviceAccessTokenRequest {
fn from(value: &DeviceAccessTokenRequest) -> Self {
value.clone()
}
}
2023-12-13 09:14:28 +00:00
///DeviceAuthRequest
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "type": "object",
/// "required": [
/// "client_id"
/// ],
/// "properties": {
/// "client_id": {
/// "type": "string",
/// "format": "uuid"
/// }
/// }
///}
/// ```
/// </details>
2022-07-12 17:57:06 +00:00
#[derive(Clone, Debug, Deserialize, Serialize)]
2022-07-08 01:35:36 +00:00
pub struct DeviceAuthRequest {
pub client_id: uuid::Uuid,
}
2023-02-05 01:22:55 +00:00
impl From<&DeviceAuthRequest> for DeviceAuthRequest {
fn from(value: &DeviceAuthRequest) -> Self {
value.clone()
}
}
2023-12-13 09:14:28 +00:00
///DeviceAuthVerify
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "type": "object",
/// "required": [
/// "user_code"
/// ],
/// "properties": {
/// "user_code": {
/// "type": "string"
/// }
/// }
///}
/// ```
/// </details>
2022-07-12 17:57:06 +00:00
#[derive(Clone, Debug, Deserialize, Serialize)]
2022-07-08 01:35:36 +00:00
pub struct DeviceAuthVerify {
pub user_code: String,
}
2023-02-05 01:22:55 +00:00
impl From<&DeviceAuthVerify> for DeviceAuthVerify {
fn from(value: &DeviceAuthVerify) -> Self {
value.clone()
}
}
2023-12-13 09:14:28 +00:00
///Digest
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "oneOf": [
/// {
/// "type": "object",
/// "required": [
/// "type",
/// "value"
/// ],
/// "properties": {
/// "type": {
/// "type": "string",
/// "enum": [
/// "sha256"
/// ]
/// },
/// "value": {
/// "type": "string"
/// }
/// }
/// }
/// ]
///}
/// ```
/// </details>
2022-07-12 17:57:06 +00:00
#[derive(Clone, Debug, Deserialize, Serialize)]
2022-07-27 04:23:01 +00:00
#[serde(tag = "type", content = "value")]
pub enum Digest {
2022-05-23 15:49:37 +00:00
#[serde(rename = "sha256")]
2022-07-27 04:23:01 +00:00
Sha256(String),
2022-01-05 20:02:46 +00:00
}
2023-02-05 01:22:55 +00:00
impl From<&Digest> for Digest {
fn from(value: &Digest) -> Self {
value.clone()
}
}
2022-07-08 01:35:36 +00:00
///Client view of a [`Disk`]
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "Client view of a [`Disk`]",
/// "type": "object",
/// "required": [
/// "block_size",
/// "description",
/// "device_path",
/// "id",
/// "name",
/// "project_id",
/// "size",
/// "state",
/// "time_created",
/// "time_modified"
/// ],
/// "properties": {
/// "block_size": {
/// "$ref": "#/components/schemas/ByteCount"
/// },
/// "description": {
/// "description": "human-readable free-form text about a resource",
/// "type": "string"
/// },
/// "device_path": {
/// "type": "string"
/// },
/// "id": {
/// "description": "unique, immutable, system-controlled identifier for
/// each resource", "type": "string",
/// "format": "uuid"
/// },
/// "image_id": {
/// "type": [
/// "string",
/// "null"
/// ],
/// "format": "uuid"
/// },
/// "name": {
/// "description": "unique, mutable, user-controlled identifier for
/// each resource", "allOf": [
/// {
/// "$ref": "#/components/schemas/Name"
/// }
/// ]
/// },
/// "project_id": {
/// "type": "string",
/// "format": "uuid"
/// },
/// "size": {
/// "$ref": "#/components/schemas/ByteCount"
/// },
/// "snapshot_id": {
/// "type": [
/// "string",
/// "null"
/// ],
/// "format": "uuid"
/// },
/// "state": {
/// "$ref": "#/components/schemas/DiskState"
/// },
/// "time_created": {
/// "description": "timestamp when this resource was created",
/// "type": "string",
/// "format": "date-time"
/// },
/// "time_modified": {
/// "description": "timestamp when this resource was last modified",
/// "type": "string",
/// "format": "date-time"
/// }
/// }
///}
/// ```
/// </details>
2022-07-12 17:57:06 +00:00
#[derive(Clone, Debug, Deserialize, Serialize)]
2021-12-10 02:15:24 +00:00
pub struct Disk {
2022-05-23 15:49:37 +00:00
pub block_size: ByteCount,
2022-07-03 02:09:38 +00:00
///human-readable free-form text about a resource
2021-12-10 02:15:24 +00:00
pub description: String,
pub device_path: String,
2022-07-03 02:09:38 +00:00
///unique, immutable, system-controlled identifier for each resource
2021-12-10 02:15:24 +00:00
pub id: uuid::Uuid,
2022-05-23 15:49:37 +00:00
#[serde(default, skip_serializing_if = "Option::is_none")]
pub image_id: Option<uuid::Uuid>,
2022-07-03 02:09:38 +00:00
///unique, mutable, user-controlled identifier for each resource
2021-12-10 02:15:24 +00:00
pub name: Name,
pub project_id: uuid::Uuid,
pub size: ByteCount,
2022-02-08 16:59:38 +00:00
#[serde(default, skip_serializing_if = "Option::is_none")]
2021-12-10 02:15:24 +00:00
pub snapshot_id: Option<uuid::Uuid>,
pub state: DiskState,
2022-07-03 02:09:38 +00:00
///timestamp when this resource was created
2021-12-10 02:15:24 +00:00
pub time_created: chrono::DateTime<chrono::offset::Utc>,
2022-07-03 02:09:38 +00:00
///timestamp when this resource was last modified
2021-12-10 02:15:24 +00:00
pub time_modified: chrono::DateTime<chrono::offset::Utc>,
}
2023-02-05 01:22:55 +00:00
impl From<&Disk> for Disk {
fn from(value: &Disk) -> Self {
value.clone()
}
}
2022-07-03 02:09:38 +00:00
///Create-time parameters for a
/// [`Disk`](omicron_common::api::external::Disk)
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "Create-time parameters for a
/// [`Disk`](omicron_common::api::external::Disk)", "type": "object",
/// "required": [
/// "description",
/// "disk_source",
/// "name",
/// "size"
/// ],
/// "properties": {
/// "description": {
/// "type": "string"
/// },
/// "disk_source": {
/// "description": "initial source for this disk",
/// "allOf": [
/// {
/// "$ref": "#/components/schemas/DiskSource"
/// }
/// ]
/// },
/// "name": {
/// "$ref": "#/components/schemas/Name"
/// },
/// "size": {
/// "description": "total size of the Disk in bytes",
/// "allOf": [
/// {
/// "$ref": "#/components/schemas/ByteCount"
/// }
/// ]
/// }
/// }
///}
/// ```
/// </details>
2022-07-12 17:57:06 +00:00
#[derive(Clone, Debug, Deserialize, Serialize)]
2021-12-10 02:15:24 +00:00
pub struct DiskCreate {
pub description: String,
2022-07-03 02:09:38 +00:00
///initial source for this disk
2022-05-23 15:49:37 +00:00
pub disk_source: DiskSource,
2021-12-10 02:15:24 +00:00
pub name: Name,
2022-07-03 02:09:38 +00:00
///total size of the Disk in bytes
2021-12-10 02:15:24 +00:00
pub size: ByteCount,
}
2023-02-05 01:22:55 +00:00
impl From<&DiskCreate> for DiskCreate {
fn from(value: &DiskCreate) -> Self {
value.clone()
}
}
2023-02-01 05:28:12 +00:00
///TODO-v1: Delete this Parameters for the
/// [`Disk`](omicron_common::api::external::Disk) to be attached or detached
/// to an instance
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "TODO-v1: Delete this Parameters for the
/// [`Disk`](omicron_common::api::external::Disk) to be attached or detached
/// to an instance", "type": "object",
/// "required": [
/// "name"
/// ],
/// "properties": {
/// "name": {
/// "$ref": "#/components/schemas/Name"
/// }
/// }
///}
/// ```
/// </details>
2022-07-12 17:57:06 +00:00
#[derive(Clone, Debug, Deserialize, Serialize)]
2022-01-05 20:02:46 +00:00
pub struct DiskIdentifier {
2022-05-23 15:49:37 +00:00
pub name: Name,
2022-01-05 20:02:46 +00:00
}
2023-02-05 01:22:55 +00:00
impl From<&DiskIdentifier> for DiskIdentifier {
fn from(value: &DiskIdentifier) -> Self {
value.clone()
}
}
2023-12-13 09:14:28 +00:00
///DiskMetricName
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "type": "string",
/// "enum": [
/// "activated",
/// "flush",
/// "read",
/// "read_bytes",
/// "write",
/// "write_bytes"
/// ]
///}
/// ```
/// </details>
2022-07-27 04:23:01 +00:00
#[derive(Clone, Copy, Debug, Deserialize, Eq, Hash, Ord, PartialEq, PartialOrd, Serialize)]
pub enum DiskMetricName {
#[serde(rename = "activated")]
Activated,
#[serde(rename = "flush")]
Flush,
#[serde(rename = "read")]
Read,
#[serde(rename = "read_bytes")]
ReadBytes,
#[serde(rename = "write")]
Write,
#[serde(rename = "write_bytes")]
WriteBytes,
}
2023-02-05 01:22:55 +00:00
impl From<&DiskMetricName> for DiskMetricName {
fn from(value: &DiskMetricName) -> Self {
value.clone()
}
}
2022-07-27 04:23:01 +00:00
impl ToString for DiskMetricName {
fn to_string(&self) -> String {
match *self {
Self::Activated => "activated".to_string(),
Self::Flush => "flush".to_string(),
Self::Read => "read".to_string(),
Self::ReadBytes => "read_bytes".to_string(),
Self::Write => "write".to_string(),
Self::WriteBytes => "write_bytes".to_string(),
}
}
}
impl std::str::FromStr for DiskMetricName {
type Err = &'static str;
2023-01-25 17:19:15 +00:00
fn from_str(value: &str) -> Result<Self, &'static str> {
2022-07-27 04:23:01 +00:00
match value {
"activated" => Ok(Self::Activated),
"flush" => Ok(Self::Flush),
"read" => Ok(Self::Read),
"read_bytes" => Ok(Self::ReadBytes),
"write" => Ok(Self::Write),
"write_bytes" => Ok(Self::WriteBytes),
_ => Err("invalid value"),
}
}
}
2023-01-25 17:19:15 +00:00
impl std::convert::TryFrom<&str> for DiskMetricName {
type Error = &'static str;
fn try_from(value: &str) -> Result<Self, &'static str> {
value.parse()
}
}
impl std::convert::TryFrom<&String> for DiskMetricName {
type Error = &'static str;
fn try_from(value: &String) -> Result<Self, &'static str> {
value.parse()
}
}
2023-01-30 20:17:51 +00:00
impl std::convert::TryFrom<String> for DiskMetricName {
type Error = &'static str;
fn try_from(value: String) -> Result<Self, &'static str> {
value.parse()
}
}
2023-12-13 09:14:28 +00:00
///DiskPath
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "type": "object",
/// "required": [
/// "disk"
/// ],
/// "properties": {
/// "disk": {
/// "$ref": "#/components/schemas/NameOrId"
/// }
/// }
///}
/// ```
/// </details>
2023-02-01 05:28:12 +00:00
#[derive(Clone, Debug, Deserialize, Serialize)]
pub struct DiskPath {
pub disk: NameOrId,
}
2023-02-05 01:22:55 +00:00
impl From<&DiskPath> for DiskPath {
fn from(value: &DiskPath) -> Self {
value.clone()
}
}
2022-07-03 02:09:38 +00:00
///A single page of results
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "A single page of results",
/// "type": "object",
/// "required": [
/// "items"
/// ],
/// "properties": {
/// "items": {
/// "description": "list of items on this page of results",
/// "type": "array",
/// "items": {
/// "$ref": "#/components/schemas/Disk"
/// }
/// },
/// "next_page": {
/// "description": "token used to fetch the next page of results (if
/// any)", "type": [
/// "string",
/// "null"
/// ]
/// }
/// }
///}
/// ```
/// </details>
2022-07-12 17:57:06 +00:00
#[derive(Clone, Debug, Deserialize, Serialize)]
2021-12-10 02:15:24 +00:00
pub struct DiskResultsPage {
2022-07-03 02:09:38 +00:00
///list of items on this page of results
2021-12-10 02:15:24 +00:00
pub items: Vec<Disk>,
2022-07-03 02:09:38 +00:00
///token used to fetch the next page of results (if any)
2021-12-10 02:15:24 +00:00
#[serde(default, skip_serializing_if = "Option::is_none")]
pub next_page: Option<String>,
}
2023-02-05 01:22:55 +00:00
impl From<&DiskResultsPage> for DiskResultsPage {
fn from(value: &DiskResultsPage) -> Self {
value.clone()
}
}
2022-07-03 02:09:38 +00:00
///Different sources for a disk
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "Different sources for a disk",
/// "oneOf": [
/// {
/// "description": "Create a blank disk",
/// "type": "object",
/// "required": [
/// "block_size",
/// "type"
/// ],
/// "properties": {
/// "block_size": {
/// "description": "size of blocks for this Disk. valid values are:
/// 512, 2048, or 4096", "allOf": [
/// {
/// "$ref": "#/components/schemas/BlockSize"
/// }
/// ]
/// },
/// "type": {
/// "type": "string",
/// "enum": [
/// "blank"
/// ]
/// }
/// }
/// },
/// {
/// "description": "Create a disk from a disk snapshot",
/// "type": "object",
/// "required": [
/// "snapshot_id",
/// "type"
/// ],
/// "properties": {
/// "snapshot_id": {
/// "type": "string",
/// "format": "uuid"
/// },
/// "type": {
/// "type": "string",
/// "enum": [
/// "snapshot"
/// ]
/// }
/// }
/// },
/// {
/// "description": "Create a disk from a project image",
/// "type": "object",
/// "required": [
/// "image_id",
/// "type"
/// ],
/// "properties": {
/// "image_id": {
/// "type": "string",
/// "format": "uuid"
/// },
/// "type": {
/// "type": "string",
/// "enum": [
/// "image"
/// ]
/// }
/// }
/// },
/// {
/// "description": "Create a disk from a global image",
/// "type": "object",
/// "required": [
/// "image_id",
/// "type"
/// ],
/// "properties": {
/// "image_id": {
/// "type": "string",
/// "format": "uuid"
/// },
/// "type": {
/// "type": "string",
/// "enum": [
/// "global_image"
/// ]
/// }
/// }
/// }
/// ]
///}
/// ```
/// </details>
2022-07-12 17:57:06 +00:00
#[derive(Clone, Debug, Deserialize, Serialize)]
2022-05-23 15:49:37 +00:00
#[serde(tag = "type")]
pub enum DiskSource {
2022-07-03 02:09:38 +00:00
///Create a blank disk
2022-05-23 15:49:37 +00:00
#[serde(rename = "blank")]
Blank {
2022-07-03 02:09:38 +00:00
///size of blocks for this Disk. valid values are: 512, 2048, or
/// 4096
2022-05-23 15:49:37 +00:00
block_size: BlockSize,
},
2022-07-03 02:09:38 +00:00
///Create a disk from a disk snapshot
2022-05-23 15:49:37 +00:00
#[serde(rename = "snapshot")]
Snapshot { snapshot_id: uuid::Uuid },
2022-07-03 02:09:38 +00:00
///Create a disk from a project image
2022-05-23 15:49:37 +00:00
#[serde(rename = "image")]
Image { image_id: uuid::Uuid },
2022-07-03 02:09:38 +00:00
///Create a disk from a global image
2022-05-23 15:49:37 +00:00
#[serde(rename = "global_image")]
GlobalImage { image_id: uuid::Uuid },
}
2023-02-05 01:22:55 +00:00
impl From<&DiskSource> for DiskSource {
fn from(value: &DiskSource) -> Self {
value.clone()
}
}
2022-07-03 02:09:38 +00:00
///State of a Disk (primarily: attached or not)
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "State of a Disk (primarily: attached or not)",
/// "oneOf": [
/// {
/// "description": "Disk is being initialized",
/// "type": "object",
/// "required": [
/// "state"
/// ],
/// "properties": {
/// "state": {
/// "type": "string",
/// "enum": [
/// "creating"
/// ]
/// }
/// }
/// },
/// {
/// "description": "Disk is ready but detached from any Instance",
/// "type": "object",
/// "required": [
/// "state"
/// ],
/// "properties": {
/// "state": {
/// "type": "string",
/// "enum": [
/// "detached"
/// ]
/// }
/// }
/// },
/// {
/// "description": "Disk is being attached to the given Instance",
/// "type": "object",
/// "required": [
/// "instance",
/// "state"
/// ],
/// "properties": {
/// "instance": {
/// "type": "string",
/// "format": "uuid"
/// },
/// "state": {
/// "type": "string",
/// "enum": [
/// "attaching"
/// ]
/// }
/// }
/// },
/// {
/// "description": "Disk is attached to the given Instance",
/// "type": "object",
/// "required": [
/// "instance",
/// "state"
/// ],
/// "properties": {
/// "instance": {
/// "type": "string",
/// "format": "uuid"
/// },
/// "state": {
/// "type": "string",
/// "enum": [
/// "attached"
/// ]
/// }
/// }
/// },
/// {
/// "description": "Disk is being detached from the given Instance",
/// "type": "object",
/// "required": [
/// "instance",
/// "state"
/// ],
/// "properties": {
/// "instance": {
/// "type": "string",
/// "format": "uuid"
/// },
/// "state": {
/// "type": "string",
/// "enum": [
/// "detaching"
/// ]
/// }
/// }
/// },
/// {
/// "description": "Disk has been destroyed",
/// "type": "object",
/// "required": [
/// "state"
/// ],
/// "properties": {
/// "state": {
/// "type": "string",
/// "enum": [
/// "destroyed"
/// ]
/// }
/// }
/// },
/// {
/// "description": "Disk is unavailable",
/// "type": "object",
/// "required": [
/// "state"
/// ],
/// "properties": {
/// "state": {
/// "type": "string",
/// "enum": [
/// "faulted"
/// ]
/// }
/// }
/// }
/// ]
///}
/// ```
/// </details>
2022-07-12 17:57:06 +00:00
#[derive(Clone, Debug, Deserialize, Serialize)]
2021-12-10 02:15:24 +00:00
#[serde(tag = "state", content = "instance")]
pub enum DiskState {
#[serde(rename = "creating")]
Creating,
#[serde(rename = "detached")]
Detached,
2022-07-03 02:09:38 +00:00
///Disk is being attached to the given Instance
2021-12-10 02:15:24 +00:00
#[serde(rename = "attaching")]
Attaching(uuid::Uuid),
2022-07-03 02:09:38 +00:00
///Disk is attached to the given Instance
2021-12-10 02:15:24 +00:00
#[serde(rename = "attached")]
Attached(uuid::Uuid),
2022-07-03 02:09:38 +00:00
///Disk is being detached from the given Instance
2021-12-10 02:15:24 +00:00
#[serde(rename = "detaching")]
Detaching(uuid::Uuid),
#[serde(rename = "destroyed")]
Destroyed,
#[serde(rename = "faulted")]
Faulted,
}
2023-02-05 01:22:55 +00:00
impl From<&DiskState> for DiskState {
fn from(value: &DiskState) -> Self {
value.clone()
}
}
2022-07-08 01:35:36 +00:00
///OS image distribution
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "OS image distribution",
/// "type": "object",
/// "required": [
/// "name",
/// "version"
/// ],
/// "properties": {
/// "name": {
/// "description": "The name of the distribution (e.g. \"alpine\" or
/// \"ubuntu\")", "allOf": [
/// {
/// "$ref": "#/components/schemas/Name"
/// }
/// ]
/// },
/// "version": {
/// "description": "The version of the distribution (e.g. \"3.10\" or
/// \"18.04\")", "type": "string"
/// }
/// }
///}
/// ```
/// </details>
2022-07-12 17:57:06 +00:00
#[derive(Clone, Debug, Deserialize, Serialize)]
2022-07-08 01:35:36 +00:00
pub struct Distribution {
///The name of the distribution (e.g. "alpine" or "ubuntu")
pub name: Name,
///The version of the distribution (e.g. "3.10" or "18.04")
pub version: String,
}
2023-02-05 01:22:55 +00:00
impl From<&Distribution> for Distribution {
fn from(value: &Distribution) -> Self {
value.clone()
}
}
2022-07-03 02:09:38 +00:00
///Error information from a response.
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "Error information from a response.",
/// "type": "object",
/// "required": [
/// "message",
/// "request_id"
/// ],
/// "properties": {
/// "error_code": {
/// "type": "string"
/// },
/// "message": {
/// "type": "string"
/// },
/// "request_id": {
/// "type": "string"
/// }
/// }
///}
/// ```
/// </details>
2022-07-12 17:57:06 +00:00
#[derive(Clone, Debug, Deserialize, Serialize)]
2022-02-08 16:59:38 +00:00
pub struct Error {
#[serde(default, skip_serializing_if = "Option::is_none")]
pub error_code: Option<String>,
pub message: String,
pub request_id: String,
}
2023-02-05 01:22:55 +00:00
impl From<&Error> for Error {
fn from(value: &Error) -> Self {
value.clone()
}
}
2023-12-13 09:14:28 +00:00
///ExternalIp
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "type": "object",
/// "required": [
/// "ip",
/// "kind"
/// ],
/// "properties": {
/// "ip": {
/// "type": "string",
/// "format": "ip"
/// },
/// "kind": {
/// "$ref": "#/components/schemas/IpKind"
/// }
/// }
///}
/// ```
/// </details>
2022-07-27 04:23:01 +00:00
#[derive(Clone, Debug, Deserialize, Serialize)]
pub struct ExternalIp {
pub ip: std::net::IpAddr,
pub kind: IpKind,
}
2023-02-05 01:22:55 +00:00
impl From<&ExternalIp> for ExternalIp {
fn from(value: &ExternalIp) -> Self {
value.clone()
}
}
2022-07-27 04:23:01 +00:00
///Parameters for creating an external IP address for instances.
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "Parameters for creating an external IP address for
/// instances.", "oneOf": [
/// {
/// "description": "An IP address providing both inbound and outbound
/// access. The address is automatically-assigned from the provided IP Pool,
/// or all available pools if not specified.", "type": "object",
/// "required": [
/// "type"
/// ],
/// "properties": {
/// "pool_name": {
/// "allOf": [
/// {
/// "$ref": "#/components/schemas/Name"
/// }
/// ]
/// },
/// "type": {
/// "type": "string",
/// "enum": [
/// "ephemeral"
/// ]
/// }
/// }
/// }
/// ]
///}
/// ```
/// </details>
2022-07-27 04:23:01 +00:00
#[derive(Clone, Debug, Deserialize, Serialize)]
#[serde(tag = "type")]
pub enum ExternalIpCreate {
///An IP address providing both inbound and outbound access. The
/// address is automatically-assigned from the provided IP Pool, or all
/// available pools if not specified.
#[serde(rename = "ephemeral")]
Ephemeral {
#[serde(default, skip_serializing_if = "Option::is_none")]
pool_name: Option<Name>,
},
}
2023-02-05 01:22:55 +00:00
impl From<&ExternalIpCreate> for ExternalIpCreate {
fn from(value: &ExternalIpCreate) -> Self {
value.clone()
}
}
2022-07-27 04:23:01 +00:00
///A single page of results
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "A single page of results",
/// "type": "object",
/// "required": [
/// "items"
/// ],
/// "properties": {
/// "items": {
/// "description": "list of items on this page of results",
/// "type": "array",
/// "items": {
/// "$ref": "#/components/schemas/ExternalIp"
/// }
/// },
/// "next_page": {
/// "description": "token used to fetch the next page of results (if
/// any)", "type": [
/// "string",
/// "null"
/// ]
/// }
/// }
///}
/// ```
/// </details>
2022-07-27 04:23:01 +00:00
#[derive(Clone, Debug, Deserialize, Serialize)]
pub struct ExternalIpResultsPage {
///list of items on this page of results
pub items: Vec<ExternalIp>,
///token used to fetch the next page of results (if any)
#[serde(default, skip_serializing_if = "Option::is_none")]
pub next_page: Option<String>,
}
2023-02-05 01:22:55 +00:00
impl From<&ExternalIpResultsPage> for ExternalIpResultsPage {
fn from(value: &ExternalIpResultsPage) -> Self {
value.clone()
}
}
2022-07-03 02:09:38 +00:00
///The name and type information for a field of a timeseries schema.
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "The name and type information for a field of a
/// timeseries schema.", "type": "object",
/// "required": [
/// "name",
/// "source",
/// "ty"
/// ],
/// "properties": {
/// "name": {
/// "type": "string"
/// },
/// "source": {
/// "$ref": "#/components/schemas/FieldSource"
/// },
/// "ty": {
/// "$ref": "#/components/schemas/FieldType"
/// }
/// }
///}
/// ```
/// </details>
2022-07-12 17:57:06 +00:00
#[derive(Clone, Debug, Deserialize, Serialize)]
2022-01-05 20:02:46 +00:00
pub struct FieldSchema {
pub name: String,
pub source: FieldSource,
pub ty: FieldType,
}
2023-02-05 01:22:55 +00:00
impl From<&FieldSchema> for FieldSchema {
fn from(value: &FieldSchema) -> Self {
value.clone()
}
}
2022-07-03 02:09:38 +00:00
///The source from which a field is derived, the target or metric.
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "The source from which a field is derived, the target or
/// metric.", "type": "string",
/// "enum": [
/// "target",
/// "metric"
/// ]
///}
/// ```
/// </details>
2022-07-12 17:57:06 +00:00
#[derive(Clone, Copy, Debug, Deserialize, Eq, Hash, Ord, PartialEq, PartialOrd, Serialize)]
2022-01-05 20:02:46 +00:00
pub enum FieldSource {
2022-05-23 15:49:37 +00:00
#[serde(rename = "target")]
2022-01-05 20:02:46 +00:00
Target,
2022-05-23 15:49:37 +00:00
#[serde(rename = "metric")]
2022-01-05 20:02:46 +00:00
Metric,
}
2023-02-05 01:22:55 +00:00
impl From<&FieldSource> for FieldSource {
fn from(value: &FieldSource) -> Self {
value.clone()
}
}
2022-01-05 20:02:46 +00:00
impl ToString for FieldSource {
fn to_string(&self) -> String {
2022-03-08 07:22:44 +00:00
match *self {
2022-07-12 17:57:06 +00:00
Self::Target => "target".to_string(),
Self::Metric => "metric".to_string(),
}
}
}
impl std::str::FromStr for FieldSource {
type Err = &'static str;
2023-01-25 17:19:15 +00:00
fn from_str(value: &str) -> Result<Self, &'static str> {
2022-07-12 17:57:06 +00:00
match value {
"target" => Ok(Self::Target),
"metric" => Ok(Self::Metric),
_ => Err("invalid value"),
2022-01-05 20:02:46 +00:00
}
}
}
2023-01-25 17:19:15 +00:00
impl std::convert::TryFrom<&str> for FieldSource {
type Error = &'static str;
fn try_from(value: &str) -> Result<Self, &'static str> {
value.parse()
}
}
impl std::convert::TryFrom<&String> for FieldSource {
type Error = &'static str;
fn try_from(value: &String) -> Result<Self, &'static str> {
value.parse()
}
}
2023-01-30 20:17:51 +00:00
impl std::convert::TryFrom<String> for FieldSource {
type Error = &'static str;
fn try_from(value: String) -> Result<Self, &'static str> {
value.parse()
}
}
2022-07-03 02:09:38 +00:00
///The `FieldType` identifies the data type of a target or metric field.
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "The `FieldType` identifies the data type of a target or
/// metric field.", "type": "string",
/// "enum": [
/// "string",
/// "i64",
/// "ip_addr",
/// "uuid",
/// "bool"
/// ]
///}
/// ```
/// </details>
2022-07-12 17:57:06 +00:00
#[derive(Clone, Copy, Debug, Deserialize, Eq, Hash, Ord, PartialEq, PartialOrd, Serialize)]
2022-01-05 20:02:46 +00:00
pub enum FieldType {
2022-05-23 15:49:37 +00:00
#[serde(rename = "string")]
2022-01-05 20:02:46 +00:00
String,
2022-05-23 15:49:37 +00:00
#[serde(rename = "i64")]
2022-01-05 20:02:46 +00:00
I64,
2022-05-23 15:49:37 +00:00
#[serde(rename = "ip_addr")]
2022-01-05 20:02:46 +00:00
IpAddr,
2022-05-23 15:49:37 +00:00
#[serde(rename = "uuid")]
2022-01-05 20:02:46 +00:00
Uuid,
2022-05-23 15:49:37 +00:00
#[serde(rename = "bool")]
2022-01-05 20:02:46 +00:00
Bool,
}
2023-02-05 01:22:55 +00:00
impl From<&FieldType> for FieldType {
fn from(value: &FieldType) -> Self {
value.clone()
}
}
2022-01-05 20:02:46 +00:00
impl ToString for FieldType {
fn to_string(&self) -> String {
2022-03-08 07:22:44 +00:00
match *self {
2022-07-12 17:57:06 +00:00
Self::String => "string".to_string(),
Self::I64 => "i64".to_string(),
Self::IpAddr => "ip_addr".to_string(),
Self::Uuid => "uuid".to_string(),
Self::Bool => "bool".to_string(),
2022-05-23 15:49:37 +00:00
}
}
}
2022-07-12 17:57:06 +00:00
impl std::str::FromStr for FieldType {
type Err = &'static str;
2023-01-25 17:19:15 +00:00
fn from_str(value: &str) -> Result<Self, &'static str> {
2022-07-12 17:57:06 +00:00
match value {
"string" => Ok(Self::String),
"i64" => Ok(Self::I64),
"ip_addr" => Ok(Self::IpAddr),
"uuid" => Ok(Self::Uuid),
"bool" => Ok(Self::Bool),
_ => Err("invalid value"),
}
}
}
2023-01-25 17:19:15 +00:00
impl std::convert::TryFrom<&str> for FieldType {
type Error = &'static str;
fn try_from(value: &str) -> Result<Self, &'static str> {
value.parse()
}
}
impl std::convert::TryFrom<&String> for FieldType {
type Error = &'static str;
fn try_from(value: &String) -> Result<Self, &'static str> {
value.parse()
}
}
2023-01-30 20:17:51 +00:00
impl std::convert::TryFrom<String> for FieldType {
type Error = &'static str;
fn try_from(value: String) -> Result<Self, &'static str> {
value.parse()
}
}
2023-12-13 09:14:28 +00:00
///FleetRole
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "type": "string",
/// "enum": [
/// "admin",
/// "collaborator",
/// "viewer"
/// ]
///}
/// ```
/// </details>
2022-07-12 17:57:06 +00:00
#[derive(Clone, Copy, Debug, Deserialize, Eq, Hash, Ord, PartialEq, PartialOrd, Serialize)]
2022-07-08 01:35:36 +00:00
pub enum FleetRole {
2022-05-23 15:49:37 +00:00
#[serde(rename = "admin")]
Admin,
#[serde(rename = "collaborator")]
Collaborator,
#[serde(rename = "viewer")]
Viewer,
}
2023-02-05 01:22:55 +00:00
impl From<&FleetRole> for FleetRole {
fn from(value: &FleetRole) -> Self {
value.clone()
}
}
2022-07-08 01:35:36 +00:00
impl ToString for FleetRole {
2022-05-23 15:49:37 +00:00
fn to_string(&self) -> String {
match *self {
2022-07-12 17:57:06 +00:00
Self::Admin => "admin".to_string(),
Self::Collaborator => "collaborator".to_string(),
Self::Viewer => "viewer".to_string(),
}
}
}
impl std::str::FromStr for FleetRole {
type Err = &'static str;
2023-01-25 17:19:15 +00:00
fn from_str(value: &str) -> Result<Self, &'static str> {
2022-07-12 17:57:06 +00:00
match value {
"admin" => Ok(Self::Admin),
"collaborator" => Ok(Self::Collaborator),
"viewer" => Ok(Self::Viewer),
_ => Err("invalid value"),
2022-01-05 20:02:46 +00:00
}
}
}
2023-01-25 17:19:15 +00:00
impl std::convert::TryFrom<&str> for FleetRole {
type Error = &'static str;
fn try_from(value: &str) -> Result<Self, &'static str> {
value.parse()
}
}
impl std::convert::TryFrom<&String> for FleetRole {
type Error = &'static str;
fn try_from(value: &String) -> Result<Self, &'static str> {
value.parse()
}
}
2023-01-30 20:17:51 +00:00
impl std::convert::TryFrom<String> for FleetRole {
type Error = &'static str;
fn try_from(value: String) -> Result<Self, &'static str> {
value.parse()
}
}
2022-07-03 02:09:38 +00:00
///Client view of a [`Policy`], which describes how this resource may be
/// accessed
///
///Note that the Policy only describes access granted explicitly for this
/// resource. The policies of parent resources can also cause a user to
/// have access to this resource.
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "Client view of a [`Policy`], which describes how this
/// resource may be accessed\n\nNote that the Policy only describes access
/// granted explicitly for this resource. The policies of parent resources
/// can also cause a user to have access to this resource.",
/// "type": "object",
/// "required": [
/// "role_assignments"
/// ],
/// "properties": {
/// "role_assignments": {
/// "description": "Roles directly assigned on this resource",
/// "type": "array",
/// "items": {
/// "$ref": "#/components/schemas/FleetRoleRoleAssignment"
/// }
/// }
/// }
///}
/// ```
/// </details>
2022-07-12 17:57:06 +00:00
#[derive(Clone, Debug, Deserialize, Serialize)]
2022-07-08 01:35:36 +00:00
pub struct FleetRolePolicy {
2022-07-03 02:09:38 +00:00
///Roles directly assigned on this resource
2022-07-08 01:35:36 +00:00
pub role_assignments: Vec<FleetRoleRoleAssignment>,
2022-05-23 15:49:37 +00:00
}
2023-02-05 01:22:55 +00:00
impl From<&FleetRolePolicy> for FleetRolePolicy {
fn from(value: &FleetRolePolicy) -> Self {
value.clone()
}
}
2022-07-03 02:09:38 +00:00
///Describes the assignment of a particular role on a particular resource
/// to a particular identity (user, group, etc.)
///
///The resource is not part of this structure. Rather, [`RoleAssignment`]s
/// are put into a [`Policy`] and that Policy is applied to a particular
/// resource.
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "Describes the assignment of a particular role on a
/// particular resource to a particular identity (user, group, etc.)\n\nThe
/// resource is not part of this structure. Rather, [`RoleAssignment`]s are
/// put into a [`Policy`] and that Policy is applied to a particular
/// resource.", "type": "object",
/// "required": [
/// "identity_id",
/// "identity_type",
/// "role_name"
/// ],
/// "properties": {
/// "identity_id": {
/// "type": "string",
/// "format": "uuid"
/// },
/// "identity_type": {
/// "$ref": "#/components/schemas/IdentityType"
/// },
/// "role_name": {
/// "$ref": "#/components/schemas/FleetRole"
/// }
/// }
///}
/// ```
/// </details>
2022-07-12 17:57:06 +00:00
#[derive(Clone, Debug, Deserialize, Serialize)]
2022-07-08 01:35:36 +00:00
pub struct FleetRoleRoleAssignment {
2022-05-23 15:49:37 +00:00
pub identity_id: uuid::Uuid,
pub identity_type: IdentityType,
2022-07-08 01:35:36 +00:00
pub role_name: FleetRole,
2022-05-23 15:49:37 +00:00
}
2023-02-05 01:22:55 +00:00
impl From<&FleetRoleRoleAssignment> for FleetRoleRoleAssignment {
fn from(value: &FleetRoleRoleAssignment) -> Self {
value.clone()
}
}
2022-07-03 02:09:38 +00:00
///Client view of global Images
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "Client view of global Images",
/// "type": "object",
/// "required": [
/// "block_size",
/// "description",
/// "distribution",
/// "id",
/// "name",
/// "size",
/// "time_created",
/// "time_modified",
/// "version"
/// ],
/// "properties": {
/// "block_size": {
/// "description": "size of blocks in bytes",
/// "allOf": [
/// {
/// "$ref": "#/components/schemas/ByteCount"
/// }
/// ]
/// },
/// "description": {
/// "description": "human-readable free-form text about a resource",
/// "type": "string"
/// },
/// "digest": {
/// "description": "Hash of the image contents, if applicable",
/// "allOf": [
/// {
/// "$ref": "#/components/schemas/Digest"
/// }
/// ]
/// },
/// "distribution": {
/// "description": "Image distribution",
/// "type": "string"
/// },
/// "id": {
/// "description": "unique, immutable, system-controlled identifier for
/// each resource", "type": "string",
/// "format": "uuid"
/// },
/// "name": {
/// "description": "unique, mutable, user-controlled identifier for
/// each resource", "allOf": [
/// {
/// "$ref": "#/components/schemas/Name"
/// }
/// ]
/// },
/// "size": {
/// "description": "total size in bytes",
/// "allOf": [
/// {
/// "$ref": "#/components/schemas/ByteCount"
/// }
/// ]
/// },
/// "time_created": {
/// "description": "timestamp when this resource was created",
/// "type": "string",
/// "format": "date-time"
/// },
/// "time_modified": {
/// "description": "timestamp when this resource was last modified",
/// "type": "string",
/// "format": "date-time"
/// },
/// "url": {
/// "description": "URL source of this image, if any",
/// "type": [
/// "string",
/// "null"
/// ]
/// },
/// "version": {
/// "description": "Image version",
/// "type": "string"
/// }
/// }
///}
/// ```
/// </details>
2022-07-12 17:57:06 +00:00
#[derive(Clone, Debug, Deserialize, Serialize)]
2022-05-23 15:49:37 +00:00
pub struct GlobalImage {
2022-07-03 02:09:38 +00:00
///size of blocks in bytes
2022-05-23 15:49:37 +00:00
pub block_size: ByteCount,
2022-07-03 02:09:38 +00:00
///human-readable free-form text about a resource
2022-05-23 15:49:37 +00:00
pub description: String,
2022-07-03 02:09:38 +00:00
///Hash of the image contents, if applicable
2022-05-23 15:49:37 +00:00
#[serde(default, skip_serializing_if = "Option::is_none")]
pub digest: Option<Digest>,
2022-07-08 01:35:36 +00:00
///Image distribution
pub distribution: String,
2022-07-03 02:09:38 +00:00
///unique, immutable, system-controlled identifier for each resource
2022-05-23 15:49:37 +00:00
pub id: uuid::Uuid,
2022-07-03 02:09:38 +00:00
///unique, mutable, user-controlled identifier for each resource
2022-05-23 15:49:37 +00:00
pub name: Name,
2022-07-03 02:09:38 +00:00
///total size in bytes
2022-05-23 15:49:37 +00:00
pub size: ByteCount,
2022-07-03 02:09:38 +00:00
///timestamp when this resource was created
2022-05-23 15:49:37 +00:00
pub time_created: chrono::DateTime<chrono::offset::Utc>,
2022-07-03 02:09:38 +00:00
///timestamp when this resource was last modified
2022-05-23 15:49:37 +00:00
pub time_modified: chrono::DateTime<chrono::offset::Utc>,
2022-07-03 02:09:38 +00:00
///URL source of this image, if any
2022-05-23 15:49:37 +00:00
#[serde(default, skip_serializing_if = "Option::is_none")]
pub url: Option<String>,
2022-07-08 01:35:36 +00:00
///Image version
pub version: String,
}
2023-02-05 01:22:55 +00:00
impl From<&GlobalImage> for GlobalImage {
fn from(value: &GlobalImage) -> Self {
value.clone()
}
}
2022-07-08 01:35:36 +00:00
///Create-time parameters for an
2023-02-01 05:28:12 +00:00
/// [`GlobalImage`](crate::external_api::views::GlobalImage)
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "Create-time parameters for an
/// [`GlobalImage`](crate::external_api::views::GlobalImage)",
/// "type": "object",
/// "required": [
/// "block_size",
/// "description",
/// "distribution",
/// "name",
/// "source"
/// ],
/// "properties": {
/// "block_size": {
/// "description": "block size in bytes",
/// "allOf": [
/// {
/// "$ref": "#/components/schemas/BlockSize"
/// }
/// ]
/// },
/// "description": {
/// "type": "string"
/// },
/// "distribution": {
/// "description": "OS image distribution",
/// "allOf": [
/// {
/// "$ref": "#/components/schemas/Distribution"
/// }
/// ]
/// },
/// "name": {
/// "$ref": "#/components/schemas/Name"
/// },
/// "source": {
/// "description": "The source of the image's contents.",
/// "allOf": [
/// {
/// "$ref": "#/components/schemas/ImageSource"
/// }
/// ]
/// }
/// }
///}
/// ```
/// </details>
2022-07-12 17:57:06 +00:00
#[derive(Clone, Debug, Deserialize, Serialize)]
2022-07-08 01:35:36 +00:00
pub struct GlobalImageCreate {
///block size in bytes
pub block_size: BlockSize,
pub description: String,
///OS image distribution
pub distribution: Distribution,
pub name: Name,
///The source of the image's contents.
pub source: ImageSource,
2022-05-23 15:49:37 +00:00
}
2023-02-05 01:22:55 +00:00
impl From<&GlobalImageCreate> for GlobalImageCreate {
fn from(value: &GlobalImageCreate) -> Self {
value.clone()
}
}
2022-07-03 02:09:38 +00:00
///A single page of results
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "A single page of results",
/// "type": "object",
/// "required": [
/// "items"
/// ],
/// "properties": {
/// "items": {
/// "description": "list of items on this page of results",
/// "type": "array",
/// "items": {
/// "$ref": "#/components/schemas/GlobalImage"
/// }
/// },
/// "next_page": {
/// "description": "token used to fetch the next page of results (if
/// any)", "type": [
/// "string",
/// "null"
/// ]
/// }
/// }
///}
/// ```
/// </details>
2022-07-12 17:57:06 +00:00
#[derive(Clone, Debug, Deserialize, Serialize)]
2022-05-23 15:49:37 +00:00
pub struct GlobalImageResultsPage {
2022-07-03 02:09:38 +00:00
///list of items on this page of results
2022-05-23 15:49:37 +00:00
pub items: Vec<GlobalImage>,
2022-07-03 02:09:38 +00:00
///token used to fetch the next page of results (if any)
2022-05-23 15:49:37 +00:00
#[serde(default, skip_serializing_if = "Option::is_none")]
pub next_page: Option<String>,
}
2023-02-05 01:22:55 +00:00
impl From<&GlobalImageResultsPage> for GlobalImageResultsPage {
fn from(value: &GlobalImageResultsPage) -> Self {
value.clone()
}
}
2023-02-01 05:28:12 +00:00
///Client view of a [`Group`]
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "Client view of a [`Group`]",
/// "type": "object",
/// "required": [
/// "display_name",
/// "id",
/// "silo_id"
/// ],
/// "properties": {
/// "display_name": {
/// "description": "Human-readable name that can identify the group",
/// "type": "string"
/// },
/// "id": {
/// "type": "string",
/// "format": "uuid"
/// },
/// "silo_id": {
/// "description": "Uuid of the silo to which this group belongs",
/// "type": "string",
/// "format": "uuid"
/// }
/// }
///}
/// ```
/// </details>
2023-02-01 05:28:12 +00:00
#[derive(Clone, Debug, Deserialize, Serialize)]
pub struct Group {
///Human-readable name that can identify the group
pub display_name: String,
pub id: uuid::Uuid,
///Uuid of the silo to which this group belongs
pub silo_id: uuid::Uuid,
}
2023-02-05 01:22:55 +00:00
impl From<&Group> for Group {
fn from(value: &Group) -> Self {
value.clone()
}
}
2023-02-01 05:28:12 +00:00
///A single page of results
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "A single page of results",
/// "type": "object",
/// "required": [
/// "items"
/// ],
/// "properties": {
/// "items": {
/// "description": "list of items on this page of results",
/// "type": "array",
/// "items": {
/// "$ref": "#/components/schemas/Group"
/// }
/// },
/// "next_page": {
/// "description": "token used to fetch the next page of results (if
/// any)", "type": [
/// "string",
/// "null"
/// ]
/// }
/// }
///}
/// ```
/// </details>
2023-02-01 05:28:12 +00:00
#[derive(Clone, Debug, Deserialize, Serialize)]
pub struct GroupResultsPage {
///list of items on this page of results
pub items: Vec<Group>,
///token used to fetch the next page of results (if any)
#[serde(default, skip_serializing_if = "Option::is_none")]
pub next_page: Option<String>,
}
2023-02-05 01:22:55 +00:00
impl From<&GroupResultsPage> for GroupResultsPage {
fn from(value: &GroupResultsPage) -> Self {
value.clone()
}
}
2022-07-27 04:23:01 +00:00
///A simple type for managing a histogram metric.
///
///A histogram maintains the count of any number of samples, over a set of
/// bins. Bins are specified on construction via their _left_ edges,
/// inclusive. There can't be any "gaps" in the bins, and an additional bin
/// may be added to the left, right, or both so that the bins extend to the
/// entire range of the support.
///
///Note that any gaps, unsorted bins, or non-finite values will result in
/// an error.
///
///Example ------- ```rust use oximeter::histogram::{BinRange, Histogram};
///
///let edges = [0i64, 10, 20]; let mut hist =
/// Histogram::new(&edges).unwrap(); assert_eq!(hist.n_bins(), 4); // One
/// additional bin for the range (20..) assert_eq!(hist.n_samples(), 0);
/// hist.sample(4); hist.sample(100); assert_eq!(hist.n_samples(), 2);
///
///let data = hist.iter().collect::<Vec<_>>(); assert_eq!(data[0].range,
/// BinRange::range(i64::MIN, 0)); // An additional bin for `..0`
/// assert_eq!(data[0].count, 0); // Nothing is in this bin
///
///assert_eq!(data[1].range, BinRange::range(0, 10)); // The range `0..10`
/// assert_eq!(data[1].count, 1); // 4 is sampled into this bin ```
///
///Notes -----
///
///Histograms may be constructed either from their left bin edges, or from
/// a sequence of ranges. In either case, the left-most bin may be converted
/// upon construction. In particular, if the left-most value is not equal to
/// the minimum of the support, a new bin will be added from the minimum to
/// that provided value. If the left-most value _is_ the support's minimum,
/// because the provided bin was unbounded below, such as `(..0)`, then that
/// bin will be converted into one bounded below, `(MIN..0)` in this case.
///
///The short of this is that, most of the time, it shouldn't matter. If one
/// specifies the extremes of the support as their bins, be aware that the
/// left-most may be converted from a `BinRange::RangeTo` into a
/// `BinRange::Range`. In other words, the first bin of a histogram is
/// _always_ a `Bin::Range` or a `Bin::RangeFrom` after construction. In
/// fact, every bin is one of those variants, the `BinRange::RangeTo` is
/// only provided as a convenience during construction.
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "A simple type for managing a histogram metric.\n\nA
/// histogram maintains the count of any number of samples, over a set of
/// bins. Bins are specified on construction via their _left_ edges,
/// inclusive. There can't be any \"gaps\" in the bins, and an additional
/// bin may be added to the left, right, or both so that the bins extend to
/// the entire range of the support.\n\nNote that any gaps, unsorted bins,
/// or non-finite values will result in an error.\n\nExample ------- ```rust
/// use oximeter::histogram::{BinRange, Histogram};\n\nlet edges = [0i64,
/// 10, 20]; let mut hist = Histogram::new(&edges).unwrap();
/// assert_eq!(hist.n_bins(), 4); // One additional bin for the range (20..)
/// assert_eq!(hist.n_samples(), 0); hist.sample(4); hist.sample(100);
/// assert_eq!(hist.n_samples(), 2);\n\nlet data =
/// hist.iter().collect::<Vec<_>>(); assert_eq!(data[0].range,
/// BinRange::range(i64::MIN, 0)); // An additional bin for `..0`
/// assert_eq!(data[0].count, 0); // Nothing is in this
/// bin\n\nassert_eq!(data[1].range, BinRange::range(0, 10)); // The range
/// `0..10` assert_eq!(data[1].count, 1); // 4 is sampled into this bin
/// ```\n\nNotes -----\n\nHistograms may be constructed either from their
/// left bin edges, or from a sequence of ranges. In either case, the
/// left-most bin may be converted upon construction. In particular, if the
/// left-most value is not equal to the minimum of the support, a new bin
/// will be added from the minimum to that provided value. If the left-most
/// value _is_ the support's minimum, because the provided bin was unbounded
/// below, such as `(..0)`, then that bin will be converted into one bounded
/// below, `(MIN..0)` in this case.\n\nThe short of this is that, most of
/// the time, it shouldn't matter. If one specifies the extremes of the
/// support as their bins, be aware that the left-most may be converted from
/// a `BinRange::RangeTo` into a `BinRange::Range`. In other words, the
/// first bin of a histogram is _always_ a `Bin::Range` or a
/// `Bin::RangeFrom` after construction. In fact, every bin is one of those
/// variants, the `BinRange::RangeTo` is only provided as a convenience
/// during construction.", "type": "object",
/// "required": [
/// "bins",
/// "n_samples",
/// "start_time"
/// ],
/// "properties": {
/// "bins": {
/// "type": "array",
/// "items": {
/// "$ref": "#/components/schemas/Bindouble"
/// }
/// },
/// "n_samples": {
/// "type": "integer",
/// "format": "uint64",
/// "minimum": 0.0
/// },
/// "start_time": {
/// "type": "string",
/// "format": "date-time"
/// }
/// }
///}
/// ```
/// </details>
2022-07-27 04:23:01 +00:00
#[derive(Clone, Debug, Deserialize, Serialize)]
pub struct Histogramdouble {
pub bins: Vec<Bindouble>,
pub n_samples: u64,
pub start_time: chrono::DateTime<chrono::offset::Utc>,
}
2023-02-05 01:22:55 +00:00
impl From<&Histogramdouble> for Histogramdouble {
fn from(value: &Histogramdouble) -> Self {
value.clone()
}
}
2022-07-27 04:23:01 +00:00
///A simple type for managing a histogram metric.
///
///A histogram maintains the count of any number of samples, over a set of
/// bins. Bins are specified on construction via their _left_ edges,
/// inclusive. There can't be any "gaps" in the bins, and an additional bin
/// may be added to the left, right, or both so that the bins extend to the
/// entire range of the support.
///
///Note that any gaps, unsorted bins, or non-finite values will result in
/// an error.
///
///Example ------- ```rust use oximeter::histogram::{BinRange, Histogram};
///
///let edges = [0i64, 10, 20]; let mut hist =
/// Histogram::new(&edges).unwrap(); assert_eq!(hist.n_bins(), 4); // One
/// additional bin for the range (20..) assert_eq!(hist.n_samples(), 0);
/// hist.sample(4); hist.sample(100); assert_eq!(hist.n_samples(), 2);
///
///let data = hist.iter().collect::<Vec<_>>(); assert_eq!(data[0].range,
/// BinRange::range(i64::MIN, 0)); // An additional bin for `..0`
/// assert_eq!(data[0].count, 0); // Nothing is in this bin
///
///assert_eq!(data[1].range, BinRange::range(0, 10)); // The range `0..10`
/// assert_eq!(data[1].count, 1); // 4 is sampled into this bin ```
///
///Notes -----
///
///Histograms may be constructed either from their left bin edges, or from
/// a sequence of ranges. In either case, the left-most bin may be converted
/// upon construction. In particular, if the left-most value is not equal to
/// the minimum of the support, a new bin will be added from the minimum to
/// that provided value. If the left-most value _is_ the support's minimum,
/// because the provided bin was unbounded below, such as `(..0)`, then that
/// bin will be converted into one bounded below, `(MIN..0)` in this case.
///
///The short of this is that, most of the time, it shouldn't matter. If one
/// specifies the extremes of the support as their bins, be aware that the
/// left-most may be converted from a `BinRange::RangeTo` into a
/// `BinRange::Range`. In other words, the first bin of a histogram is
/// _always_ a `Bin::Range` or a `Bin::RangeFrom` after construction. In
/// fact, every bin is one of those variants, the `BinRange::RangeTo` is
/// only provided as a convenience during construction.
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "A simple type for managing a histogram metric.\n\nA
/// histogram maintains the count of any number of samples, over a set of
/// bins. Bins are specified on construction via their _left_ edges,
/// inclusive. There can't be any \"gaps\" in the bins, and an additional
/// bin may be added to the left, right, or both so that the bins extend to
/// the entire range of the support.\n\nNote that any gaps, unsorted bins,
/// or non-finite values will result in an error.\n\nExample ------- ```rust
/// use oximeter::histogram::{BinRange, Histogram};\n\nlet edges = [0i64,
/// 10, 20]; let mut hist = Histogram::new(&edges).unwrap();
/// assert_eq!(hist.n_bins(), 4); // One additional bin for the range (20..)
/// assert_eq!(hist.n_samples(), 0); hist.sample(4); hist.sample(100);
/// assert_eq!(hist.n_samples(), 2);\n\nlet data =
/// hist.iter().collect::<Vec<_>>(); assert_eq!(data[0].range,
/// BinRange::range(i64::MIN, 0)); // An additional bin for `..0`
/// assert_eq!(data[0].count, 0); // Nothing is in this
/// bin\n\nassert_eq!(data[1].range, BinRange::range(0, 10)); // The range
/// `0..10` assert_eq!(data[1].count, 1); // 4 is sampled into this bin
/// ```\n\nNotes -----\n\nHistograms may be constructed either from their
/// left bin edges, or from a sequence of ranges. In either case, the
/// left-most bin may be converted upon construction. In particular, if the
/// left-most value is not equal to the minimum of the support, a new bin
/// will be added from the minimum to that provided value. If the left-most
/// value _is_ the support's minimum, because the provided bin was unbounded
/// below, such as `(..0)`, then that bin will be converted into one bounded
/// below, `(MIN..0)` in this case.\n\nThe short of this is that, most of
/// the time, it shouldn't matter. If one specifies the extremes of the
/// support as their bins, be aware that the left-most may be converted from
/// a `BinRange::RangeTo` into a `BinRange::Range`. In other words, the
/// first bin of a histogram is _always_ a `Bin::Range` or a
/// `Bin::RangeFrom` after construction. In fact, every bin is one of those
/// variants, the `BinRange::RangeTo` is only provided as a convenience
/// during construction.", "type": "object",
/// "required": [
/// "bins",
/// "n_samples",
/// "start_time"
/// ],
/// "properties": {
/// "bins": {
/// "type": "array",
/// "items": {
/// "$ref": "#/components/schemas/Binint64"
/// }
/// },
/// "n_samples": {
/// "type": "integer",
/// "format": "uint64",
/// "minimum": 0.0
/// },
/// "start_time": {
/// "type": "string",
/// "format": "date-time"
/// }
/// }
///}
/// ```
/// </details>
2022-07-27 04:23:01 +00:00
#[derive(Clone, Debug, Deserialize, Serialize)]
pub struct Histogramint64 {
pub bins: Vec<Binint64>,
pub n_samples: u64,
pub start_time: chrono::DateTime<chrono::offset::Utc>,
}
2023-02-05 01:22:55 +00:00
impl From<&Histogramint64> for Histogramint64 {
fn from(value: &Histogramint64) -> Self {
value.clone()
}
}
2022-07-03 02:09:38 +00:00
///Supported set of sort modes for scanning by id only.
///
///Currently, we only support scanning in ascending order.
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "Supported set of sort modes for scanning by id
/// only.\n\nCurrently, we only support scanning in ascending order.",
/// "oneOf": [
/// {
/// "description": "sort in increasing order of \"id\"",
/// "type": "string",
/// "enum": [
/// "id_ascending"
/// ]
/// }
/// ]
///}
/// ```
/// </details>
2022-07-12 17:57:06 +00:00
#[derive(Clone, Copy, Debug, Deserialize, Eq, Hash, Ord, PartialEq, PartialOrd, Serialize)]
2021-12-10 02:15:24 +00:00
pub enum IdSortMode {
2023-02-01 05:28:12 +00:00
///sort in increasing order of "id"
2022-05-23 15:49:37 +00:00
#[serde(rename = "id_ascending")]
2021-12-10 02:15:24 +00:00
IdAscending,
}
2023-02-05 01:22:55 +00:00
impl From<&IdSortMode> for IdSortMode {
fn from(value: &IdSortMode) -> Self {
value.clone()
}
}
2021-12-10 02:15:24 +00:00
impl ToString for IdSortMode {
fn to_string(&self) -> String {
2022-03-08 07:22:44 +00:00
match *self {
2022-07-12 17:57:06 +00:00
Self::IdAscending => "id_ascending".to_string(),
}
}
}
impl std::str::FromStr for IdSortMode {
type Err = &'static str;
2023-01-25 17:19:15 +00:00
fn from_str(value: &str) -> Result<Self, &'static str> {
2022-07-12 17:57:06 +00:00
match value {
"id_ascending" => Ok(Self::IdAscending),
_ => Err("invalid value"),
2022-05-23 15:49:37 +00:00
}
}
}
2023-01-25 17:19:15 +00:00
impl std::convert::TryFrom<&str> for IdSortMode {
type Error = &'static str;
fn try_from(value: &str) -> Result<Self, &'static str> {
value.parse()
}
}
impl std::convert::TryFrom<&String> for IdSortMode {
type Error = &'static str;
fn try_from(value: &String) -> Result<Self, &'static str> {
value.parse()
}
}
2023-01-30 20:17:51 +00:00
impl std::convert::TryFrom<String> for IdSortMode {
type Error = &'static str;
fn try_from(value: String) -> Result<Self, &'static str> {
value.parse()
}
}
2022-07-08 01:35:36 +00:00
///Client view of an [`IdentityProvider`]
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "Client view of an [`IdentityProvider`]",
/// "type": "object",
/// "required": [
/// "description",
/// "id",
/// "name",
/// "provider_type",
/// "time_created",
/// "time_modified"
/// ],
/// "properties": {
/// "description": {
/// "description": "human-readable free-form text about a resource",
/// "type": "string"
/// },
/// "id": {
/// "description": "unique, immutable, system-controlled identifier for
/// each resource", "type": "string",
/// "format": "uuid"
/// },
/// "name": {
/// "description": "unique, mutable, user-controlled identifier for
/// each resource", "allOf": [
/// {
/// "$ref": "#/components/schemas/Name"
/// }
/// ]
/// },
/// "provider_type": {
/// "description": "Identity provider type",
/// "allOf": [
/// {
/// "$ref": "#/components/schemas/IdentityProviderType"
/// }
/// ]
/// },
/// "time_created": {
/// "description": "timestamp when this resource was created",
/// "type": "string",
/// "format": "date-time"
/// },
/// "time_modified": {
/// "description": "timestamp when this resource was last modified",
/// "type": "string",
/// "format": "date-time"
/// }
/// }
///}
/// ```
/// </details>
2022-07-12 17:57:06 +00:00
#[derive(Clone, Debug, Deserialize, Serialize)]
2022-07-08 01:35:36 +00:00
pub struct IdentityProvider {
///human-readable free-form text about a resource
pub description: String,
///unique, immutable, system-controlled identifier for each resource
pub id: uuid::Uuid,
///unique, mutable, user-controlled identifier for each resource
pub name: Name,
///Identity provider type
pub provider_type: IdentityProviderType,
///timestamp when this resource was created
pub time_created: chrono::DateTime<chrono::offset::Utc>,
///timestamp when this resource was last modified
pub time_modified: chrono::DateTime<chrono::offset::Utc>,
}
2023-02-05 01:22:55 +00:00
impl From<&IdentityProvider> for IdentityProvider {
fn from(value: &IdentityProvider) -> Self {
value.clone()
}
}
2022-07-08 01:35:36 +00:00
///A single page of results
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "A single page of results",
/// "type": "object",
/// "required": [
/// "items"
/// ],
/// "properties": {
/// "items": {
/// "description": "list of items on this page of results",
/// "type": "array",
/// "items": {
/// "$ref": "#/components/schemas/IdentityProvider"
/// }
/// },
/// "next_page": {
/// "description": "token used to fetch the next page of results (if
/// any)", "type": [
/// "string",
/// "null"
/// ]
/// }
/// }
///}
/// ```
/// </details>
2022-07-12 17:57:06 +00:00
#[derive(Clone, Debug, Deserialize, Serialize)]
2022-07-08 01:35:36 +00:00
pub struct IdentityProviderResultsPage {
///list of items on this page of results
pub items: Vec<IdentityProvider>,
///token used to fetch the next page of results (if any)
#[serde(default, skip_serializing_if = "Option::is_none")]
pub next_page: Option<String>,
}
2023-02-05 01:22:55 +00:00
impl From<&IdentityProviderResultsPage> for IdentityProviderResultsPage {
fn from(value: &IdentityProviderResultsPage) -> Self {
value.clone()
}
}
2023-12-13 09:14:28 +00:00
///IdentityProviderType
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "oneOf": [
/// {
/// "description": "SAML identity provider",
/// "type": "string",
/// "enum": [
/// "saml"
/// ]
/// }
/// ]
///}
/// ```
/// </details>
2022-07-12 17:57:06 +00:00
#[derive(Clone, Copy, Debug, Deserialize, Eq, Hash, Ord, PartialEq, PartialOrd, Serialize)]
2022-07-08 01:35:36 +00:00
pub enum IdentityProviderType {
2023-02-01 05:28:12 +00:00
///SAML identity provider
2022-07-08 01:35:36 +00:00
#[serde(rename = "saml")]
Saml,
}
2023-02-05 01:22:55 +00:00
impl From<&IdentityProviderType> for IdentityProviderType {
fn from(value: &IdentityProviderType) -> Self {
value.clone()
}
}
2022-07-08 01:35:36 +00:00
impl ToString for IdentityProviderType {
fn to_string(&self) -> String {
match *self {
2022-07-12 17:57:06 +00:00
Self::Saml => "saml".to_string(),
}
}
}
impl std::str::FromStr for IdentityProviderType {
type Err = &'static str;
2023-01-25 17:19:15 +00:00
fn from_str(value: &str) -> Result<Self, &'static str> {
2022-07-12 17:57:06 +00:00
match value {
"saml" => Ok(Self::Saml),
_ => Err("invalid value"),
2022-07-08 01:35:36 +00:00
}
}
}
2023-01-25 17:19:15 +00:00
impl std::convert::TryFrom<&str> for IdentityProviderType {
type Error = &'static str;
fn try_from(value: &str) -> Result<Self, &'static str> {
value.parse()
}
}
impl std::convert::TryFrom<&String> for IdentityProviderType {
type Error = &'static str;
fn try_from(value: &String) -> Result<Self, &'static str> {
value.parse()
}
}
2023-01-30 20:17:51 +00:00
impl std::convert::TryFrom<String> for IdentityProviderType {
type Error = &'static str;
fn try_from(value: String) -> Result<Self, &'static str> {
value.parse()
}
}
2022-07-03 02:09:38 +00:00
///Describes what kind of identity is described by an id
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "Describes what kind of identity is described by an id",
/// "type": "string",
/// "enum": [
/// "silo_user",
/// "silo_group"
/// ]
///}
/// ```
/// </details>
2022-07-12 17:57:06 +00:00
#[derive(Clone, Copy, Debug, Deserialize, Eq, Hash, Ord, PartialEq, PartialOrd, Serialize)]
2022-05-23 15:49:37 +00:00
pub enum IdentityType {
#[serde(rename = "silo_user")]
SiloUser,
2023-02-01 05:28:12 +00:00
#[serde(rename = "silo_group")]
SiloGroup,
2022-05-23 15:49:37 +00:00
}
2023-02-05 01:22:55 +00:00
impl From<&IdentityType> for IdentityType {
fn from(value: &IdentityType) -> Self {
value.clone()
}
}
2022-05-23 15:49:37 +00:00
impl ToString for IdentityType {
fn to_string(&self) -> String {
match *self {
2022-07-12 17:57:06 +00:00
Self::SiloUser => "silo_user".to_string(),
2023-02-01 05:28:12 +00:00
Self::SiloGroup => "silo_group".to_string(),
2022-07-12 17:57:06 +00:00
}
}
}
impl std::str::FromStr for IdentityType {
type Err = &'static str;
2023-01-25 17:19:15 +00:00
fn from_str(value: &str) -> Result<Self, &'static str> {
2022-07-12 17:57:06 +00:00
match value {
"silo_user" => Ok(Self::SiloUser),
2023-02-01 05:28:12 +00:00
"silo_group" => Ok(Self::SiloGroup),
2022-07-12 17:57:06 +00:00
_ => Err("invalid value"),
2021-12-10 02:15:24 +00:00
}
}
}
2023-01-25 17:19:15 +00:00
impl std::convert::TryFrom<&str> for IdentityType {
type Error = &'static str;
fn try_from(value: &str) -> Result<Self, &'static str> {
value.parse()
}
}
impl std::convert::TryFrom<&String> for IdentityType {
type Error = &'static str;
fn try_from(value: &String) -> Result<Self, &'static str> {
value.parse()
}
}
2023-01-30 20:17:51 +00:00
impl std::convert::TryFrom<String> for IdentityType {
type Error = &'static str;
fn try_from(value: String) -> Result<Self, &'static str> {
value.parse()
}
}
2023-12-13 09:14:28 +00:00
///IdpMetadataSource
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "oneOf": [
/// {
/// "type": "object",
/// "required": [
/// "type",
/// "url"
/// ],
/// "properties": {
/// "type": {
/// "type": "string",
/// "enum": [
/// "url"
/// ]
/// },
/// "url": {
/// "type": "string"
/// }
/// }
/// },
/// {
/// "type": "object",
/// "required": [
/// "data",
/// "type"
/// ],
/// "properties": {
/// "data": {
/// "type": "string"
/// },
/// "type": {
/// "type": "string",
/// "enum": [
/// "base64_encoded_xml"
/// ]
/// }
/// }
/// }
/// ]
///}
/// ```
/// </details>
2022-07-12 17:57:06 +00:00
#[derive(Clone, Debug, Deserialize, Serialize)]
2022-07-08 01:35:36 +00:00
#[serde(tag = "type")]
pub enum IdpMetadataSource {
#[serde(rename = "url")]
Url { url: String },
#[serde(rename = "base64_encoded_xml")]
Base64EncodedXml { data: String },
}
2023-02-05 01:22:55 +00:00
impl From<&IdpMetadataSource> for IdpMetadataSource {
fn from(value: &IdpMetadataSource) -> Self {
value.clone()
}
}
2022-07-03 02:09:38 +00:00
///Client view of project Images
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "Client view of project Images",
/// "type": "object",
/// "required": [
/// "block_size",
/// "description",
/// "id",
/// "name",
/// "project_id",
/// "size",
/// "time_created",
/// "time_modified"
/// ],
/// "properties": {
/// "block_size": {
/// "description": "size of blocks in bytes",
/// "allOf": [
/// {
/// "$ref": "#/components/schemas/ByteCount"
/// }
/// ]
/// },
/// "description": {
/// "description": "human-readable free-form text about a resource",
/// "type": "string"
/// },
/// "digest": {
/// "description": "Hash of the image contents, if applicable",
/// "allOf": [
/// {
/// "$ref": "#/components/schemas/Digest"
/// }
/// ]
/// },
/// "id": {
/// "description": "unique, immutable, system-controlled identifier for
/// each resource", "type": "string",
/// "format": "uuid"
/// },
/// "name": {
/// "description": "unique, mutable, user-controlled identifier for
/// each resource", "allOf": [
/// {
/// "$ref": "#/components/schemas/Name"
/// }
/// ]
/// },
/// "project_id": {
/// "description": "The project the disk belongs to",
/// "type": "string",
/// "format": "uuid"
/// },
/// "size": {
/// "description": "total size in bytes",
/// "allOf": [
/// {
/// "$ref": "#/components/schemas/ByteCount"
/// }
/// ]
/// },
/// "time_created": {
/// "description": "timestamp when this resource was created",
/// "type": "string",
/// "format": "date-time"
/// },
/// "time_modified": {
/// "description": "timestamp when this resource was last modified",
/// "type": "string",
/// "format": "date-time"
/// },
/// "url": {
/// "description": "URL source of this image, if any",
/// "type": [
/// "string",
/// "null"
/// ]
/// },
/// "version": {
/// "description": "Version of this, if any",
/// "type": [
/// "string",
/// "null"
/// ]
/// }
/// }
///}
/// ```
/// </details>
2022-07-12 17:57:06 +00:00
#[derive(Clone, Debug, Deserialize, Serialize)]
2022-05-23 15:49:37 +00:00
pub struct Image {
2022-07-03 02:09:38 +00:00
///size of blocks in bytes
2022-05-23 15:49:37 +00:00
pub block_size: ByteCount,
2022-07-03 02:09:38 +00:00
///human-readable free-form text about a resource
2022-05-23 15:49:37 +00:00
pub description: String,
2022-07-03 02:09:38 +00:00
///Hash of the image contents, if applicable
2022-05-23 15:49:37 +00:00
#[serde(default, skip_serializing_if = "Option::is_none")]
pub digest: Option<Digest>,
2022-07-03 02:09:38 +00:00
///unique, immutable, system-controlled identifier for each resource
2022-05-23 15:49:37 +00:00
pub id: uuid::Uuid,
2022-07-03 02:09:38 +00:00
///unique, mutable, user-controlled identifier for each resource
2022-05-23 15:49:37 +00:00
pub name: Name,
2022-07-03 02:09:38 +00:00
///The project the disk belongs to
2022-05-23 15:49:37 +00:00
pub project_id: uuid::Uuid,
2022-07-03 02:09:38 +00:00
///total size in bytes
2022-05-23 15:49:37 +00:00
pub size: ByteCount,
2022-07-03 02:09:38 +00:00
///timestamp when this resource was created
2022-05-23 15:49:37 +00:00
pub time_created: chrono::DateTime<chrono::offset::Utc>,
2022-07-03 02:09:38 +00:00
///timestamp when this resource was last modified
2022-05-23 15:49:37 +00:00
pub time_modified: chrono::DateTime<chrono::offset::Utc>,
2022-07-03 02:09:38 +00:00
///URL source of this image, if any
2022-05-23 15:49:37 +00:00
#[serde(default, skip_serializing_if = "Option::is_none")]
pub url: Option<String>,
2022-07-03 02:09:38 +00:00
///Version of this, if any
2022-05-23 15:49:37 +00:00
#[serde(default, skip_serializing_if = "Option::is_none")]
pub version: Option<String>,
}
2023-02-05 01:22:55 +00:00
impl From<&Image> for Image {
fn from(value: &Image) -> Self {
value.clone()
}
}
2022-07-03 02:09:38 +00:00
///Create-time parameters for an
2023-02-01 05:28:12 +00:00
/// [`Image`](crate::external_api::views::Image)
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "Create-time parameters for an
/// [`Image`](crate::external_api::views::Image)", "type": "object",
/// "required": [
/// "block_size",
/// "description",
/// "name",
/// "source"
/// ],
/// "properties": {
/// "block_size": {
/// "description": "block size in bytes",
/// "allOf": [
/// {
/// "$ref": "#/components/schemas/BlockSize"
/// }
/// ]
/// },
/// "description": {
/// "type": "string"
/// },
/// "name": {
/// "$ref": "#/components/schemas/Name"
/// },
/// "source": {
/// "description": "The source of the image's contents.",
/// "allOf": [
/// {
/// "$ref": "#/components/schemas/ImageSource"
/// }
/// ]
/// }
/// }
///}
/// ```
/// </details>
2022-07-12 17:57:06 +00:00
#[derive(Clone, Debug, Deserialize, Serialize)]
2022-05-23 15:49:37 +00:00
pub struct ImageCreate {
2022-07-03 02:09:38 +00:00
///block size in bytes
2022-05-23 15:49:37 +00:00
pub block_size: BlockSize,
pub description: String,
pub name: Name,
2022-07-03 02:09:38 +00:00
///The source of the image's contents.
2022-05-23 15:49:37 +00:00
pub source: ImageSource,
}
2023-02-05 01:22:55 +00:00
impl From<&ImageCreate> for ImageCreate {
fn from(value: &ImageCreate) -> Self {
value.clone()
}
}
2022-07-03 02:09:38 +00:00
///A single page of results
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "A single page of results",
/// "type": "object",
/// "required": [
/// "items"
/// ],
/// "properties": {
/// "items": {
/// "description": "list of items on this page of results",
/// "type": "array",
/// "items": {
/// "$ref": "#/components/schemas/Image"
/// }
/// },
/// "next_page": {
/// "description": "token used to fetch the next page of results (if
/// any)", "type": [
/// "string",
/// "null"
/// ]
/// }
/// }
///}
/// ```
/// </details>
2022-07-12 17:57:06 +00:00
#[derive(Clone, Debug, Deserialize, Serialize)]
2022-05-23 15:49:37 +00:00
pub struct ImageResultsPage {
2022-07-03 02:09:38 +00:00
///list of items on this page of results
2022-05-23 15:49:37 +00:00
pub items: Vec<Image>,
2022-07-03 02:09:38 +00:00
///token used to fetch the next page of results (if any)
2022-05-23 15:49:37 +00:00
#[serde(default, skip_serializing_if = "Option::is_none")]
pub next_page: Option<String>,
}
2023-02-05 01:22:55 +00:00
impl From<&ImageResultsPage> for ImageResultsPage {
fn from(value: &ImageResultsPage) -> Self {
value.clone()
}
}
2022-07-03 02:09:38 +00:00
///The source of the underlying image.
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "The source of the underlying image.",
/// "oneOf": [
/// {
/// "type": "object",
/// "required": [
/// "type",
/// "url"
/// ],
/// "properties": {
/// "type": {
/// "type": "string",
/// "enum": [
/// "url"
/// ]
/// },
/// "url": {
/// "type": "string"
/// }
/// }
/// },
/// {
/// "type": "object",
/// "required": [
/// "id",
/// "type"
/// ],
/// "properties": {
/// "id": {
/// "type": "string",
/// "format": "uuid"
/// },
/// "type": {
/// "type": "string",
/// "enum": [
/// "snapshot"
/// ]
/// }
/// }
/// },
/// {
/// "description": "Boot the Alpine ISO that ships with the Propolis
/// zone. Intended for development purposes only.", "type":
/// "object", "required": [
/// "type"
/// ],
/// "properties": {
/// "type": {
/// "type": "string",
/// "enum": [
/// "you_can_boot_anything_as_long_as_its_alpine"
/// ]
/// }
/// }
/// }
/// ]
///}
/// ```
/// </details>
2022-07-12 17:57:06 +00:00
#[derive(Clone, Debug, Deserialize, Serialize)]
2022-07-08 01:35:36 +00:00
#[serde(tag = "type")]
2022-05-23 15:49:37 +00:00
pub enum ImageSource {
#[serde(rename = "url")]
2022-07-08 01:35:36 +00:00
Url { url: String },
2022-05-23 15:49:37 +00:00
#[serde(rename = "snapshot")]
2022-07-08 01:35:36 +00:00
Snapshot { id: uuid::Uuid },
#[serde(rename = "you_can_boot_anything_as_long_as_its_alpine")]
YouCanBootAnythingAsLongAsItsAlpine,
2022-05-23 15:49:37 +00:00
}
2023-02-05 01:22:55 +00:00
impl From<&ImageSource> for ImageSource {
fn from(value: &ImageSource) -> Self {
value.clone()
}
}
2022-07-03 02:09:38 +00:00
///Client view of an [`Instance`]
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "Client view of an [`Instance`]",
/// "type": "object",
/// "required": [
/// "description",
/// "hostname",
/// "id",
/// "memory",
/// "name",
/// "ncpus",
/// "project_id",
/// "run_state",
/// "time_created",
/// "time_modified",
/// "time_run_state_updated"
/// ],
/// "properties": {
/// "description": {
/// "description": "human-readable free-form text about a resource",
/// "type": "string"
/// },
/// "hostname": {
/// "description": "RFC1035-compliant hostname for the Instance.",
/// "type": "string"
/// },
/// "id": {
/// "description": "unique, immutable, system-controlled identifier for
/// each resource", "type": "string",
/// "format": "uuid"
/// },
/// "memory": {
/// "description": "memory allocated for this Instance",
/// "allOf": [
/// {
/// "$ref": "#/components/schemas/ByteCount"
/// }
/// ]
/// },
/// "name": {
/// "description": "unique, mutable, user-controlled identifier for
/// each resource", "allOf": [
/// {
/// "$ref": "#/components/schemas/Name"
/// }
/// ]
/// },
/// "ncpus": {
/// "description": "number of CPUs allocated for this Instance",
/// "allOf": [
/// {
/// "$ref": "#/components/schemas/InstanceCpuCount"
/// }
/// ]
/// },
/// "project_id": {
/// "description": "id for the project containing this Instance",
/// "type": "string",
/// "format": "uuid"
/// },
/// "run_state": {
/// "$ref": "#/components/schemas/InstanceState"
/// },
/// "time_created": {
/// "description": "timestamp when this resource was created",
/// "type": "string",
/// "format": "date-time"
/// },
/// "time_modified": {
/// "description": "timestamp when this resource was last modified",
/// "type": "string",
/// "format": "date-time"
/// },
/// "time_run_state_updated": {
/// "type": "string",
/// "format": "date-time"
/// }
/// }
///}
/// ```
/// </details>
2022-07-12 17:57:06 +00:00
#[derive(Clone, Debug, Deserialize, Serialize)]
2021-12-10 02:15:24 +00:00
pub struct Instance {
2022-07-03 02:09:38 +00:00
///human-readable free-form text about a resource
2021-12-10 02:15:24 +00:00
pub description: String,
2022-07-03 02:09:38 +00:00
///RFC1035-compliant hostname for the Instance.
2021-12-10 02:15:24 +00:00
pub hostname: String,
2022-07-03 02:09:38 +00:00
///unique, immutable, system-controlled identifier for each resource
2021-12-10 02:15:24 +00:00
pub id: uuid::Uuid,
2022-07-03 02:09:38 +00:00
///memory allocated for this Instance
2021-12-10 02:15:24 +00:00
pub memory: ByteCount,
2022-07-03 02:09:38 +00:00
///unique, mutable, user-controlled identifier for each resource
2021-12-10 02:15:24 +00:00
pub name: Name,
2022-07-03 02:09:38 +00:00
///number of CPUs allocated for this Instance
2021-12-10 02:15:24 +00:00
pub ncpus: InstanceCpuCount,
2022-07-03 02:09:38 +00:00
///id for the project containing this Instance
2021-12-10 02:15:24 +00:00
pub project_id: uuid::Uuid,
pub run_state: InstanceState,
2022-07-03 02:09:38 +00:00
///timestamp when this resource was created
2021-12-10 02:15:24 +00:00
pub time_created: chrono::DateTime<chrono::offset::Utc>,
2022-07-03 02:09:38 +00:00
///timestamp when this resource was last modified
2021-12-10 02:15:24 +00:00
pub time_modified: chrono::DateTime<chrono::offset::Utc>,
pub time_run_state_updated: chrono::DateTime<chrono::offset::Utc>,
}
2023-02-05 01:22:55 +00:00
impl From<&Instance> for Instance {
fn from(value: &Instance) -> Self {
value.clone()
}
}
2022-07-03 02:09:38 +00:00
///The number of CPUs in an Instance
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "The number of CPUs in an Instance",
/// "type": "integer",
/// "format": "uint16",
/// "minimum": 0.0
///}
/// ```
/// </details>
2022-07-12 17:57:06 +00:00
#[derive(Clone, Debug, Deserialize, Serialize)]
2021-12-10 02:15:24 +00:00
pub struct InstanceCpuCount(pub u16);
impl std::ops::Deref for InstanceCpuCount {
type Target = u16;
2023-01-25 17:19:15 +00:00
fn deref(&self) -> &u16 {
2021-12-10 02:15:24 +00:00
&self.0
}
}
2023-02-05 01:22:55 +00:00
impl From<InstanceCpuCount> for u16 {
fn from(value: InstanceCpuCount) -> Self {
value.0
}
}
impl From<&InstanceCpuCount> for InstanceCpuCount {
fn from(value: &InstanceCpuCount) -> Self {
value.clone()
}
}
impl From<u16> for InstanceCpuCount {
fn from(value: u16) -> Self {
Self(value)
}
}
impl std::str::FromStr for InstanceCpuCount {
type Err = <u16 as std::str::FromStr>::Err;
fn from_str(value: &str) -> Result<Self, Self::Err> {
Ok(Self(value.parse()?))
}
}
impl std::convert::TryFrom<&str> for InstanceCpuCount {
type Error = <u16 as std::str::FromStr>::Err;
fn try_from(value: &str) -> Result<Self, Self::Error> {
value.parse()
}
}
impl std::convert::TryFrom<&String> for InstanceCpuCount {
type Error = <u16 as std::str::FromStr>::Err;
fn try_from(value: &String) -> Result<Self, Self::Error> {
value.parse()
}
}
impl std::convert::TryFrom<String> for InstanceCpuCount {
type Error = <u16 as std::str::FromStr>::Err;
fn try_from(value: String) -> Result<Self, Self::Error> {
value.parse()
}
}
impl ToString for InstanceCpuCount {
fn to_string(&self) -> String {
self.0.to_string()
}
}
2022-07-03 02:09:38 +00:00
///Create-time parameters for an
/// [`Instance`](omicron_common::api::external::Instance)
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "Create-time parameters for an
/// [`Instance`](omicron_common::api::external::Instance)",
/// "type": "object",
/// "required": [
/// "description",
/// "hostname",
/// "memory",
/// "name",
/// "ncpus"
/// ],
/// "properties": {
/// "description": {
/// "type": "string"
/// },
/// "disks": {
/// "description": "The disks to be created or attached for this
/// instance.", "default": [],
/// "type": "array",
/// "items": {
/// "$ref": "#/components/schemas/InstanceDiskAttachment"
/// }
/// },
/// "external_ips": {
/// "description": "The external IP addresses provided to this
/// instance.\n\nBy default, all instances have outbound connectivity, but
/// no inbound connectivity. These external addresses can be used to provide
/// a fixed, known IP address for making inbound connections to the
/// instance.", "default": [],
/// "type": "array",
/// "items": {
/// "$ref": "#/components/schemas/ExternalIpCreate"
/// }
/// },
/// "hostname": {
/// "type": "string"
/// },
/// "memory": {
/// "$ref": "#/components/schemas/ByteCount"
/// },
/// "name": {
/// "$ref": "#/components/schemas/Name"
/// },
/// "ncpus": {
/// "$ref": "#/components/schemas/InstanceCpuCount"
/// },
/// "network_interfaces": {
/// "description": "The network interfaces to be created for this
/// instance.", "default": {
/// "type": "default"
/// },
/// "allOf": [
/// {
/// "$ref":
/// "#/components/schemas/InstanceNetworkInterfaceAttachment" }
/// ]
/// },
/// "start": {
/// "description": "Should this instance be started upon creation; true
/// by default.", "default": true,
/// "type": "boolean"
/// },
/// "user_data": {
/// "description": "User data for instance initialization systems (such
/// as cloud-init). Must be a Base64-encoded string, as specified in RFC
/// 4648 § 4 (+ and / characters with padding). Maximum 32 KiB unencoded
/// data.", "default": "",
/// "type": "string",
/// "format": "byte"
/// }
/// }
///}
/// ```
/// </details>
2022-07-12 17:57:06 +00:00
#[derive(Clone, Debug, Deserialize, Serialize)]
2021-12-10 02:15:24 +00:00
pub struct InstanceCreate {
pub description: String,
2022-07-03 02:09:38 +00:00
///The disks to be created or attached for this instance.
2022-05-23 15:49:37 +00:00
#[serde(default, skip_serializing_if = "Vec::is_empty")]
pub disks: Vec<InstanceDiskAttachment>,
2022-07-27 04:23:01 +00:00
///The external IP addresses provided to this instance.
///
///By default, all instances have outbound connectivity, but no inbound
/// connectivity. These external addresses can be used to provide a
/// fixed, known IP address for making inbound connections to the
/// instance.
#[serde(default, skip_serializing_if = "Vec::is_empty")]
pub external_ips: Vec<ExternalIpCreate>,
2021-12-10 02:15:24 +00:00
pub hostname: String,
pub memory: ByteCount,
pub name: Name,
pub ncpus: InstanceCpuCount,
2022-07-03 02:09:38 +00:00
///The network interfaces to be created for this instance.
2022-08-18 18:58:55 +00:00
#[serde(default = "defaults::instance_create_network_interfaces")]
2022-05-23 15:49:37 +00:00
pub network_interfaces: InstanceNetworkInterfaceAttachment,
2023-02-01 05:28:12 +00:00
///Should this instance be started upon creation; true by default.
#[serde(default = "defaults::default_bool::<true>")]
pub start: bool,
2022-07-03 02:09:38 +00:00
///User data for instance initialization systems (such as cloud-init).
/// Must be a Base64-encoded string, as specified in RFC 4648 § 4 (+ and
/// / characters with padding). Maximum 32 KiB unencoded data.
2022-05-23 15:49:37 +00:00
#[serde(default)]
pub user_data: String,
}
2023-02-05 01:22:55 +00:00
impl From<&InstanceCreate> for InstanceCreate {
fn from(value: &InstanceCreate) -> Self {
value.clone()
}
}
2022-07-03 02:09:38 +00:00
///Describe the instance's disks at creation time
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "Describe the instance's disks at creation time",
/// "oneOf": [
/// {
/// "description": "During instance creation, create and attach disks",
/// "type": "object",
/// "required": [
/// "description",
/// "disk_source",
/// "name",
/// "size",
/// "type"
/// ],
/// "properties": {
/// "description": {
/// "type": "string"
/// },
/// "disk_source": {
/// "description": "initial source for this disk",
/// "allOf": [
/// {
/// "$ref": "#/components/schemas/DiskSource"
/// }
/// ]
/// },
/// "name": {
/// "$ref": "#/components/schemas/Name"
/// },
/// "size": {
/// "description": "total size of the Disk in bytes",
/// "allOf": [
/// {
/// "$ref": "#/components/schemas/ByteCount"
/// }
/// ]
/// },
/// "type": {
/// "type": "string",
/// "enum": [
/// "create"
/// ]
/// }
/// }
/// },
/// {
/// "description": "During instance creation, attach this disk",
/// "type": "object",
/// "required": [
/// "name",
/// "type"
/// ],
/// "properties": {
/// "name": {
/// "description": "A disk name to attach",
/// "allOf": [
/// {
/// "$ref": "#/components/schemas/Name"
/// }
/// ]
/// },
/// "type": {
/// "type": "string",
/// "enum": [
/// "attach"
/// ]
/// }
/// }
/// }
/// ]
///}
/// ```
/// </details>
2022-07-12 17:57:06 +00:00
#[derive(Clone, Debug, Deserialize, Serialize)]
2022-05-23 15:49:37 +00:00
#[serde(tag = "type")]
pub enum InstanceDiskAttachment {
2022-07-03 02:09:38 +00:00
///During instance creation, create and attach disks
2022-05-23 15:49:37 +00:00
#[serde(rename = "create")]
Create {
description: String,
2022-07-03 02:09:38 +00:00
///initial source for this disk
2022-05-23 15:49:37 +00:00
disk_source: DiskSource,
name: Name,
2022-07-03 02:09:38 +00:00
///total size of the Disk in bytes
2022-05-23 15:49:37 +00:00
size: ByteCount,
},
2022-07-03 02:09:38 +00:00
///During instance creation, attach this disk
2022-05-23 15:49:37 +00:00
#[serde(rename = "attach")]
Attach {
2022-07-03 02:09:38 +00:00
///A disk name to attach
2022-05-23 15:49:37 +00:00
name: Name,
},
2021-12-10 02:15:24 +00:00
}
2023-02-05 01:22:55 +00:00
impl From<&InstanceDiskAttachment> for InstanceDiskAttachment {
fn from(value: &InstanceDiskAttachment) -> Self {
value.clone()
}
}
2022-07-03 02:09:38 +00:00
///Migration parameters for an
/// [`Instance`](omicron_common::api::external::Instance)
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "Migration parameters for an
/// [`Instance`](omicron_common::api::external::Instance)",
/// "type": "object",
/// "required": [
/// "dst_sled_id"
/// ],
/// "properties": {
/// "dst_sled_id": {
/// "type": "string",
/// "format": "uuid"
/// }
/// }
///}
/// ```
/// </details>
2022-07-12 17:57:06 +00:00
#[derive(Clone, Debug, Deserialize, Serialize)]
2022-02-08 16:59:38 +00:00
pub struct InstanceMigrate {
2022-07-08 01:35:36 +00:00
pub dst_sled_id: uuid::Uuid,
2022-02-08 16:59:38 +00:00
}
2023-02-05 01:22:55 +00:00
impl From<&InstanceMigrate> for InstanceMigrate {
fn from(value: &InstanceMigrate) -> Self {
value.clone()
}
}
2022-07-03 02:09:38 +00:00
///Describes an attachment of a `NetworkInterface` to an `Instance`, at the
/// time the instance is created.
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "Describes an attachment of a `NetworkInterface` to an
/// `Instance`, at the time the instance is created.", "oneOf": [
/// {
/// "description": "Create one or more `NetworkInterface`s for the
/// `Instance`.\n\nIf more than one interface is provided, then the first
/// will be designated the primary interface for the instance.",
/// "type": "object",
/// "required": [
/// "params",
/// "type"
/// ],
/// "properties": {
/// "params": {
/// "type": "array",
/// "items": {
/// "$ref": "#/components/schemas/NetworkInterfaceCreate"
/// }
/// },
/// "type": {
/// "type": "string",
/// "enum": [
/// "create"
/// ]
/// }
/// }
/// },
/// {
/// "description": "The default networking configuration for an
/// instance is to create a single primary interface with an
/// automatically-assigned IP address. The IP will be pulled from the
/// Project's default VPC / VPC Subnet.", "type": "object",
/// "required": [
/// "type"
/// ],
/// "properties": {
/// "type": {
/// "type": "string",
/// "enum": [
/// "default"
/// ]
/// }
/// }
/// },
/// {
/// "description": "No network interfaces at all will be created for
/// the instance.", "type": "object",
/// "required": [
/// "type"
/// ],
/// "properties": {
/// "type": {
/// "type": "string",
/// "enum": [
/// "none"
/// ]
/// }
/// }
/// }
/// ]
///}
/// ```
/// </details>
2022-07-12 17:57:06 +00:00
#[derive(Clone, Debug, Deserialize, Serialize)]
2022-03-18 06:54:10 +00:00
#[serde(tag = "type", content = "params")]
pub enum InstanceNetworkInterfaceAttachment {
2022-07-08 01:35:36 +00:00
///Create one or more `NetworkInterface`s for the `Instance`.
///
///If more than one interface is provided, then the first will be
/// designated the primary interface for the instance.
2022-05-23 15:49:37 +00:00
#[serde(rename = "create")]
Create(Vec<NetworkInterfaceCreate>),
#[serde(rename = "default")]
2022-03-18 06:54:10 +00:00
Default,
2022-05-23 15:49:37 +00:00
#[serde(rename = "none")]
2022-03-18 06:54:10 +00:00
None,
}
2023-02-05 01:22:55 +00:00
impl From<&InstanceNetworkInterfaceAttachment> for InstanceNetworkInterfaceAttachment {
fn from(value: &InstanceNetworkInterfaceAttachment) -> Self {
value.clone()
}
}
2023-03-17 22:39:46 +00:00
impl From<Vec<NetworkInterfaceCreate>> for InstanceNetworkInterfaceAttachment {
fn from(value: Vec<NetworkInterfaceCreate>) -> Self {
Self::Create(value)
}
}
2022-07-03 02:09:38 +00:00
///A single page of results
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "A single page of results",
/// "type": "object",
/// "required": [
/// "items"
/// ],
/// "properties": {
/// "items": {
/// "description": "list of items on this page of results",
/// "type": "array",
/// "items": {
/// "$ref": "#/components/schemas/Instance"
/// }
/// },
/// "next_page": {
/// "description": "token used to fetch the next page of results (if
/// any)", "type": [
/// "string",
/// "null"
/// ]
/// }
/// }
///}
/// ```
/// </details>
2022-07-12 17:57:06 +00:00
#[derive(Clone, Debug, Deserialize, Serialize)]
2021-12-10 02:15:24 +00:00
pub struct InstanceResultsPage {
2022-07-03 02:09:38 +00:00
///list of items on this page of results
2021-12-10 02:15:24 +00:00
pub items: Vec<Instance>,
2022-07-03 02:09:38 +00:00
///token used to fetch the next page of results (if any)
2021-12-10 02:15:24 +00:00
#[serde(default, skip_serializing_if = "Option::is_none")]
pub next_page: Option<String>,
}
2023-02-05 01:22:55 +00:00
impl From<&InstanceResultsPage> for InstanceResultsPage {
fn from(value: &InstanceResultsPage) -> Self {
value.clone()
}
}
2022-07-08 01:35:36 +00:00
///Contents of an Instance's serial console buffer.
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "Contents of an Instance's serial console buffer.",
/// "type": "object",
/// "required": [
/// "data",
/// "last_byte_offset"
/// ],
/// "properties": {
/// "data": {
/// "description": "The bytes starting from the requested offset up to
/// either the end of the buffer or the request's `max_bytes`. Provided as a
/// u8 array rather than a string, as it may not be UTF-8.", "type"
/// : "array", "items": {
/// "type": "integer",
/// "format": "uint8",
/// "minimum": 0.0
/// }
/// },
/// "last_byte_offset": {
/// "description": "The absolute offset since boot (suitable for use as
/// `byte_offset` in a subsequent request) of the last byte returned in
/// `data`.", "type": "integer",
/// "format": "uint64",
/// "minimum": 0.0
/// }
/// }
///}
/// ```
/// </details>
2022-07-12 17:57:06 +00:00
#[derive(Clone, Debug, Deserialize, Serialize)]
2022-07-08 01:35:36 +00:00
pub struct InstanceSerialConsoleData {
///The bytes starting from the requested offset up to either the end of
/// the buffer or the request's `max_bytes`. Provided as a u8 array
/// rather than a string, as it may not be UTF-8.
pub data: Vec<u8>,
///The absolute offset since boot (suitable for use as `byte_offset` in
/// a subsequent request) of the last byte returned in `data`.
pub last_byte_offset: u64,
}
2023-02-05 01:22:55 +00:00
impl From<&InstanceSerialConsoleData> for InstanceSerialConsoleData {
fn from(value: &InstanceSerialConsoleData) -> Self {
value.clone()
}
}
2022-07-03 02:09:38 +00:00
///Running state of an Instance (primarily: booted or stopped)
///
///This typically reflects whether it's starting, running, stopping, or
/// stopped, but also includes states related to the Instance's lifecycle
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "Running state of an Instance (primarily: booted or
/// stopped)\n\nThis typically reflects whether it's starting, running,
/// stopping, or stopped, but also includes states related to the Instance's
/// lifecycle", "oneOf": [
/// {
/// "description": "The instance is being created.",
/// "type": "string",
/// "enum": [
/// "creating"
/// ]
/// },
/// {
/// "description": "The instance is currently starting up.",
/// "type": "string",
/// "enum": [
/// "starting"
/// ]
/// },
/// {
/// "description": "The instance is currently running.",
/// "type": "string",
/// "enum": [
/// "running"
/// ]
/// },
/// {
/// "description": "The instance has been requested to stop and a
/// transition to \"Stopped\" is imminent.", "type": "string",
/// "enum": [
/// "stopping"
/// ]
/// },
/// {
/// "description": "The instance is currently stopped.",
/// "type": "string",
/// "enum": [
/// "stopped"
/// ]
/// },
/// {
/// "description": "The instance is in the process of rebooting - it
/// will remain in the \"rebooting\" state until the VM is starting once
/// more.", "type": "string",
/// "enum": [
/// "rebooting"
/// ]
/// },
/// {
/// "description": "The instance is in the process of migrating - it will remain in the \"migrating\" state until the migration process is complete and the destination propolis is ready to continue execution.",
/// "type": "string",
/// "enum": [
/// "migrating"
/// ]
/// },
/// {
/// "description": "The instance is attempting to recover from a
/// failure.", "type": "string",
/// "enum": [
/// "repairing"
/// ]
/// },
/// {
/// "description": "The instance has encountered a failure.",
/// "type": "string",
/// "enum": [
/// "failed"
/// ]
/// },
/// {
/// "description": "The instance has been deleted.",
/// "type": "string",
/// "enum": [
/// "destroyed"
/// ]
/// }
/// ]
///}
/// ```
/// </details>
2022-07-12 17:57:06 +00:00
#[derive(Clone, Copy, Debug, Deserialize, Eq, Hash, Ord, PartialEq, PartialOrd, Serialize)]
2021-12-10 02:15:24 +00:00
pub enum InstanceState {
2023-02-01 05:28:12 +00:00
///The instance is being created.
2021-12-10 02:15:24 +00:00
#[serde(rename = "creating")]
Creating,
2023-02-01 05:28:12 +00:00
///The instance is currently starting up.
2021-12-10 02:15:24 +00:00
#[serde(rename = "starting")]
Starting,
2023-02-01 05:28:12 +00:00
///The instance is currently running.
2021-12-10 02:15:24 +00:00
#[serde(rename = "running")]
Running,
2023-02-01 05:28:12 +00:00
///The instance has been requested to stop and a transition to
/// "Stopped" is imminent.
2021-12-10 02:15:24 +00:00
#[serde(rename = "stopping")]
Stopping,
2023-02-01 05:28:12 +00:00
///The instance is currently stopped.
2021-12-10 02:15:24 +00:00
#[serde(rename = "stopped")]
Stopped,
2023-02-01 05:28:12 +00:00
///The instance is in the process of rebooting - it will remain in the
/// "rebooting" state until the VM is starting once more.
2021-12-10 02:15:24 +00:00
#[serde(rename = "rebooting")]
Rebooting,
2023-02-01 05:28:12 +00:00
///The instance is in the process of migrating - it will remain in the
/// "migrating" state until the migration process is complete and the
/// destination propolis is ready to continue execution.
2022-02-08 16:59:38 +00:00
#[serde(rename = "migrating")]
Migrating,
2023-02-01 05:28:12 +00:00
///The instance is attempting to recover from a failure.
2021-12-10 02:15:24 +00:00
#[serde(rename = "repairing")]
Repairing,
2023-02-01 05:28:12 +00:00
///The instance has encountered a failure.
2021-12-10 02:15:24 +00:00
#[serde(rename = "failed")]
Failed,
2023-02-01 05:28:12 +00:00
///The instance has been deleted.
2021-12-10 02:15:24 +00:00
#[serde(rename = "destroyed")]
Destroyed,
}
2023-02-05 01:22:55 +00:00
impl From<&InstanceState> for InstanceState {
fn from(value: &InstanceState) -> Self {
value.clone()
}
}
2021-12-10 02:15:24 +00:00
impl ToString for InstanceState {
fn to_string(&self) -> String {
2022-03-08 07:22:44 +00:00
match *self {
2022-07-12 17:57:06 +00:00
Self::Creating => "creating".to_string(),
Self::Starting => "starting".to_string(),
Self::Running => "running".to_string(),
Self::Stopping => "stopping".to_string(),
Self::Stopped => "stopped".to_string(),
Self::Rebooting => "rebooting".to_string(),
Self::Migrating => "migrating".to_string(),
Self::Repairing => "repairing".to_string(),
Self::Failed => "failed".to_string(),
Self::Destroyed => "destroyed".to_string(),
}
}
}
impl std::str::FromStr for InstanceState {
type Err = &'static str;
2023-01-25 17:19:15 +00:00
fn from_str(value: &str) -> Result<Self, &'static str> {
2022-07-12 17:57:06 +00:00
match value {
"creating" => Ok(Self::Creating),
"starting" => Ok(Self::Starting),
"running" => Ok(Self::Running),
"stopping" => Ok(Self::Stopping),
"stopped" => Ok(Self::Stopped),
"rebooting" => Ok(Self::Rebooting),
"migrating" => Ok(Self::Migrating),
"repairing" => Ok(Self::Repairing),
"failed" => Ok(Self::Failed),
"destroyed" => Ok(Self::Destroyed),
_ => Err("invalid value"),
2021-12-10 02:15:24 +00:00
}
}
}
2023-01-25 17:19:15 +00:00
impl std::convert::TryFrom<&str> for InstanceState {
type Error = &'static str;
fn try_from(value: &str) -> Result<Self, &'static str> {
value.parse()
}
}
impl std::convert::TryFrom<&String> for InstanceState {
type Error = &'static str;
fn try_from(value: &String) -> Result<Self, &'static str> {
value.parse()
}
}
2023-01-30 20:17:51 +00:00
impl std::convert::TryFrom<String> for InstanceState {
type Error = &'static str;
fn try_from(value: String) -> Result<Self, &'static str> {
value.parse()
}
}
2022-07-27 04:23:01 +00:00
///The kind of an external IP address for an instance
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "The kind of an external IP address for an instance",
/// "type": "string",
/// "enum": [
/// "ephemeral",
/// "floating"
/// ]
///}
/// ```
/// </details>
2022-07-27 04:23:01 +00:00
#[derive(Clone, Copy, Debug, Deserialize, Eq, Hash, Ord, PartialEq, PartialOrd, Serialize)]
pub enum IpKind {
#[serde(rename = "ephemeral")]
Ephemeral,
#[serde(rename = "floating")]
Floating,
}
2023-02-05 01:22:55 +00:00
impl From<&IpKind> for IpKind {
fn from(value: &IpKind) -> Self {
value.clone()
}
}
2022-07-27 04:23:01 +00:00
impl ToString for IpKind {
fn to_string(&self) -> String {
match *self {
Self::Ephemeral => "ephemeral".to_string(),
Self::Floating => "floating".to_string(),
}
}
}
impl std::str::FromStr for IpKind {
type Err = &'static str;
2023-01-25 17:19:15 +00:00
fn from_str(value: &str) -> Result<Self, &'static str> {
2022-07-27 04:23:01 +00:00
match value {
"ephemeral" => Ok(Self::Ephemeral),
"floating" => Ok(Self::Floating),
_ => Err("invalid value"),
}
}
}
2023-01-25 17:19:15 +00:00
impl std::convert::TryFrom<&str> for IpKind {
type Error = &'static str;
fn try_from(value: &str) -> Result<Self, &'static str> {
value.parse()
}
}
impl std::convert::TryFrom<&String> for IpKind {
type Error = &'static str;
fn try_from(value: &String) -> Result<Self, &'static str> {
value.parse()
}
}
2023-01-30 20:17:51 +00:00
impl std::convert::TryFrom<String> for IpKind {
type Error = &'static str;
fn try_from(value: String) -> Result<Self, &'static str> {
value.parse()
}
}
2023-12-13 09:14:28 +00:00
///IpNet
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "oneOf": [
/// {
/// "title": "v4",
/// "allOf": [
/// {
/// "$ref": "#/components/schemas/Ipv4Net"
/// }
/// ]
/// },
/// {
/// "title": "v6",
/// "allOf": [
/// {
/// "$ref": "#/components/schemas/Ipv6Net"
/// }
/// ]
/// }
/// ]
///}
/// ```
/// </details>
2022-07-12 17:57:06 +00:00
#[derive(Clone, Debug, Deserialize, Serialize)]
2022-05-23 15:49:37 +00:00
#[serde(untagged)]
2022-03-18 06:54:10 +00:00
pub enum IpNet {
V4(Ipv4Net),
V6(Ipv6Net),
}
2023-02-05 01:22:55 +00:00
impl From<&IpNet> for IpNet {
fn from(value: &IpNet) -> Self {
value.clone()
}
}
2023-01-25 17:19:15 +00:00
impl std::str::FromStr for IpNet {
type Err = &'static str;
fn from_str(value: &str) -> Result<Self, &'static str> {
if let Ok(v) = value.parse() {
Ok(Self::V4(v))
} else if let Ok(v) = value.parse() {
Ok(Self::V6(v))
} else {
Err("string conversion failed for all variants")
}
2022-07-12 17:57:06 +00:00
}
}
2023-01-25 17:19:15 +00:00
impl std::convert::TryFrom<&str> for IpNet {
2022-09-10 16:41:07 +00:00
type Error = &'static str;
2023-01-25 17:19:15 +00:00
fn try_from(value: &str) -> Result<Self, &'static str> {
value.parse()
2022-09-10 16:41:07 +00:00
}
}
2023-01-25 17:19:15 +00:00
impl std::convert::TryFrom<&String> for IpNet {
2022-07-12 17:57:06 +00:00
type Error = &'static str;
2023-01-25 17:19:15 +00:00
fn try_from(value: &String) -> Result<Self, &'static str> {
value.parse()
2022-07-12 17:57:06 +00:00
}
}
2023-01-30 20:17:51 +00:00
impl std::convert::TryFrom<String> for IpNet {
type Error = &'static str;
fn try_from(value: String) -> Result<Self, &'static str> {
value.parse()
}
}
2022-12-02 16:09:46 +00:00
impl ToString for IpNet {
fn to_string(&self) -> String {
match self {
Self::V4(x) => x.to_string(),
Self::V6(x) => x.to_string(),
}
}
}
2023-03-17 22:39:46 +00:00
impl From<Ipv4Net> for IpNet {
fn from(value: Ipv4Net) -> Self {
Self::V4(value)
}
}
impl From<Ipv6Net> for IpNet {
fn from(value: Ipv6Net) -> Self {
Self::V6(value)
}
}
2022-07-08 01:35:36 +00:00
///Identity-related metadata that's included in nearly all public API
/// objects
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "Identity-related metadata that's included in nearly all
/// public API objects", "type": "object",
/// "required": [
/// "description",
/// "id",
/// "name",
/// "time_created",
/// "time_modified"
/// ],
/// "properties": {
/// "description": {
/// "description": "human-readable free-form text about a resource",
/// "type": "string"
/// },
/// "id": {
/// "description": "unique, immutable, system-controlled identifier for
/// each resource", "type": "string",
/// "format": "uuid"
/// },
/// "name": {
/// "description": "unique, mutable, user-controlled identifier for
/// each resource", "allOf": [
/// {
/// "$ref": "#/components/schemas/Name"
/// }
/// ]
/// },
/// "time_created": {
/// "description": "timestamp when this resource was created",
/// "type": "string",
/// "format": "date-time"
/// },
/// "time_modified": {
/// "description": "timestamp when this resource was last modified",
/// "type": "string",
/// "format": "date-time"
/// }
/// }
///}
/// ```
/// </details>
2022-07-12 17:57:06 +00:00
#[derive(Clone, Debug, Deserialize, Serialize)]
2022-07-08 01:35:36 +00:00
pub struct IpPool {
///human-readable free-form text about a resource
pub description: String,
///unique, immutable, system-controlled identifier for each resource
pub id: uuid::Uuid,
///unique, mutable, user-controlled identifier for each resource
pub name: Name,
///timestamp when this resource was created
pub time_created: chrono::DateTime<chrono::offset::Utc>,
///timestamp when this resource was last modified
pub time_modified: chrono::DateTime<chrono::offset::Utc>,
}
2023-02-05 01:22:55 +00:00
impl From<&IpPool> for IpPool {
fn from(value: &IpPool) -> Self {
value.clone()
}
}
2022-07-08 01:35:36 +00:00
///Create-time parameters for an IP Pool.
///
2023-02-01 05:28:12 +00:00
///See [`IpPool`](crate::external_api::views::IpPool)
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "Create-time parameters for an IP Pool.\n\nSee
/// [`IpPool`](crate::external_api::views::IpPool)", "type": "object",
/// "required": [
/// "description",
/// "name"
/// ],
/// "properties": {
/// "description": {
/// "type": "string"
/// },
/// "name": {
/// "$ref": "#/components/schemas/Name"
/// }
/// }
///}
/// ```
/// </details>
2022-07-12 17:57:06 +00:00
#[derive(Clone, Debug, Deserialize, Serialize)]
2022-07-08 01:35:36 +00:00
pub struct IpPoolCreate {
pub description: String,
pub name: Name,
}
2023-02-05 01:22:55 +00:00
impl From<&IpPoolCreate> for IpPoolCreate {
fn from(value: &IpPoolCreate) -> Self {
value.clone()
}
}
2023-12-13 09:14:28 +00:00
///IpPoolRange
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "type": "object",
/// "required": [
/// "id",
/// "range",
/// "time_created"
/// ],
/// "properties": {
/// "id": {
/// "type": "string",
/// "format": "uuid"
/// },
/// "range": {
/// "$ref": "#/components/schemas/IpRange"
/// },
/// "time_created": {
/// "type": "string",
/// "format": "date-time"
/// }
/// }
///}
/// ```
/// </details>
2022-07-12 17:57:06 +00:00
#[derive(Clone, Debug, Deserialize, Serialize)]
2022-07-08 01:35:36 +00:00
pub struct IpPoolRange {
pub id: uuid::Uuid,
pub range: IpRange,
pub time_created: chrono::DateTime<chrono::offset::Utc>,
}
2023-02-05 01:22:55 +00:00
impl From<&IpPoolRange> for IpPoolRange {
fn from(value: &IpPoolRange) -> Self {
value.clone()
}
}
2022-07-08 01:35:36 +00:00
///A single page of results
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "A single page of results",
/// "type": "object",
/// "required": [
/// "items"
/// ],
/// "properties": {
/// "items": {
/// "description": "list of items on this page of results",
/// "type": "array",
/// "items": {
/// "$ref": "#/components/schemas/IpPoolRange"
/// }
/// },
/// "next_page": {
/// "description": "token used to fetch the next page of results (if
/// any)", "type": [
/// "string",
/// "null"
/// ]
/// }
/// }
///}
/// ```
/// </details>
2022-07-12 17:57:06 +00:00
#[derive(Clone, Debug, Deserialize, Serialize)]
2022-07-08 01:35:36 +00:00
pub struct IpPoolRangeResultsPage {
///list of items on this page of results
pub items: Vec<IpPoolRange>,
///token used to fetch the next page of results (if any)
#[serde(default, skip_serializing_if = "Option::is_none")]
pub next_page: Option<String>,
}
2023-02-05 01:22:55 +00:00
impl From<&IpPoolRangeResultsPage> for IpPoolRangeResultsPage {
fn from(value: &IpPoolRangeResultsPage) -> Self {
value.clone()
}
}
2022-07-08 01:35:36 +00:00
///A single page of results
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "A single page of results",
/// "type": "object",
/// "required": [
/// "items"
/// ],
/// "properties": {
/// "items": {
/// "description": "list of items on this page of results",
/// "type": "array",
/// "items": {
/// "$ref": "#/components/schemas/IpPool"
/// }
/// },
/// "next_page": {
/// "description": "token used to fetch the next page of results (if
/// any)", "type": [
/// "string",
/// "null"
/// ]
/// }
/// }
///}
/// ```
/// </details>
2022-07-12 17:57:06 +00:00
#[derive(Clone, Debug, Deserialize, Serialize)]
2022-07-08 01:35:36 +00:00
pub struct IpPoolResultsPage {
///list of items on this page of results
pub items: Vec<IpPool>,
///token used to fetch the next page of results (if any)
#[serde(default, skip_serializing_if = "Option::is_none")]
pub next_page: Option<String>,
}
2023-02-05 01:22:55 +00:00
impl From<&IpPoolResultsPage> for IpPoolResultsPage {
fn from(value: &IpPoolResultsPage) -> Self {
value.clone()
}
}
2022-07-08 01:35:36 +00:00
///Parameters for updating an IP Pool
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "Parameters for updating an IP Pool",
/// "type": "object",
/// "properties": {
/// "description": {
/// "type": [
/// "string",
/// "null"
/// ]
/// },
/// "name": {
/// "allOf": [
/// {
/// "$ref": "#/components/schemas/Name"
/// }
/// ]
/// }
/// }
///}
/// ```
/// </details>
2022-07-12 17:57:06 +00:00
#[derive(Clone, Debug, Deserialize, Serialize)]
2022-07-08 01:35:36 +00:00
pub struct IpPoolUpdate {
#[serde(default, skip_serializing_if = "Option::is_none")]
pub description: Option<String>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub name: Option<Name>,
}
2023-02-05 01:22:55 +00:00
impl From<&IpPoolUpdate> for IpPoolUpdate {
fn from(value: &IpPoolUpdate) -> Self {
value.clone()
}
}
2023-12-13 09:14:28 +00:00
///IpRange
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "oneOf": [
/// {
/// "title": "v4",
/// "allOf": [
/// {
/// "$ref": "#/components/schemas/Ipv4Range"
/// }
/// ]
/// },
/// {
/// "title": "v6",
/// "allOf": [
/// {
/// "$ref": "#/components/schemas/Ipv6Range"
/// }
/// ]
/// }
/// ]
///}
/// ```
/// </details>
2022-07-12 17:57:06 +00:00
#[derive(Clone, Debug, Deserialize, Serialize)]
2022-07-08 01:35:36 +00:00
#[serde(untagged)]
pub enum IpRange {
V4(Ipv4Range),
V6(Ipv6Range),
}
2023-02-05 01:22:55 +00:00
impl From<&IpRange> for IpRange {
fn from(value: &IpRange) -> Self {
value.clone()
}
}
2023-03-17 22:39:46 +00:00
impl From<Ipv4Range> for IpRange {
fn from(value: Ipv4Range) -> Self {
Self::V4(value)
}
}
impl From<Ipv6Range> for IpRange {
fn from(value: Ipv6Range) -> Self {
Self::V6(value)
}
}
2022-07-03 02:09:38 +00:00
///An IPv4 subnet, including prefix and subnet mask
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "title": "An IPv4 subnet",
/// "description": "An IPv4 subnet, including prefix and subnet mask",
/// "examples": [
/// "192.168.1.0/24"
/// ],
/// "type": "string",
/// "pattern":
/// "^(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.
/// ){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])/
/// ([8-9]|1[0-9]|2[0-9]|3[0-2])$" }
/// ```
/// </details>
2023-05-02 20:55:50 +00:00
#[derive(Clone, Debug, Eq, Hash, Ord, PartialEq, PartialOrd, Serialize)]
2022-07-12 17:57:06 +00:00
pub struct Ipv4Net(String);
2021-12-10 02:15:24 +00:00
impl std::ops::Deref for Ipv4Net {
type Target = String;
2023-01-25 17:19:15 +00:00
fn deref(&self) -> &String {
2021-12-10 02:15:24 +00:00
&self.0
}
}
2023-02-05 01:22:55 +00:00
impl From<Ipv4Net> for String {
fn from(value: Ipv4Net) -> Self {
value.0
}
}
impl From<&Ipv4Net> for Ipv4Net {
fn from(value: &Ipv4Net) -> Self {
value.clone()
}
}
2023-01-25 17:19:15 +00:00
impl std::str::FromStr for Ipv4Net {
type Err = &'static str;
fn from_str(value: &str) -> Result<Self, &'static str> {
2023-04-25 16:11:52 +00:00
if regress::Regex::new(
"^(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.\
){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])/\
([8-9]|1[0-9]|2[0-9]|3[0-2])$",
)
.unwrap()
.find(value)
.is_none()
{
return Err("doesn't match pattern \
\"^(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.\
){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])/\
([8-9]|1[0-9]|2[0-9]|3[0-2])$\"");
}
2022-07-12 17:57:06 +00:00
Ok(Self(value.to_string()))
}
}
2023-01-25 17:19:15 +00:00
impl std::convert::TryFrom<&str> for Ipv4Net {
2022-09-10 16:41:07 +00:00
type Error = &'static str;
2023-01-25 17:19:15 +00:00
fn try_from(value: &str) -> Result<Self, &'static str> {
value.parse()
2022-09-10 16:41:07 +00:00
}
}
2023-01-25 17:19:15 +00:00
impl std::convert::TryFrom<&String> for Ipv4Net {
2022-07-12 17:57:06 +00:00
type Error = &'static str;
2023-01-25 17:19:15 +00:00
fn try_from(value: &String) -> Result<Self, &'static str> {
value.parse()
2022-07-12 17:57:06 +00:00
}
}
2023-01-30 20:17:51 +00:00
impl std::convert::TryFrom<String> for Ipv4Net {
type Error = &'static str;
fn try_from(value: String) -> Result<Self, &'static str> {
value.parse()
}
}
2022-07-12 17:57:06 +00:00
impl<'de> serde::Deserialize<'de> for Ipv4Net {
fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where
D: serde::Deserializer<'de>,
{
2023-01-25 17:19:15 +00:00
String::deserialize(deserializer)?
.parse()
.map_err(|e: &'static str| <D::Error as serde::de::Error>::custom(e.to_string()))
2022-07-12 17:57:06 +00:00
}
}
2022-07-08 01:35:36 +00:00
///A non-decreasing IPv4 address range, inclusive of both ends.
///
///The first address must be less than or equal to the last address.
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "A non-decreasing IPv4 address range, inclusive of both
/// ends.\n\nThe first address must be less than or equal to the last
/// address.", "type": "object",
/// "required": [
/// "first",
/// "last"
/// ],
/// "properties": {
/// "first": {
/// "type": "string",
/// "format": "ipv4"
/// },
/// "last": {
/// "type": "string",
/// "format": "ipv4"
/// }
/// }
///}
/// ```
/// </details>
2022-07-12 17:57:06 +00:00
#[derive(Clone, Debug, Deserialize, Serialize)]
2022-07-08 01:35:36 +00:00
pub struct Ipv4Range {
pub first: std::net::Ipv4Addr,
pub last: std::net::Ipv4Addr,
}
2023-02-05 01:22:55 +00:00
impl From<&Ipv4Range> for Ipv4Range {
fn from(value: &Ipv4Range) -> Self {
value.clone()
}
}
2022-07-03 02:09:38 +00:00
///An IPv6 subnet, including prefix and subnet mask
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "title": "An IPv6 subnet",
/// "description": "An IPv6 subnet, including prefix and subnet mask",
/// "examples": [
/// "fd12:3456::/64"
/// ],
/// "type": "string",
/// "pattern":
/// "^([fF][dD])[0-9a-fA-F]{2}:(([0-9a-fA-F]{1,4}:){6}[0-9a-fA-F]{1,
/// 4}|([0-9a-fA-F]{1,4}:){1,6}:)\\/([1-9]|[1-9][0-9]|1[0-1][0-9]|12[0-8])$"
/// }
/// ```
/// </details>
2023-05-02 20:55:50 +00:00
#[derive(Clone, Debug, Eq, Hash, Ord, PartialEq, PartialOrd, Serialize)]
2022-07-12 17:57:06 +00:00
pub struct Ipv6Net(String);
2021-12-10 02:15:24 +00:00
impl std::ops::Deref for Ipv6Net {
type Target = String;
2023-01-25 17:19:15 +00:00
fn deref(&self) -> &String {
2021-12-10 02:15:24 +00:00
&self.0
}
}
2023-02-05 01:22:55 +00:00
impl From<Ipv6Net> for String {
fn from(value: Ipv6Net) -> Self {
value.0
}
}
impl From<&Ipv6Net> for Ipv6Net {
fn from(value: &Ipv6Net) -> Self {
value.clone()
}
}
2023-01-25 17:19:15 +00:00
impl std::str::FromStr for Ipv6Net {
type Err = &'static str;
fn from_str(value: &str) -> Result<Self, &'static str> {
2023-04-25 16:11:52 +00:00
if regress::Regex::new(
"^([fF][dD])[0-9a-fA-F]{2}:(([0-9a-fA-F]{1,4}:){6}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,\
4}:){1,6}:)\\/([1-9]|[1-9][0-9]|1[0-1][0-9]|12[0-8])$",
)
.unwrap()
.find(value)
.is_none()
{
return Err("doesn't match pattern \
\"^([fF][dD])[0-9a-fA-F]{2}:(([0-9a-fA-F]{1,4}:){6}[0-9a-fA-F]{1,\
4}|([0-9a-fA-F]{1,4}:){1,6}:)\\/\
([1-9]|[1-9][0-9]|1[0-1][0-9]|12[0-8])$\"");
}
2022-07-12 17:57:06 +00:00
Ok(Self(value.to_string()))
}
}
2023-01-25 17:19:15 +00:00
impl std::convert::TryFrom<&str> for Ipv6Net {
2022-09-10 16:41:07 +00:00
type Error = &'static str;
2023-01-25 17:19:15 +00:00
fn try_from(value: &str) -> Result<Self, &'static str> {
value.parse()
2022-09-10 16:41:07 +00:00
}
}
2023-01-25 17:19:15 +00:00
impl std::convert::TryFrom<&String> for Ipv6Net {
2022-07-12 17:57:06 +00:00
type Error = &'static str;
2023-01-25 17:19:15 +00:00
fn try_from(value: &String) -> Result<Self, &'static str> {
value.parse()
2022-07-12 17:57:06 +00:00
}
}
2023-01-30 20:17:51 +00:00
impl std::convert::TryFrom<String> for Ipv6Net {
type Error = &'static str;
fn try_from(value: String) -> Result<Self, &'static str> {
value.parse()
}
}
2022-07-12 17:57:06 +00:00
impl<'de> serde::Deserialize<'de> for Ipv6Net {
fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where
D: serde::Deserializer<'de>,
{
2023-01-25 17:19:15 +00:00
String::deserialize(deserializer)?
.parse()
.map_err(|e: &'static str| <D::Error as serde::de::Error>::custom(e.to_string()))
2022-07-12 17:57:06 +00:00
}
}
2022-07-08 01:35:36 +00:00
///A non-decreasing IPv6 address range, inclusive of both ends.
///
///The first address must be less than or equal to the last address.
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "A non-decreasing IPv6 address range, inclusive of both
/// ends.\n\nThe first address must be less than or equal to the last
/// address.", "type": "object",
/// "required": [
/// "first",
/// "last"
/// ],
/// "properties": {
/// "first": {
/// "type": "string",
/// "format": "ipv6"
/// },
/// "last": {
/// "type": "string",
/// "format": "ipv6"
/// }
/// }
///}
/// ```
/// </details>
2022-07-12 17:57:06 +00:00
#[derive(Clone, Debug, Deserialize, Serialize)]
2022-07-08 01:35:36 +00:00
pub struct Ipv6Range {
pub first: std::net::Ipv6Addr,
pub last: std::net::Ipv6Addr,
}
2023-02-05 01:22:55 +00:00
impl From<&Ipv6Range> for Ipv6Range {
fn from(value: &Ipv6Range) -> Self {
value.clone()
}
}
2022-07-03 02:09:38 +00:00
///An inclusive-inclusive range of IP ports. The second port may be omitted
/// to represent a single port
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "title": "A range of IP ports",
/// "description": "An inclusive-inclusive range of IP ports. The second
/// port may be omitted to represent a single port", "examples": [
/// "22"
/// ],
/// "type": "string",
/// "maxLength": 11,
/// "minLength": 1,
/// "pattern": "^[0-9]{1,5}(-[0-9]{1,5})?$"
///}
/// ```
/// </details>
2023-05-02 20:55:50 +00:00
#[derive(Clone, Debug, Eq, Hash, Ord, PartialEq, PartialOrd, Serialize)]
2022-07-12 17:57:06 +00:00
pub struct L4PortRange(String);
2021-12-10 02:15:24 +00:00
impl std::ops::Deref for L4PortRange {
type Target = String;
2023-01-25 17:19:15 +00:00
fn deref(&self) -> &String {
2021-12-10 02:15:24 +00:00
&self.0
}
}
2023-02-05 01:22:55 +00:00
impl From<L4PortRange> for String {
fn from(value: L4PortRange) -> Self {
value.0
}
}
impl From<&L4PortRange> for L4PortRange {
fn from(value: &L4PortRange) -> Self {
value.clone()
}
}
2023-01-25 17:19:15 +00:00
impl std::str::FromStr for L4PortRange {
type Err = &'static str;
fn from_str(value: &str) -> Result<Self, &'static str> {
2022-07-12 17:57:06 +00:00
if value.len() > 11usize {
return Err("longer than 11 characters");
}
if value.len() < 1usize {
return Err("shorter than 1 characters");
}
if regress::Regex::new("^[0-9]{1,5}(-[0-9]{1,5})?$")
.unwrap()
.find(value)
.is_none()
{
return Err("doesn't match pattern \"^[0-9]{1,5}(-[0-9]{1,5})?$\"");
}
Ok(Self(value.to_string()))
}
}
2023-01-25 17:19:15 +00:00
impl std::convert::TryFrom<&str> for L4PortRange {
2022-09-10 16:41:07 +00:00
type Error = &'static str;
2023-01-25 17:19:15 +00:00
fn try_from(value: &str) -> Result<Self, &'static str> {
value.parse()
2022-09-10 16:41:07 +00:00
}
}
2023-01-25 17:19:15 +00:00
impl std::convert::TryFrom<&String> for L4PortRange {
2022-07-12 17:57:06 +00:00
type Error = &'static str;
2023-01-25 17:19:15 +00:00
fn try_from(value: &String) -> Result<Self, &'static str> {
value.parse()
2022-07-12 17:57:06 +00:00
}
}
2023-01-30 20:17:51 +00:00
impl std::convert::TryFrom<String> for L4PortRange {
type Error = &'static str;
fn try_from(value: String) -> Result<Self, &'static str> {
value.parse()
}
}
2022-07-12 17:57:06 +00:00
impl<'de> serde::Deserialize<'de> for L4PortRange {
fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where
D: serde::Deserializer<'de>,
{
2023-01-25 17:19:15 +00:00
String::deserialize(deserializer)?
.parse()
.map_err(|e: &'static str| <D::Error as serde::de::Error>::custom(e.to_string()))
2022-07-12 17:57:06 +00:00
}
}
2022-07-03 02:09:38 +00:00
///A Media Access Control address, in EUI-48 format
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "title": "A MAC address",
/// "description": "A Media Access Control address, in EUI-48 format",
/// "examples": [
/// "ff:ff:ff:ff:ff:ff"
/// ],
/// "type": "string",
/// "maxLength": 17,
/// "minLength": 17,
/// "pattern": "^([0-9a-fA-F]{2}:){5}[0-9a-fA-F]{2}$"
///}
/// ```
/// </details>
2023-05-02 20:55:50 +00:00
#[derive(Clone, Debug, Eq, Hash, Ord, PartialEq, PartialOrd, Serialize)]
2022-07-12 17:57:06 +00:00
pub struct MacAddr(String);
2022-01-05 20:02:46 +00:00
impl std::ops::Deref for MacAddr {
type Target = String;
2023-01-25 17:19:15 +00:00
fn deref(&self) -> &String {
2022-01-05 20:02:46 +00:00
&self.0
}
}
2023-02-05 01:22:55 +00:00
impl From<MacAddr> for String {
fn from(value: MacAddr) -> Self {
value.0
}
}
impl From<&MacAddr> for MacAddr {
fn from(value: &MacAddr) -> Self {
value.clone()
}
}
2023-01-25 17:19:15 +00:00
impl std::str::FromStr for MacAddr {
type Err = &'static str;
fn from_str(value: &str) -> Result<Self, &'static str> {
2022-07-12 17:57:06 +00:00
if value.len() > 17usize {
return Err("longer than 17 characters");
}
if value.len() < 17usize {
return Err("shorter than 17 characters");
}
if regress::Regex::new("^([0-9a-fA-F]{2}:){5}[0-9a-fA-F]{2}$")
.unwrap()
.find(value)
.is_none()
{
return Err("doesn't match pattern \"^([0-9a-fA-F]{2}:){5}[0-9a-fA-F]{2}$\"");
}
Ok(Self(value.to_string()))
}
}
2023-01-25 17:19:15 +00:00
impl std::convert::TryFrom<&str> for MacAddr {
2022-09-10 16:41:07 +00:00
type Error = &'static str;
2023-01-25 17:19:15 +00:00
fn try_from(value: &str) -> Result<Self, &'static str> {
value.parse()
2022-09-10 16:41:07 +00:00
}
}
2023-01-25 17:19:15 +00:00
impl std::convert::TryFrom<&String> for MacAddr {
2022-07-12 17:57:06 +00:00
type Error = &'static str;
2023-01-25 17:19:15 +00:00
fn try_from(value: &String) -> Result<Self, &'static str> {
value.parse()
2022-07-12 17:57:06 +00:00
}
}
2023-01-30 20:17:51 +00:00
impl std::convert::TryFrom<String> for MacAddr {
type Error = &'static str;
fn try_from(value: String) -> Result<Self, &'static str> {
value.parse()
}
}
2022-07-12 17:57:06 +00:00
impl<'de> serde::Deserialize<'de> for MacAddr {
fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where
D: serde::Deserializer<'de>,
{
2023-01-25 17:19:15 +00:00
String::deserialize(deserializer)?
.parse()
.map_err(|e: &'static str| <D::Error as serde::de::Error>::custom(e.to_string()))
2022-07-12 17:57:06 +00:00
}
}
2022-07-27 04:23:01 +00:00
///A `Measurement` is a timestamped datum from a single metric
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "A `Measurement` is a timestamped datum from a single
/// metric", "type": "object",
/// "required": [
/// "datum",
/// "timestamp"
/// ],
/// "properties": {
/// "datum": {
/// "$ref": "#/components/schemas/Datum"
/// },
/// "timestamp": {
/// "type": "string",
/// "format": "date-time"
/// }
/// }
///}
/// ```
/// </details>
2022-07-27 04:23:01 +00:00
#[derive(Clone, Debug, Deserialize, Serialize)]
pub struct Measurement {
pub datum: Datum,
pub timestamp: chrono::DateTime<chrono::offset::Utc>,
}
2023-02-05 01:22:55 +00:00
impl From<&Measurement> for Measurement {
fn from(value: &Measurement) -> Self {
value.clone()
}
}
2022-07-27 04:23:01 +00:00
///A single page of results
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "A single page of results",
/// "type": "object",
/// "required": [
/// "items"
/// ],
/// "properties": {
/// "items": {
/// "description": "list of items on this page of results",
/// "type": "array",
/// "items": {
/// "$ref": "#/components/schemas/Measurement"
/// }
/// },
/// "next_page": {
/// "description": "token used to fetch the next page of results (if
/// any)", "type": [
/// "string",
/// "null"
/// ]
/// }
/// }
///}
/// ```
/// </details>
2022-07-27 04:23:01 +00:00
#[derive(Clone, Debug, Deserialize, Serialize)]
pub struct MeasurementResultsPage {
///list of items on this page of results
pub items: Vec<Measurement>,
///token used to fetch the next page of results (if any)
#[serde(default, skip_serializing_if = "Option::is_none")]
pub next_page: Option<String>,
}
2023-02-05 01:22:55 +00:00
impl From<&MeasurementResultsPage> for MeasurementResultsPage {
fn from(value: &MeasurementResultsPage) -> Self {
value.clone()
}
}
2022-07-03 02:09:38 +00:00
///Names must begin with a lower case ASCII letter, be composed exclusively
/// of lowercase ASCII, uppercase ASCII, numbers, and '-', and may not end
2022-07-27 04:23:01 +00:00
/// with a '-'. Names cannot be a UUID though they may contain a UUID.
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "title": "A name unique within the parent collection",
/// "description": "Names must begin with a lower case ASCII letter, be
/// composed exclusively of lowercase ASCII, uppercase ASCII, numbers, and
/// '-', and may not end with a '-'. Names cannot be a UUID though they may
/// contain a UUID.", "type": "string",
/// "maxLength": 63,
/// "pattern":
/// "^(?![0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$)^[a-z][a-z0-9-]*
/// [a-zA-Z0-9]$" }
/// ```
/// </details>
2023-05-02 20:55:50 +00:00
#[derive(Clone, Debug, Eq, Hash, Ord, PartialEq, PartialOrd, Serialize)]
2022-07-12 17:57:06 +00:00
pub struct Name(String);
2021-12-10 02:15:24 +00:00
impl std::ops::Deref for Name {
type Target = String;
2023-01-25 17:19:15 +00:00
fn deref(&self) -> &String {
2021-12-10 02:15:24 +00:00
&self.0
}
}
2023-02-05 01:22:55 +00:00
impl From<Name> for String {
fn from(value: Name) -> Self {
value.0
}
}
impl From<&Name> for Name {
fn from(value: &Name) -> Self {
value.clone()
}
}
2023-01-25 17:19:15 +00:00
impl std::str::FromStr for Name {
type Err = &'static str;
fn from_str(value: &str) -> Result<Self, &'static str> {
2022-07-12 17:57:06 +00:00
if value.len() > 63usize {
return Err("longer than 63 characters");
}
2022-07-27 04:23:01 +00:00
if regress :: Regex :: new ("^(?![0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$)^[a-z][a-z0-9-]*[a-zA-Z0-9]$") . unwrap () . find (value) . is_none () { return Err ("doesn't match pattern \"^(?![0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$)^[a-z][a-z0-9-]*[a-zA-Z0-9]$\"") ; }
2022-07-12 17:57:06 +00:00
Ok(Self(value.to_string()))
}
}
2023-01-25 17:19:15 +00:00
impl std::convert::TryFrom<&str> for Name {
2022-09-10 16:41:07 +00:00
type Error = &'static str;
2023-01-25 17:19:15 +00:00
fn try_from(value: &str) -> Result<Self, &'static str> {
value.parse()
2022-09-10 16:41:07 +00:00
}
}
2023-01-25 17:19:15 +00:00
impl std::convert::TryFrom<&String> for Name {
2022-07-12 17:57:06 +00:00
type Error = &'static str;
2023-01-25 17:19:15 +00:00
fn try_from(value: &String) -> Result<Self, &'static str> {
value.parse()
2022-07-12 17:57:06 +00:00
}
}
2023-01-30 20:17:51 +00:00
impl std::convert::TryFrom<String> for Name {
type Error = &'static str;
fn try_from(value: String) -> Result<Self, &'static str> {
value.parse()
}
}
2022-07-12 17:57:06 +00:00
impl<'de> serde::Deserialize<'de> for Name {
fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where
D: serde::Deserializer<'de>,
{
2023-01-25 17:19:15 +00:00
String::deserialize(deserializer)?
.parse()
.map_err(|e: &'static str| <D::Error as serde::de::Error>::custom(e.to_string()))
2022-07-12 17:57:06 +00:00
}
}
2023-12-13 09:14:28 +00:00
///NameOrId
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "oneOf": [
/// {
/// "title": "id",
/// "allOf": [
/// {
/// "type": "string",
/// "format": "uuid"
/// }
/// ]
/// },
/// {
/// "title": "name",
/// "allOf": [
/// {
/// "$ref": "#/components/schemas/Name"
/// }
/// ]
/// }
/// ]
///}
/// ```
/// </details>
2023-02-01 05:28:12 +00:00
#[derive(Clone, Debug, Deserialize, Serialize)]
#[serde(untagged)]
pub enum NameOrId {
Id(uuid::Uuid),
Name(Name),
}
2023-02-05 01:22:55 +00:00
impl From<&NameOrId> for NameOrId {
fn from(value: &NameOrId) -> Self {
value.clone()
}
}
2023-02-01 05:28:12 +00:00
impl std::str::FromStr for NameOrId {
type Err = &'static str;
fn from_str(value: &str) -> Result<Self, &'static str> {
if let Ok(v) = value.parse() {
Ok(Self::Id(v))
} else if let Ok(v) = value.parse() {
Ok(Self::Name(v))
} else {
Err("string conversion failed for all variants")
}
}
}
impl std::convert::TryFrom<&str> for NameOrId {
type Error = &'static str;
fn try_from(value: &str) -> Result<Self, &'static str> {
value.parse()
}
}
impl std::convert::TryFrom<&String> for NameOrId {
type Error = &'static str;
fn try_from(value: &String) -> Result<Self, &'static str> {
value.parse()
}
}
impl std::convert::TryFrom<String> for NameOrId {
type Error = &'static str;
fn try_from(value: String) -> Result<Self, &'static str> {
value.parse()
}
}
impl ToString for NameOrId {
fn to_string(&self) -> String {
match self {
Self::Id(x) => x.to_string(),
Self::Name(x) => x.to_string(),
}
}
}
2023-03-17 22:39:46 +00:00
impl From<uuid::Uuid> for NameOrId {
fn from(value: uuid::Uuid) -> Self {
Self::Id(value)
}
}
impl From<Name> for NameOrId {
fn from(value: Name) -> Self {
Self::Name(value)
}
}
2022-07-03 02:09:38 +00:00
///Supported set of sort modes for scanning by name or id
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "Supported set of sort modes for scanning by name or
/// id", "oneOf": [
/// {
/// "description": "sort in increasing order of \"name\"",
/// "type": "string",
/// "enum": [
/// "name_ascending"
/// ]
/// },
/// {
/// "description": "sort in decreasing order of \"name\"",
/// "type": "string",
/// "enum": [
/// "name_descending"
/// ]
/// },
/// {
/// "description": "sort in increasing order of \"id\"",
/// "type": "string",
/// "enum": [
/// "id_ascending"
/// ]
/// }
/// ]
///}
/// ```
/// </details>
2022-07-12 17:57:06 +00:00
#[derive(Clone, Copy, Debug, Deserialize, Eq, Hash, Ord, PartialEq, PartialOrd, Serialize)]
2021-12-10 02:15:24 +00:00
pub enum NameOrIdSortMode {
2023-02-01 05:28:12 +00:00
///sort in increasing order of "name"
2022-05-23 15:49:37 +00:00
#[serde(rename = "name_ascending")]
2021-12-10 02:15:24 +00:00
NameAscending,
2023-02-01 05:28:12 +00:00
///sort in decreasing order of "name"
2022-05-23 15:49:37 +00:00
#[serde(rename = "name_descending")]
2021-12-10 02:15:24 +00:00
NameDescending,
2023-02-01 05:28:12 +00:00
///sort in increasing order of "id"
2022-05-23 15:49:37 +00:00
#[serde(rename = "id_ascending")]
2021-12-10 02:15:24 +00:00
IdAscending,
}
2023-02-05 01:22:55 +00:00
impl From<&NameOrIdSortMode> for NameOrIdSortMode {
fn from(value: &NameOrIdSortMode) -> Self {
value.clone()
}
}
2021-12-10 02:15:24 +00:00
impl ToString for NameOrIdSortMode {
fn to_string(&self) -> String {
2022-03-08 07:22:44 +00:00
match *self {
2022-07-12 17:57:06 +00:00
Self::NameAscending => "name_ascending".to_string(),
Self::NameDescending => "name_descending".to_string(),
Self::IdAscending => "id_ascending".to_string(),
}
}
}
impl std::str::FromStr for NameOrIdSortMode {
type Err = &'static str;
2023-01-25 17:19:15 +00:00
fn from_str(value: &str) -> Result<Self, &'static str> {
2022-07-12 17:57:06 +00:00
match value {
"name_ascending" => Ok(Self::NameAscending),
"name_descending" => Ok(Self::NameDescending),
"id_ascending" => Ok(Self::IdAscending),
_ => Err("invalid value"),
2021-12-10 02:15:24 +00:00
}
}
}
2023-01-25 17:19:15 +00:00
impl std::convert::TryFrom<&str> for NameOrIdSortMode {
type Error = &'static str;
fn try_from(value: &str) -> Result<Self, &'static str> {
value.parse()
}
}
impl std::convert::TryFrom<&String> for NameOrIdSortMode {
type Error = &'static str;
fn try_from(value: &String) -> Result<Self, &'static str> {
value.parse()
}
}
2023-01-30 20:17:51 +00:00
impl std::convert::TryFrom<String> for NameOrIdSortMode {
type Error = &'static str;
fn try_from(value: String) -> Result<Self, &'static str> {
value.parse()
}
}
2022-07-03 02:09:38 +00:00
///Supported set of sort modes for scanning by name only
///
///Currently, we only support scanning in ascending order.
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "Supported set of sort modes for scanning by name
/// only\n\nCurrently, we only support scanning in ascending order.",
/// "oneOf": [
/// {
/// "description": "sort in increasing order of \"name\"",
/// "type": "string",
/// "enum": [
/// "name_ascending"
/// ]
/// }
/// ]
///}
/// ```
/// </details>
2022-07-12 17:57:06 +00:00
#[derive(Clone, Copy, Debug, Deserialize, Eq, Hash, Ord, PartialEq, PartialOrd, Serialize)]
2021-12-10 02:15:24 +00:00
pub enum NameSortMode {
2023-02-01 05:28:12 +00:00
///sort in increasing order of "name"
2022-05-23 15:49:37 +00:00
#[serde(rename = "name_ascending")]
2021-12-10 02:15:24 +00:00
NameAscending,
}
2023-02-05 01:22:55 +00:00
impl From<&NameSortMode> for NameSortMode {
fn from(value: &NameSortMode) -> Self {
value.clone()
}
}
2021-12-10 02:15:24 +00:00
impl ToString for NameSortMode {
fn to_string(&self) -> String {
2022-03-08 07:22:44 +00:00
match *self {
2022-07-12 17:57:06 +00:00
Self::NameAscending => "name_ascending".to_string(),
}
}
}
impl std::str::FromStr for NameSortMode {
type Err = &'static str;
2023-01-25 17:19:15 +00:00
fn from_str(value: &str) -> Result<Self, &'static str> {
2022-07-12 17:57:06 +00:00
match value {
"name_ascending" => Ok(Self::NameAscending),
_ => Err("invalid value"),
2021-12-10 02:15:24 +00:00
}
}
}
2023-01-25 17:19:15 +00:00
impl std::convert::TryFrom<&str> for NameSortMode {
type Error = &'static str;
fn try_from(value: &str) -> Result<Self, &'static str> {
value.parse()
}
}
impl std::convert::TryFrom<&String> for NameSortMode {
type Error = &'static str;
fn try_from(value: &String) -> Result<Self, &'static str> {
value.parse()
}
}
2023-01-30 20:17:51 +00:00
impl std::convert::TryFrom<String> for NameSortMode {
type Error = &'static str;
fn try_from(value: String) -> Result<Self, &'static str> {
value.parse()
}
}
2022-07-03 02:09:38 +00:00
///A `NetworkInterface` represents a virtual network interface device.
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "A `NetworkInterface` represents a virtual network
/// interface device.", "type": "object",
/// "required": [
/// "description",
/// "id",
/// "instance_id",
/// "ip",
/// "mac",
/// "name",
/// "primary",
/// "subnet_id",
/// "time_created",
/// "time_modified",
/// "vpc_id"
/// ],
/// "properties": {
/// "description": {
/// "description": "human-readable free-form text about a resource",
/// "type": "string"
/// },
/// "id": {
/// "description": "unique, immutable, system-controlled identifier for
/// each resource", "type": "string",
/// "format": "uuid"
/// },
/// "instance_id": {
/// "description": "The Instance to which the interface belongs.",
/// "type": "string",
/// "format": "uuid"
/// },
/// "ip": {
/// "description": "The IP address assigned to this interface.",
/// "type": "string",
/// "format": "ip"
/// },
/// "mac": {
/// "description": "The MAC address assigned to this interface.",
/// "allOf": [
/// {
/// "$ref": "#/components/schemas/MacAddr"
/// }
/// ]
/// },
/// "name": {
/// "description": "unique, mutable, user-controlled identifier for
/// each resource", "allOf": [
/// {
/// "$ref": "#/components/schemas/Name"
/// }
/// ]
/// },
/// "primary": {
/// "description": "True if this interface is the primary for the
/// instance to which it's attached.", "type": "boolean"
/// },
/// "subnet_id": {
/// "description": "The subnet to which the interface belongs.",
/// "type": "string",
/// "format": "uuid"
/// },
/// "time_created": {
/// "description": "timestamp when this resource was created",
/// "type": "string",
/// "format": "date-time"
/// },
/// "time_modified": {
/// "description": "timestamp when this resource was last modified",
/// "type": "string",
/// "format": "date-time"
/// },
/// "vpc_id": {
/// "description": "The VPC to which the interface belongs.",
/// "type": "string",
/// "format": "uuid"
/// }
/// }
///}
/// ```
/// </details>
2022-07-12 17:57:06 +00:00
#[derive(Clone, Debug, Deserialize, Serialize)]
2022-01-05 20:02:46 +00:00
pub struct NetworkInterface {
2022-07-03 02:09:38 +00:00
///human-readable free-form text about a resource
2022-02-08 16:59:38 +00:00
pub description: String,
2022-07-03 02:09:38 +00:00
///unique, immutable, system-controlled identifier for each resource
2022-02-08 16:59:38 +00:00
pub id: uuid::Uuid,
2022-07-03 02:09:38 +00:00
///The Instance to which the interface belongs.
2022-01-05 20:02:46 +00:00
pub instance_id: uuid::Uuid,
2022-07-03 02:09:38 +00:00
///The IP address assigned to this interface.
2022-07-03 05:28:06 +00:00
pub ip: std::net::IpAddr,
2022-07-03 02:09:38 +00:00
///The MAC address assigned to this interface.
2022-01-05 20:02:46 +00:00
pub mac: MacAddr,
2022-07-03 02:09:38 +00:00
///unique, mutable, user-controlled identifier for each resource
2022-02-08 16:59:38 +00:00
pub name: Name,
2022-07-08 01:35:36 +00:00
///True if this interface is the primary for the instance to which it's
/// attached.
pub primary: bool,
2022-07-03 02:09:38 +00:00
///The subnet to which the interface belongs.
2022-01-05 20:02:46 +00:00
pub subnet_id: uuid::Uuid,
2022-07-03 02:09:38 +00:00
///timestamp when this resource was created
2022-02-08 16:59:38 +00:00
pub time_created: chrono::DateTime<chrono::offset::Utc>,
2022-07-03 02:09:38 +00:00
///timestamp when this resource was last modified
2022-02-08 16:59:38 +00:00
pub time_modified: chrono::DateTime<chrono::offset::Utc>,
2022-07-03 02:09:38 +00:00
///The VPC to which the interface belongs.
2022-01-05 20:02:46 +00:00
pub vpc_id: uuid::Uuid,
}
2023-02-05 01:22:55 +00:00
impl From<&NetworkInterface> for NetworkInterface {
fn from(value: &NetworkInterface) -> Self {
value.clone()
}
}
2022-07-03 02:09:38 +00:00
///Create-time parameters for a
/// [`NetworkInterface`](omicron_common::api::external::NetworkInterface)
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "Create-time parameters for a [`NetworkInterface`](omicron_common::api::external::NetworkInterface)",
/// "type": "object",
/// "required": [
/// "description",
/// "name",
/// "subnet_name",
/// "vpc_name"
/// ],
/// "properties": {
/// "description": {
/// "type": "string"
/// },
/// "ip": {
/// "description": "The IP address for the interface. One will be
/// auto-assigned if not provided.", "type": [
/// "string",
/// "null"
/// ],
/// "format": "ip"
/// },
/// "name": {
/// "$ref": "#/components/schemas/Name"
/// },
/// "subnet_name": {
/// "description": "The VPC Subnet in which to create the interface.",
/// "allOf": [
/// {
/// "$ref": "#/components/schemas/Name"
/// }
/// ]
/// },
/// "vpc_name": {
/// "description": "The VPC in which to create the interface.",
/// "allOf": [
/// {
/// "$ref": "#/components/schemas/Name"
/// }
/// ]
/// }
/// }
///}
/// ```
/// </details>
2022-07-12 17:57:06 +00:00
#[derive(Clone, Debug, Deserialize, Serialize)]
2022-03-18 06:54:10 +00:00
pub struct NetworkInterfaceCreate {
pub description: String,
2022-07-03 02:09:38 +00:00
///The IP address for the interface. One will be auto-assigned if not
/// provided.
2022-03-18 06:54:10 +00:00
#[serde(default, skip_serializing_if = "Option::is_none")]
2022-07-03 05:28:06 +00:00
pub ip: Option<std::net::IpAddr>,
2022-03-18 06:54:10 +00:00
pub name: Name,
2022-07-03 02:09:38 +00:00
///The VPC Subnet in which to create the interface.
2022-03-18 06:54:10 +00:00
pub subnet_name: Name,
2022-07-03 02:09:38 +00:00
///The VPC in which to create the interface.
2022-03-18 06:54:10 +00:00
pub vpc_name: Name,
}
2023-02-05 01:22:55 +00:00
impl From<&NetworkInterfaceCreate> for NetworkInterfaceCreate {
fn from(value: &NetworkInterfaceCreate) -> Self {
value.clone()
}
}
2022-07-03 02:09:38 +00:00
///A single page of results
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "A single page of results",
/// "type": "object",
/// "required": [
/// "items"
/// ],
/// "properties": {
/// "items": {
/// "description": "list of items on this page of results",
/// "type": "array",
/// "items": {
/// "$ref": "#/components/schemas/NetworkInterface"
/// }
/// },
/// "next_page": {
/// "description": "token used to fetch the next page of results (if
/// any)", "type": [
/// "string",
/// "null"
/// ]
/// }
/// }
///}
/// ```
/// </details>
2022-07-12 17:57:06 +00:00
#[derive(Clone, Debug, Deserialize, Serialize)]
2022-01-05 20:02:46 +00:00
pub struct NetworkInterfaceResultsPage {
2022-07-03 02:09:38 +00:00
///list of items on this page of results
2022-01-05 20:02:46 +00:00
pub items: Vec<NetworkInterface>,
2022-07-03 02:09:38 +00:00
///token used to fetch the next page of results (if any)
2022-01-05 20:02:46 +00:00
#[serde(default, skip_serializing_if = "Option::is_none")]
pub next_page: Option<String>,
}
2023-02-05 01:22:55 +00:00
impl From<&NetworkInterfaceResultsPage> for NetworkInterfaceResultsPage {
fn from(value: &NetworkInterfaceResultsPage) -> Self {
value.clone()
}
}
2022-07-08 01:35:36 +00:00
///Parameters for updating a
/// [`NetworkInterface`](omicron_common::api::external::NetworkInterface).
///
///Note that modifying IP addresses for an interface is not yet supported,
/// a new interface must be created instead.
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "Parameters for updating a
/// [`NetworkInterface`](omicron_common::api::external::NetworkInterface).\
/// n\nNote that modifying IP addresses for an interface is not yet
/// supported, a new interface must be created instead.",
/// "type": "object",
/// "properties": {
/// "description": {
/// "type": [
/// "string",
/// "null"
/// ]
/// },
/// "name": {
/// "allOf": [
/// {
/// "$ref": "#/components/schemas/Name"
/// }
/// ]
/// },
/// "primary": {
/// "description": "Make a secondary interface the instance's primary
/// interface.\n\nIf applied to a secondary interface, that interface will
/// become the primary on the next reboot of the instance. Note that this
/// may have implications for routing between instances, as the new primary
/// interface will be on a distinct subnet from the previous primary
/// interface.\n\nNote that this can only be used to select a new primary
/// interface for an instance. Requests to change the primary interface into
/// a secondary will return an error.", "default": false,
/// "type": "boolean"
/// }
/// }
///}
/// ```
/// </details>
2022-07-12 17:57:06 +00:00
#[derive(Clone, Debug, Deserialize, Serialize)]
2022-07-08 01:35:36 +00:00
pub struct NetworkInterfaceUpdate {
#[serde(default, skip_serializing_if = "Option::is_none")]
pub description: Option<String>,
2023-02-01 05:28:12 +00:00
#[serde(default, skip_serializing_if = "Option::is_none")]
pub name: Option<Name>,
2022-07-08 01:35:36 +00:00
///Make a secondary interface the instance's primary interface.
///
///If applied to a secondary interface, that interface will become the
/// primary on the next reboot of the instance. Note that this may have
/// implications for routing between instances, as the new primary
/// interface will be on a distinct subnet from the previous primary
/// interface.
///
///Note that this can only be used to select a new primary interface
/// for an instance. Requests to change the primary interface into a
/// secondary will return an error.
#[serde(default)]
2023-02-01 05:28:12 +00:00
pub primary: bool,
}
2023-02-05 01:22:55 +00:00
impl From<&NetworkInterfaceUpdate> for NetworkInterfaceUpdate {
fn from(value: &NetworkInterfaceUpdate) -> Self {
value.clone()
}
}
2023-02-01 05:28:12 +00:00
///Unique name for a saga [`Node`]
///
///Each node requires a string name that's unique within its DAG. The name
/// is used to identify its output. Nodes that depend on a given node
/// (either directly or indirectly) can access the node's output using its
/// name.
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "Unique name for a saga [`Node`]\n\nEach node requires a
/// string name that's unique within its DAG. The name is used to identify
/// its output. Nodes that depend on a given node (either directly or
/// indirectly) can access the node's output using its name.",
/// "type": "string"
///}
/// ```
/// </details>
2023-05-02 20:55:50 +00:00
#[derive(Clone, Debug, Deserialize, Eq, Hash, Ord, PartialEq, PartialOrd, Serialize)]
2023-02-01 05:28:12 +00:00
pub struct NodeName(pub String);
impl std::ops::Deref for NodeName {
type Target = String;
fn deref(&self) -> &String {
&self.0
}
2022-07-08 01:35:36 +00:00
}
2023-02-05 01:22:55 +00:00
impl From<NodeName> for String {
fn from(value: NodeName) -> Self {
value.0
}
}
impl From<&NodeName> for NodeName {
fn from(value: &NodeName) -> Self {
value.clone()
}
}
impl From<String> for NodeName {
fn from(value: String) -> Self {
Self(value)
}
}
impl std::str::FromStr for NodeName {
type Err = std::convert::Infallible;
fn from_str(value: &str) -> Result<Self, Self::Err> {
Ok(Self(value.to_string()))
}
}
impl ToString for NodeName {
fn to_string(&self) -> String {
self.0.to_string()
}
}
2022-07-03 02:09:38 +00:00
///Client view of an [`Organization`]
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "Client view of an [`Organization`]",
/// "type": "object",
/// "required": [
/// "description",
/// "id",
/// "name",
/// "time_created",
/// "time_modified"
/// ],
/// "properties": {
/// "description": {
/// "description": "human-readable free-form text about a resource",
/// "type": "string"
/// },
/// "id": {
/// "description": "unique, immutable, system-controlled identifier for
/// each resource", "type": "string",
/// "format": "uuid"
/// },
/// "name": {
/// "description": "unique, mutable, user-controlled identifier for
/// each resource", "allOf": [
/// {
/// "$ref": "#/components/schemas/Name"
/// }
/// ]
/// },
/// "time_created": {
/// "description": "timestamp when this resource was created",
/// "type": "string",
/// "format": "date-time"
/// },
/// "time_modified": {
/// "description": "timestamp when this resource was last modified",
/// "type": "string",
/// "format": "date-time"
/// }
/// }
///}
/// ```
/// </details>
2022-07-12 17:57:06 +00:00
#[derive(Clone, Debug, Deserialize, Serialize)]
2021-12-10 02:15:24 +00:00
pub struct Organization {
2022-07-03 02:09:38 +00:00
///human-readable free-form text about a resource
2021-12-10 02:15:24 +00:00
pub description: String,
2022-07-03 02:09:38 +00:00
///unique, immutable, system-controlled identifier for each resource
2021-12-10 02:15:24 +00:00
pub id: uuid::Uuid,
2022-07-03 02:09:38 +00:00
///unique, mutable, user-controlled identifier for each resource
2021-12-10 02:15:24 +00:00
pub name: Name,
2022-07-03 02:09:38 +00:00
///timestamp when this resource was created
2021-12-10 02:15:24 +00:00
pub time_created: chrono::DateTime<chrono::offset::Utc>,
2022-07-03 02:09:38 +00:00
///timestamp when this resource was last modified
2021-12-10 02:15:24 +00:00
pub time_modified: chrono::DateTime<chrono::offset::Utc>,
}
2023-02-05 01:22:55 +00:00
impl From<&Organization> for Organization {
fn from(value: &Organization) -> Self {
value.clone()
}
}
2022-07-03 02:09:38 +00:00
///Create-time parameters for an
/// [`Organization`](crate::external_api::views::Organization)
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "Create-time parameters for an
/// [`Organization`](crate::external_api::views::Organization)",
/// "type": "object",
/// "required": [
/// "description",
/// "name"
/// ],
/// "properties": {
/// "description": {
/// "type": "string"
/// },
/// "name": {
/// "$ref": "#/components/schemas/Name"
/// }
/// }
///}
/// ```
/// </details>
2022-07-12 17:57:06 +00:00
#[derive(Clone, Debug, Deserialize, Serialize)]
2021-12-10 02:15:24 +00:00
pub struct OrganizationCreate {
pub description: String,
pub name: Name,
}
2023-02-05 01:22:55 +00:00
impl From<&OrganizationCreate> for OrganizationCreate {
fn from(value: &OrganizationCreate) -> Self {
value.clone()
}
}
2022-07-03 02:09:38 +00:00
///A single page of results
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "A single page of results",
/// "type": "object",
/// "required": [
/// "items"
/// ],
/// "properties": {
/// "items": {
/// "description": "list of items on this page of results",
/// "type": "array",
/// "items": {
/// "$ref": "#/components/schemas/Organization"
/// }
/// },
/// "next_page": {
/// "description": "token used to fetch the next page of results (if
/// any)", "type": [
/// "string",
/// "null"
/// ]
/// }
/// }
///}
/// ```
/// </details>
2022-07-12 17:57:06 +00:00
#[derive(Clone, Debug, Deserialize, Serialize)]
2021-12-10 02:15:24 +00:00
pub struct OrganizationResultsPage {
2022-07-03 02:09:38 +00:00
///list of items on this page of results
2021-12-10 02:15:24 +00:00
pub items: Vec<Organization>,
2022-07-03 02:09:38 +00:00
///token used to fetch the next page of results (if any)
2021-12-10 02:15:24 +00:00
#[serde(default, skip_serializing_if = "Option::is_none")]
pub next_page: Option<String>,
}
2023-02-05 01:22:55 +00:00
impl From<&OrganizationResultsPage> for OrganizationResultsPage {
fn from(value: &OrganizationResultsPage) -> Self {
value.clone()
}
}
2023-12-13 09:14:28 +00:00
///OrganizationRole
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "type": "string",
/// "enum": [
/// "admin",
/// "collaborator",
/// "viewer"
/// ]
///}
/// ```
/// </details>
2022-07-12 17:57:06 +00:00
#[derive(Clone, Copy, Debug, Deserialize, Eq, Hash, Ord, PartialEq, PartialOrd, Serialize)]
2022-07-08 01:35:36 +00:00
pub enum OrganizationRole {
2022-05-23 15:49:37 +00:00
#[serde(rename = "admin")]
Admin,
#[serde(rename = "collaborator")]
Collaborator,
2022-07-08 01:35:36 +00:00
#[serde(rename = "viewer")]
Viewer,
2022-05-23 15:49:37 +00:00
}
2023-02-05 01:22:55 +00:00
impl From<&OrganizationRole> for OrganizationRole {
fn from(value: &OrganizationRole) -> Self {
value.clone()
}
}
2022-07-08 01:35:36 +00:00
impl ToString for OrganizationRole {
2022-05-23 15:49:37 +00:00
fn to_string(&self) -> String {
match *self {
2022-07-12 17:57:06 +00:00
Self::Admin => "admin".to_string(),
Self::Collaborator => "collaborator".to_string(),
Self::Viewer => "viewer".to_string(),
}
}
}
impl std::str::FromStr for OrganizationRole {
type Err = &'static str;
2023-01-25 17:19:15 +00:00
fn from_str(value: &str) -> Result<Self, &'static str> {
2022-07-12 17:57:06 +00:00
match value {
"admin" => Ok(Self::Admin),
"collaborator" => Ok(Self::Collaborator),
"viewer" => Ok(Self::Viewer),
_ => Err("invalid value"),
2022-05-23 15:49:37 +00:00
}
}
}
2023-01-25 17:19:15 +00:00
impl std::convert::TryFrom<&str> for OrganizationRole {
type Error = &'static str;
fn try_from(value: &str) -> Result<Self, &'static str> {
value.parse()
}
}
impl std::convert::TryFrom<&String> for OrganizationRole {
type Error = &'static str;
fn try_from(value: &String) -> Result<Self, &'static str> {
value.parse()
}
}
2023-01-30 20:17:51 +00:00
impl std::convert::TryFrom<String> for OrganizationRole {
type Error = &'static str;
fn try_from(value: String) -> Result<Self, &'static str> {
value.parse()
}
}
2022-07-03 02:09:38 +00:00
///Client view of a [`Policy`], which describes how this resource may be
/// accessed
///
///Note that the Policy only describes access granted explicitly for this
/// resource. The policies of parent resources can also cause a user to
/// have access to this resource.
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "Client view of a [`Policy`], which describes how this
/// resource may be accessed\n\nNote that the Policy only describes access
/// granted explicitly for this resource. The policies of parent resources
/// can also cause a user to have access to this resource.",
/// "type": "object",
/// "required": [
/// "role_assignments"
/// ],
/// "properties": {
/// "role_assignments": {
/// "description": "Roles directly assigned on this resource",
/// "type": "array",
/// "items": {
/// "$ref": "#/components/schemas/OrganizationRoleRoleAssignment"
/// }
/// }
/// }
///}
/// ```
/// </details>
2022-07-12 17:57:06 +00:00
#[derive(Clone, Debug, Deserialize, Serialize)]
2022-07-08 01:35:36 +00:00
pub struct OrganizationRolePolicy {
2022-07-03 02:09:38 +00:00
///Roles directly assigned on this resource
2022-07-08 01:35:36 +00:00
pub role_assignments: Vec<OrganizationRoleRoleAssignment>,
2022-05-23 15:49:37 +00:00
}
2023-02-05 01:22:55 +00:00
impl From<&OrganizationRolePolicy> for OrganizationRolePolicy {
fn from(value: &OrganizationRolePolicy) -> Self {
value.clone()
}
}
2022-07-03 02:09:38 +00:00
///Describes the assignment of a particular role on a particular resource
/// to a particular identity (user, group, etc.)
///
///The resource is not part of this structure. Rather, [`RoleAssignment`]s
/// are put into a [`Policy`] and that Policy is applied to a particular
/// resource.
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "Describes the assignment of a particular role on a
/// particular resource to a particular identity (user, group, etc.)\n\nThe
/// resource is not part of this structure. Rather, [`RoleAssignment`]s are
/// put into a [`Policy`] and that Policy is applied to a particular
/// resource.", "type": "object",
/// "required": [
/// "identity_id",
/// "identity_type",
/// "role_name"
/// ],
/// "properties": {
/// "identity_id": {
/// "type": "string",
/// "format": "uuid"
/// },
/// "identity_type": {
/// "$ref": "#/components/schemas/IdentityType"
/// },
/// "role_name": {
/// "$ref": "#/components/schemas/OrganizationRole"
/// }
/// }
///}
/// ```
/// </details>
2022-07-12 17:57:06 +00:00
#[derive(Clone, Debug, Deserialize, Serialize)]
2022-07-08 01:35:36 +00:00
pub struct OrganizationRoleRoleAssignment {
2022-05-23 15:49:37 +00:00
pub identity_id: uuid::Uuid,
pub identity_type: IdentityType,
2022-07-08 01:35:36 +00:00
pub role_name: OrganizationRole,
2022-05-23 15:49:37 +00:00
}
2023-02-05 01:22:55 +00:00
impl From<&OrganizationRoleRoleAssignment> for OrganizationRoleRoleAssignment {
fn from(value: &OrganizationRoleRoleAssignment) -> Self {
value.clone()
}
}
2022-07-03 02:09:38 +00:00
///Updateable properties of an
/// [`Organization`](crate::external_api::views::Organization)
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "Updateable properties of an
/// [`Organization`](crate::external_api::views::Organization)",
/// "type": "object",
/// "properties": {
/// "description": {
/// "type": [
/// "string",
/// "null"
/// ]
/// },
/// "name": {
/// "allOf": [
/// {
/// "$ref": "#/components/schemas/Name"
/// }
/// ]
/// }
/// }
///}
/// ```
/// </details>
2022-07-12 17:57:06 +00:00
#[derive(Clone, Debug, Deserialize, Serialize)]
2021-12-10 02:15:24 +00:00
pub struct OrganizationUpdate {
#[serde(default, skip_serializing_if = "Option::is_none")]
pub description: Option<String>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub name: Option<Name>,
}
2023-02-05 01:22:55 +00:00
impl From<&OrganizationUpdate> for OrganizationUpdate {
fn from(value: &OrganizationUpdate) -> Self {
value.clone()
}
}
2023-02-01 05:28:12 +00:00
///Passwords may be subject to additional constraints.
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "title": "A password used to authenticate a user",
/// "description": "Passwords may be subject to additional constraints.",
/// "type": "string",
/// "maxLength": 512
///}
/// ```
/// </details>
2023-05-02 20:55:50 +00:00
#[derive(Clone, Debug, Eq, Hash, Ord, PartialEq, PartialOrd, Serialize)]
2023-02-01 05:28:12 +00:00
pub struct Password(String);
impl std::ops::Deref for Password {
type Target = String;
fn deref(&self) -> &String {
&self.0
}
}
2023-02-05 01:22:55 +00:00
impl From<Password> for String {
fn from(value: Password) -> Self {
value.0
}
}
impl From<&Password> for Password {
fn from(value: &Password) -> Self {
value.clone()
}
}
2023-02-01 05:28:12 +00:00
impl std::str::FromStr for Password {
type Err = &'static str;
fn from_str(value: &str) -> Result<Self, &'static str> {
if value.len() > 512usize {
return Err("longer than 512 characters");
}
Ok(Self(value.to_string()))
}
}
impl std::convert::TryFrom<&str> for Password {
type Error = &'static str;
fn try_from(value: &str) -> Result<Self, &'static str> {
value.parse()
}
}
impl std::convert::TryFrom<&String> for Password {
type Error = &'static str;
fn try_from(value: &String) -> Result<Self, &'static str> {
value.parse()
}
}
impl std::convert::TryFrom<String> for Password {
type Error = &'static str;
fn try_from(value: String) -> Result<Self, &'static str> {
value.parse()
}
}
impl<'de> serde::Deserialize<'de> for Password {
fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where
D: serde::Deserializer<'de>,
{
String::deserialize(deserializer)?
.parse()
.map_err(|e: &'static str| <D::Error as serde::de::Error>::custom(e.to_string()))
}
}
///Client view of a [`PhysicalDisk`]
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "Client view of a [`PhysicalDisk`]",
/// "type": "object",
/// "required": [
/// "disk_type",
/// "id",
/// "model",
/// "serial",
/// "time_created",
/// "time_modified",
/// "vendor"
/// ],
/// "properties": {
/// "disk_type": {
/// "$ref": "#/components/schemas/PhysicalDiskType"
/// },
/// "id": {
/// "description": "unique, immutable, system-controlled identifier for
/// each resource", "type": "string",
/// "format": "uuid"
/// },
/// "model": {
/// "type": "string"
/// },
/// "serial": {
/// "type": "string"
/// },
/// "sled_id": {
/// "description": "The sled to which this disk is attached, if any.",
/// "type": [
/// "string",
/// "null"
/// ],
/// "format": "uuid"
/// },
/// "time_created": {
/// "description": "timestamp when this resource was created",
/// "type": "string",
/// "format": "date-time"
/// },
/// "time_modified": {
/// "description": "timestamp when this resource was last modified",
/// "type": "string",
/// "format": "date-time"
/// },
/// "vendor": {
/// "type": "string"
/// }
/// }
///}
/// ```
/// </details>
2023-02-01 05:28:12 +00:00
#[derive(Clone, Debug, Deserialize, Serialize)]
pub struct PhysicalDisk {
pub disk_type: PhysicalDiskType,
///unique, immutable, system-controlled identifier for each resource
pub id: uuid::Uuid,
pub model: String,
pub serial: String,
///The sled to which this disk is attached, if any.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub sled_id: Option<uuid::Uuid>,
///timestamp when this resource was created
pub time_created: chrono::DateTime<chrono::offset::Utc>,
///timestamp when this resource was last modified
pub time_modified: chrono::DateTime<chrono::offset::Utc>,
pub vendor: String,
}
2023-02-05 01:22:55 +00:00
impl From<&PhysicalDisk> for PhysicalDisk {
fn from(value: &PhysicalDisk) -> Self {
value.clone()
}
}
2023-02-01 05:28:12 +00:00
///A single page of results
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "A single page of results",
/// "type": "object",
/// "required": [
/// "items"
/// ],
/// "properties": {
/// "items": {
/// "description": "list of items on this page of results",
/// "type": "array",
/// "items": {
/// "$ref": "#/components/schemas/PhysicalDisk"
/// }
/// },
/// "next_page": {
/// "description": "token used to fetch the next page of results (if
/// any)", "type": [
/// "string",
/// "null"
/// ]
/// }
/// }
///}
/// ```
/// </details>
2023-02-01 05:28:12 +00:00
#[derive(Clone, Debug, Deserialize, Serialize)]
pub struct PhysicalDiskResultsPage {
///list of items on this page of results
pub items: Vec<PhysicalDisk>,
///token used to fetch the next page of results (if any)
#[serde(default, skip_serializing_if = "Option::is_none")]
pub next_page: Option<String>,
}
2023-02-05 01:22:55 +00:00
impl From<&PhysicalDiskResultsPage> for PhysicalDiskResultsPage {
fn from(value: &PhysicalDiskResultsPage) -> Self {
value.clone()
}
}
2023-12-13 09:14:28 +00:00
///PhysicalDiskType
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "type": "string",
/// "enum": [
/// "internal",
/// "external"
/// ]
///}
/// ```
/// </details>
2023-02-01 05:28:12 +00:00
#[derive(Clone, Copy, Debug, Deserialize, Eq, Hash, Ord, PartialEq, PartialOrd, Serialize)]
pub enum PhysicalDiskType {
#[serde(rename = "internal")]
Internal,
#[serde(rename = "external")]
External,
}
2023-02-05 01:22:55 +00:00
impl From<&PhysicalDiskType> for PhysicalDiskType {
fn from(value: &PhysicalDiskType) -> Self {
value.clone()
}
}
2023-02-01 05:28:12 +00:00
impl ToString for PhysicalDiskType {
fn to_string(&self) -> String {
match *self {
Self::Internal => "internal".to_string(),
Self::External => "external".to_string(),
}
}
}
impl std::str::FromStr for PhysicalDiskType {
type Err = &'static str;
fn from_str(value: &str) -> Result<Self, &'static str> {
match value {
"internal" => Ok(Self::Internal),
"external" => Ok(Self::External),
_ => Err("invalid value"),
}
}
}
impl std::convert::TryFrom<&str> for PhysicalDiskType {
type Error = &'static str;
fn try_from(value: &str) -> Result<Self, &'static str> {
value.parse()
}
}
impl std::convert::TryFrom<&String> for PhysicalDiskType {
type Error = &'static str;
fn try_from(value: &String) -> Result<Self, &'static str> {
value.parse()
}
}
impl std::convert::TryFrom<String> for PhysicalDiskType {
type Error = &'static str;
fn try_from(value: String) -> Result<Self, &'static str> {
value.parse()
}
}
2022-07-03 02:09:38 +00:00
///Client view of a [`Project`]
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "Client view of a [`Project`]",
/// "type": "object",
/// "required": [
/// "description",
/// "id",
/// "name",
/// "organization_id",
/// "time_created",
/// "time_modified"
/// ],
/// "properties": {
/// "description": {
/// "description": "human-readable free-form text about a resource",
/// "type": "string"
/// },
/// "id": {
/// "description": "unique, immutable, system-controlled identifier for
/// each resource", "type": "string",
/// "format": "uuid"
/// },
/// "name": {
/// "description": "unique, mutable, user-controlled identifier for
/// each resource", "allOf": [
/// {
/// "$ref": "#/components/schemas/Name"
/// }
/// ]
/// },
/// "organization_id": {
/// "type": "string",
/// "format": "uuid"
/// },
/// "time_created": {
/// "description": "timestamp when this resource was created",
/// "type": "string",
/// "format": "date-time"
/// },
/// "time_modified": {
/// "description": "timestamp when this resource was last modified",
/// "type": "string",
/// "format": "date-time"
/// }
/// }
///}
/// ```
/// </details>
2022-07-12 17:57:06 +00:00
#[derive(Clone, Debug, Deserialize, Serialize)]
2021-12-10 02:15:24 +00:00
pub struct Project {
2022-07-03 02:09:38 +00:00
///human-readable free-form text about a resource
2021-12-10 02:15:24 +00:00
pub description: String,
2022-07-03 02:09:38 +00:00
///unique, immutable, system-controlled identifier for each resource
2021-12-10 02:15:24 +00:00
pub id: uuid::Uuid,
2022-07-03 02:09:38 +00:00
///unique, mutable, user-controlled identifier for each resource
2021-12-10 02:15:24 +00:00
pub name: Name,
pub organization_id: uuid::Uuid,
2022-07-03 02:09:38 +00:00
///timestamp when this resource was created
2021-12-10 02:15:24 +00:00
pub time_created: chrono::DateTime<chrono::offset::Utc>,
2022-07-03 02:09:38 +00:00
///timestamp when this resource was last modified
2021-12-10 02:15:24 +00:00
pub time_modified: chrono::DateTime<chrono::offset::Utc>,
}
2023-02-05 01:22:55 +00:00
impl From<&Project> for Project {
fn from(value: &Project) -> Self {
value.clone()
}
}
2022-07-03 02:09:38 +00:00
///Create-time parameters for a
/// [`Project`](crate::external_api::views::Project)
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "Create-time parameters for a
/// [`Project`](crate::external_api::views::Project)", "type": "object"
/// , "required": [
/// "description",
/// "name"
/// ],
/// "properties": {
/// "description": {
/// "type": "string"
/// },
/// "name": {
/// "$ref": "#/components/schemas/Name"
/// }
/// }
///}
/// ```
/// </details>
2022-07-12 17:57:06 +00:00
#[derive(Clone, Debug, Deserialize, Serialize)]
2021-12-10 02:15:24 +00:00
pub struct ProjectCreate {
pub description: String,
pub name: Name,
}
2023-02-05 01:22:55 +00:00
impl From<&ProjectCreate> for ProjectCreate {
fn from(value: &ProjectCreate) -> Self {
value.clone()
}
}
2022-07-03 02:09:38 +00:00
///A single page of results
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "A single page of results",
/// "type": "object",
/// "required": [
/// "items"
/// ],
/// "properties": {
/// "items": {
/// "description": "list of items on this page of results",
/// "type": "array",
/// "items": {
/// "$ref": "#/components/schemas/Project"
/// }
/// },
/// "next_page": {
/// "description": "token used to fetch the next page of results (if
/// any)", "type": [
/// "string",
/// "null"
/// ]
/// }
/// }
///}
/// ```
/// </details>
2022-07-12 17:57:06 +00:00
#[derive(Clone, Debug, Deserialize, Serialize)]
2021-12-10 02:15:24 +00:00
pub struct ProjectResultsPage {
2022-07-03 02:09:38 +00:00
///list of items on this page of results
2021-12-10 02:15:24 +00:00
pub items: Vec<Project>,
2022-07-03 02:09:38 +00:00
///token used to fetch the next page of results (if any)
2021-12-10 02:15:24 +00:00
#[serde(default, skip_serializing_if = "Option::is_none")]
pub next_page: Option<String>,
}
2023-02-05 01:22:55 +00:00
impl From<&ProjectResultsPage> for ProjectResultsPage {
fn from(value: &ProjectResultsPage) -> Self {
value.clone()
}
}
2023-12-13 09:14:28 +00:00
///ProjectRole
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "type": "string",
/// "enum": [
/// "admin",
/// "collaborator",
/// "viewer"
/// ]
///}
/// ```
/// </details>
2022-07-12 17:57:06 +00:00
#[derive(Clone, Copy, Debug, Deserialize, Eq, Hash, Ord, PartialEq, PartialOrd, Serialize)]
2022-07-08 01:35:36 +00:00
pub enum ProjectRole {
2022-05-23 15:49:37 +00:00
#[serde(rename = "admin")]
Admin,
#[serde(rename = "collaborator")]
Collaborator,
#[serde(rename = "viewer")]
Viewer,
}
2023-02-05 01:22:55 +00:00
impl From<&ProjectRole> for ProjectRole {
fn from(value: &ProjectRole) -> Self {
value.clone()
}
}
2022-07-08 01:35:36 +00:00
impl ToString for ProjectRole {
2022-05-23 15:49:37 +00:00
fn to_string(&self) -> String {
match *self {
2022-07-12 17:57:06 +00:00
Self::Admin => "admin".to_string(),
Self::Collaborator => "collaborator".to_string(),
Self::Viewer => "viewer".to_string(),
}
}
}
impl std::str::FromStr for ProjectRole {
type Err = &'static str;
2023-01-25 17:19:15 +00:00
fn from_str(value: &str) -> Result<Self, &'static str> {
2022-07-12 17:57:06 +00:00
match value {
"admin" => Ok(Self::Admin),
"collaborator" => Ok(Self::Collaborator),
"viewer" => Ok(Self::Viewer),
_ => Err("invalid value"),
2022-05-23 15:49:37 +00:00
}
}
}
2023-01-25 17:19:15 +00:00
impl std::convert::TryFrom<&str> for ProjectRole {
type Error = &'static str;
fn try_from(value: &str) -> Result<Self, &'static str> {
value.parse()
}
}
impl std::convert::TryFrom<&String> for ProjectRole {
type Error = &'static str;
fn try_from(value: &String) -> Result<Self, &'static str> {
value.parse()
}
}
2023-01-30 20:17:51 +00:00
impl std::convert::TryFrom<String> for ProjectRole {
type Error = &'static str;
fn try_from(value: String) -> Result<Self, &'static str> {
value.parse()
}
}
2022-07-03 02:09:38 +00:00
///Client view of a [`Policy`], which describes how this resource may be
/// accessed
///
///Note that the Policy only describes access granted explicitly for this
/// resource. The policies of parent resources can also cause a user to
/// have access to this resource.
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "Client view of a [`Policy`], which describes how this
/// resource may be accessed\n\nNote that the Policy only describes access
/// granted explicitly for this resource. The policies of parent resources
/// can also cause a user to have access to this resource.",
/// "type": "object",
/// "required": [
/// "role_assignments"
/// ],
/// "properties": {
/// "role_assignments": {
/// "description": "Roles directly assigned on this resource",
/// "type": "array",
/// "items": {
/// "$ref": "#/components/schemas/ProjectRoleRoleAssignment"
/// }
/// }
/// }
///}
/// ```
/// </details>
2022-07-12 17:57:06 +00:00
#[derive(Clone, Debug, Deserialize, Serialize)]
2022-07-08 01:35:36 +00:00
pub struct ProjectRolePolicy {
2022-07-03 02:09:38 +00:00
///Roles directly assigned on this resource
2022-07-08 01:35:36 +00:00
pub role_assignments: Vec<ProjectRoleRoleAssignment>,
2022-05-23 15:49:37 +00:00
}
2023-02-05 01:22:55 +00:00
impl From<&ProjectRolePolicy> for ProjectRolePolicy {
fn from(value: &ProjectRolePolicy) -> Self {
value.clone()
}
}
2022-07-03 02:09:38 +00:00
///Describes the assignment of a particular role on a particular resource
/// to a particular identity (user, group, etc.)
///
///The resource is not part of this structure. Rather, [`RoleAssignment`]s
/// are put into a [`Policy`] and that Policy is applied to a particular
/// resource.
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "Describes the assignment of a particular role on a
/// particular resource to a particular identity (user, group, etc.)\n\nThe
/// resource is not part of this structure. Rather, [`RoleAssignment`]s are
/// put into a [`Policy`] and that Policy is applied to a particular
/// resource.", "type": "object",
/// "required": [
/// "identity_id",
/// "identity_type",
/// "role_name"
/// ],
/// "properties": {
/// "identity_id": {
/// "type": "string",
/// "format": "uuid"
/// },
/// "identity_type": {
/// "$ref": "#/components/schemas/IdentityType"
/// },
/// "role_name": {
/// "$ref": "#/components/schemas/ProjectRole"
/// }
/// }
///}
/// ```
/// </details>
2022-07-12 17:57:06 +00:00
#[derive(Clone, Debug, Deserialize, Serialize)]
2022-07-08 01:35:36 +00:00
pub struct ProjectRoleRoleAssignment {
2022-05-23 15:49:37 +00:00
pub identity_id: uuid::Uuid,
pub identity_type: IdentityType,
2022-07-08 01:35:36 +00:00
pub role_name: ProjectRole,
2022-05-23 15:49:37 +00:00
}
2023-02-05 01:22:55 +00:00
impl From<&ProjectRoleRoleAssignment> for ProjectRoleRoleAssignment {
fn from(value: &ProjectRoleRoleAssignment) -> Self {
value.clone()
}
}
2022-07-03 02:09:38 +00:00
///Updateable properties of a
/// [`Project`](crate::external_api::views::Project)
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "Updateable properties of a
/// [`Project`](crate::external_api::views::Project)", "type": "object"
/// , "properties": {
/// "description": {
/// "type": [
/// "string",
/// "null"
/// ]
/// },
/// "name": {
/// "allOf": [
/// {
/// "$ref": "#/components/schemas/Name"
/// }
/// ]
/// }
/// }
///}
/// ```
/// </details>
2022-07-12 17:57:06 +00:00
#[derive(Clone, Debug, Deserialize, Serialize)]
2021-12-10 02:15:24 +00:00
pub struct ProjectUpdate {
#[serde(default, skip_serializing_if = "Option::is_none")]
pub description: Option<String>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub name: Option<Name>,
}
2023-02-05 01:22:55 +00:00
impl From<&ProjectUpdate> for ProjectUpdate {
fn from(value: &ProjectUpdate) -> Self {
value.clone()
}
}
2022-07-03 02:09:38 +00:00
///Client view of an [`Rack`]
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "Client view of an [`Rack`]",
/// "type": "object",
/// "required": [
/// "id",
/// "time_created",
/// "time_modified"
/// ],
/// "properties": {
/// "id": {
/// "description": "unique, immutable, system-controlled identifier for
/// each resource", "type": "string",
/// "format": "uuid"
/// },
/// "time_created": {
/// "description": "timestamp when this resource was created",
/// "type": "string",
/// "format": "date-time"
/// },
/// "time_modified": {
/// "description": "timestamp when this resource was last modified",
/// "type": "string",
/// "format": "date-time"
/// }
/// }
///}
/// ```
/// </details>
2022-07-12 17:57:06 +00:00
#[derive(Clone, Debug, Deserialize, Serialize)]
2021-12-10 02:15:24 +00:00
pub struct Rack {
2022-07-03 02:09:38 +00:00
///unique, immutable, system-controlled identifier for each resource
2022-02-08 16:59:38 +00:00
pub id: uuid::Uuid,
2022-07-03 02:09:38 +00:00
///timestamp when this resource was created
2022-02-08 16:59:38 +00:00
pub time_created: chrono::DateTime<chrono::offset::Utc>,
2022-07-03 02:09:38 +00:00
///timestamp when this resource was last modified
2022-02-08 16:59:38 +00:00
pub time_modified: chrono::DateTime<chrono::offset::Utc>,
2021-12-10 02:15:24 +00:00
}
2023-02-05 01:22:55 +00:00
impl From<&Rack> for Rack {
fn from(value: &Rack) -> Self {
value.clone()
}
}
2022-07-03 02:09:38 +00:00
///A single page of results
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "A single page of results",
/// "type": "object",
/// "required": [
/// "items"
/// ],
/// "properties": {
/// "items": {
/// "description": "list of items on this page of results",
/// "type": "array",
/// "items": {
/// "$ref": "#/components/schemas/Rack"
/// }
/// },
/// "next_page": {
/// "description": "token used to fetch the next page of results (if
/// any)", "type": [
/// "string",
/// "null"
/// ]
/// }
/// }
///}
/// ```
/// </details>
2022-07-12 17:57:06 +00:00
#[derive(Clone, Debug, Deserialize, Serialize)]
2021-12-10 02:15:24 +00:00
pub struct RackResultsPage {
2022-07-03 02:09:38 +00:00
///list of items on this page of results
2021-12-10 02:15:24 +00:00
pub items: Vec<Rack>,
2022-07-03 02:09:38 +00:00
///token used to fetch the next page of results (if any)
2021-12-10 02:15:24 +00:00
#[serde(default, skip_serializing_if = "Option::is_none")]
pub next_page: Option<String>,
}
2023-02-05 01:22:55 +00:00
impl From<&RackResultsPage> for RackResultsPage {
fn from(value: &RackResultsPage) -> Self {
value.clone()
}
}
2022-07-03 02:09:38 +00:00
///Client view of a [`Role`]
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "Client view of a [`Role`]",
/// "type": "object",
/// "required": [
/// "description",
/// "name"
/// ],
/// "properties": {
/// "description": {
/// "type": "string"
/// },
/// "name": {
/// "$ref": "#/components/schemas/RoleName"
/// }
/// }
///}
/// ```
/// </details>
2022-07-12 17:57:06 +00:00
#[derive(Clone, Debug, Deserialize, Serialize)]
2022-01-05 20:02:46 +00:00
pub struct Role {
pub description: String,
pub name: RoleName,
}
2023-02-05 01:22:55 +00:00
impl From<&Role> for Role {
fn from(value: &Role) -> Self {
value.clone()
}
}
2022-07-03 02:09:38 +00:00
///Role names consist of two string components separated by dot (".").
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "title": "A name for a built-in role",
/// "description": "Role names consist of two string components separated
/// by dot (\".\").", "type": "string",
/// "maxLength": 63,
/// "pattern": "[a-z-]+\\.[a-z-]+"
///}
/// ```
/// </details>
2023-05-02 20:55:50 +00:00
#[derive(Clone, Debug, Eq, Hash, Ord, PartialEq, PartialOrd, Serialize)]
2022-07-12 17:57:06 +00:00
pub struct RoleName(String);
2022-01-05 20:02:46 +00:00
impl std::ops::Deref for RoleName {
type Target = String;
2023-01-25 17:19:15 +00:00
fn deref(&self) -> &String {
2022-01-05 20:02:46 +00:00
&self.0
}
}
2023-02-05 01:22:55 +00:00
impl From<RoleName> for String {
fn from(value: RoleName) -> Self {
value.0
}
}
impl From<&RoleName> for RoleName {
fn from(value: &RoleName) -> Self {
value.clone()
}
}
2023-01-25 17:19:15 +00:00
impl std::str::FromStr for RoleName {
type Err = &'static str;
fn from_str(value: &str) -> Result<Self, &'static str> {
2022-07-12 17:57:06 +00:00
if value.len() > 63usize {
return Err("longer than 63 characters");
}
if regress::Regex::new("[a-z-]+\\.[a-z-]+")
.unwrap()
.find(value)
.is_none()
{
return Err("doesn't match pattern \"[a-z-]+\\.[a-z-]+\"");
}
Ok(Self(value.to_string()))
}
}
2023-01-25 17:19:15 +00:00
impl std::convert::TryFrom<&str> for RoleName {
2022-09-10 16:41:07 +00:00
type Error = &'static str;
2023-01-25 17:19:15 +00:00
fn try_from(value: &str) -> Result<Self, &'static str> {
value.parse()
2022-09-10 16:41:07 +00:00
}
}
2023-01-25 17:19:15 +00:00
impl std::convert::TryFrom<&String> for RoleName {
2022-07-12 17:57:06 +00:00
type Error = &'static str;
2023-01-25 17:19:15 +00:00
fn try_from(value: &String) -> Result<Self, &'static str> {
value.parse()
2022-07-12 17:57:06 +00:00
}
}
2023-01-30 20:17:51 +00:00
impl std::convert::TryFrom<String> for RoleName {
type Error = &'static str;
fn try_from(value: String) -> Result<Self, &'static str> {
value.parse()
}
}
2022-07-12 17:57:06 +00:00
impl<'de> serde::Deserialize<'de> for RoleName {
fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where
D: serde::Deserializer<'de>,
{
2023-01-25 17:19:15 +00:00
String::deserialize(deserializer)?
.parse()
.map_err(|e: &'static str| <D::Error as serde::de::Error>::custom(e.to_string()))
2022-07-12 17:57:06 +00:00
}
}
2022-07-03 02:09:38 +00:00
///A single page of results
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "A single page of results",
/// "type": "object",
/// "required": [
/// "items"
/// ],
/// "properties": {
/// "items": {
/// "description": "list of items on this page of results",
/// "type": "array",
/// "items": {
/// "$ref": "#/components/schemas/Role"
/// }
/// },
/// "next_page": {
/// "description": "token used to fetch the next page of results (if
/// any)", "type": [
/// "string",
/// "null"
/// ]
/// }
/// }
///}
/// ```
/// </details>
2022-07-12 17:57:06 +00:00
#[derive(Clone, Debug, Deserialize, Serialize)]
2022-01-05 20:02:46 +00:00
pub struct RoleResultsPage {
2022-07-03 02:09:38 +00:00
///list of items on this page of results
2022-01-05 20:02:46 +00:00
pub items: Vec<Role>,
2022-07-03 02:09:38 +00:00
///token used to fetch the next page of results (if any)
2022-01-05 20:02:46 +00:00
#[serde(default, skip_serializing_if = "Option::is_none")]
pub next_page: Option<String>,
}
2023-02-05 01:22:55 +00:00
impl From<&RoleResultsPage> for RoleResultsPage {
fn from(value: &RoleResultsPage) -> Self {
value.clone()
}
}
2022-07-03 02:09:38 +00:00
///A `RouteDestination` is used to match traffic with a routing rule, on
/// the destination of that traffic.
///
///When traffic is to be sent to a destination that is within a given
/// `RouteDestination`, the corresponding [`RouterRoute`] applies, and
/// traffic will be forward to the [`RouteTarget`] for that rule.
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "A `RouteDestination` is used to match traffic with a
/// routing rule, on the destination of that traffic.\n\nWhen traffic is to
/// be sent to a destination that is within a given `RouteDestination`, the
/// corresponding [`RouterRoute`] applies, and traffic will be forward to
/// the [`RouteTarget`] for that rule.", "oneOf": [
/// {
/// "description": "Route applies to traffic destined for a specific IP
/// address", "type": "object",
/// "required": [
/// "type",
/// "value"
/// ],
/// "properties": {
/// "type": {
/// "type": "string",
/// "enum": [
/// "ip"
/// ]
/// },
/// "value": {
/// "type": "string",
/// "format": "ip"
/// }
/// }
/// },
/// {
/// "description": "Route applies to traffic destined for a specific IP
/// subnet", "type": "object",
/// "required": [
/// "type",
/// "value"
/// ],
/// "properties": {
/// "type": {
/// "type": "string",
/// "enum": [
/// "ip_net"
/// ]
/// },
/// "value": {
/// "$ref": "#/components/schemas/IpNet"
/// }
/// }
/// },
/// {
/// "description": "Route applies to traffic destined for the given
/// VPC.", "type": "object",
/// "required": [
/// "type",
/// "value"
/// ],
/// "properties": {
/// "type": {
/// "type": "string",
/// "enum": [
/// "vpc"
/// ]
/// },
/// "value": {
/// "$ref": "#/components/schemas/Name"
/// }
/// }
/// },
/// {
/// "description": "Route applies to traffic",
/// "type": "object",
/// "required": [
/// "type",
/// "value"
/// ],
/// "properties": {
/// "type": {
/// "type": "string",
/// "enum": [
/// "subnet"
/// ]
/// },
/// "value": {
/// "$ref": "#/components/schemas/Name"
/// }
/// }
/// }
/// ]
///}
/// ```
/// </details>
2022-07-12 17:57:06 +00:00
#[derive(Clone, Debug, Deserialize, Serialize)]
2021-12-10 02:15:24 +00:00
#[serde(tag = "type", content = "value")]
pub enum RouteDestination {
2022-07-03 02:09:38 +00:00
///Route applies to traffic destined for a specific IP address
2021-12-10 02:15:24 +00:00
#[serde(rename = "ip")]
2022-07-03 05:28:06 +00:00
Ip(std::net::IpAddr),
2022-07-03 02:09:38 +00:00
///Route applies to traffic destined for a specific IP subnet
2022-03-18 06:54:10 +00:00
#[serde(rename = "ip_net")]
IpNet(IpNet),
2022-07-03 02:09:38 +00:00
///Route applies to traffic destined for the given VPC.
2021-12-10 02:15:24 +00:00
#[serde(rename = "vpc")]
Vpc(Name),
2022-07-03 02:09:38 +00:00
///Route applies to traffic
2021-12-10 02:15:24 +00:00
#[serde(rename = "subnet")]
Subnet(Name),
}
2023-02-05 01:22:55 +00:00
impl From<&RouteDestination> for RouteDestination {
fn from(value: &RouteDestination) -> Self {
value.clone()
}
}
2023-03-17 22:39:46 +00:00
impl From<std::net::IpAddr> for RouteDestination {
fn from(value: std::net::IpAddr) -> Self {
Self::Ip(value)
}
}
impl From<IpNet> for RouteDestination {
fn from(value: IpNet) -> Self {
Self::IpNet(value)
}
}
2022-07-03 02:09:38 +00:00
///A `RouteTarget` describes the possible locations that traffic matching a
/// route destination can be sent.
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "A `RouteTarget` describes the possible locations that
/// traffic matching a route destination can be sent.", "oneOf": [
/// {
/// "description": "Forward traffic to a particular IP address.",
/// "type": "object",
/// "required": [
/// "type",
/// "value"
/// ],
/// "properties": {
/// "type": {
/// "type": "string",
/// "enum": [
/// "ip"
/// ]
/// },
/// "value": {
/// "type": "string",
/// "format": "ip"
/// }
/// }
/// },
/// {
/// "description": "Forward traffic to a VPC",
/// "type": "object",
/// "required": [
/// "type",
/// "value"
/// ],
/// "properties": {
/// "type": {
/// "type": "string",
/// "enum": [
/// "vpc"
/// ]
/// },
/// "value": {
/// "$ref": "#/components/schemas/Name"
/// }
/// }
/// },
/// {
/// "description": "Forward traffic to a VPC Subnet",
/// "type": "object",
/// "required": [
/// "type",
/// "value"
/// ],
/// "properties": {
/// "type": {
/// "type": "string",
/// "enum": [
/// "subnet"
/// ]
/// },
/// "value": {
/// "$ref": "#/components/schemas/Name"
/// }
/// }
/// },
/// {
/// "description": "Forward traffic to a specific instance",
/// "type": "object",
/// "required": [
/// "type",
/// "value"
/// ],
/// "properties": {
/// "type": {
/// "type": "string",
/// "enum": [
/// "instance"
/// ]
/// },
/// "value": {
/// "$ref": "#/components/schemas/Name"
/// }
/// }
/// },
/// {
/// "description": "Forward traffic to an internet gateway",
/// "type": "object",
/// "required": [
/// "type",
/// "value"
/// ],
/// "properties": {
/// "type": {
/// "type": "string",
/// "enum": [
/// "internet_gateway"
/// ]
/// },
/// "value": {
/// "$ref": "#/components/schemas/Name"
/// }
/// }
/// }
/// ]
///}
/// ```
/// </details>
2022-07-12 17:57:06 +00:00
#[derive(Clone, Debug, Deserialize, Serialize)]
2021-12-10 02:15:24 +00:00
#[serde(tag = "type", content = "value")]
pub enum RouteTarget {
2022-07-03 02:09:38 +00:00
///Forward traffic to a particular IP address.
2021-12-10 02:15:24 +00:00
#[serde(rename = "ip")]
2022-07-03 05:28:06 +00:00
Ip(std::net::IpAddr),
2022-07-03 02:09:38 +00:00
///Forward traffic to a VPC
2021-12-10 02:15:24 +00:00
#[serde(rename = "vpc")]
Vpc(Name),
2022-07-03 02:09:38 +00:00
///Forward traffic to a VPC Subnet
2021-12-10 02:15:24 +00:00
#[serde(rename = "subnet")]
Subnet(Name),
2022-07-03 02:09:38 +00:00
///Forward traffic to a specific instance
2021-12-10 02:15:24 +00:00
#[serde(rename = "instance")]
Instance(Name),
2022-07-03 02:09:38 +00:00
///Forward traffic to an internet gateway
2022-02-08 16:59:38 +00:00
#[serde(rename = "internet_gateway")]
2021-12-10 02:15:24 +00:00
InternetGateway(Name),
}
2023-02-05 01:22:55 +00:00
impl From<&RouteTarget> for RouteTarget {
fn from(value: &RouteTarget) -> Self {
value.clone()
}
}
2023-03-17 22:39:46 +00:00
impl From<std::net::IpAddr> for RouteTarget {
fn from(value: std::net::IpAddr) -> Self {
Self::Ip(value)
}
}
2022-07-03 02:09:38 +00:00
///A route defines a rule that governs where traffic should be sent based
/// on its destination.
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "A route defines a rule that governs where traffic
/// should be sent based on its destination.", "type": "object",
/// "required": [
/// "description",
/// "destination",
/// "id",
/// "kind",
/// "name",
/// "target",
/// "time_created",
/// "time_modified",
/// "vpc_router_id"
/// ],
/// "properties": {
/// "description": {
/// "description": "human-readable free-form text about a resource",
/// "type": "string"
/// },
/// "destination": {
/// "$ref": "#/components/schemas/RouteDestination"
/// },
/// "id": {
/// "description": "unique, immutable, system-controlled identifier for
/// each resource", "type": "string",
/// "format": "uuid"
/// },
/// "kind": {
/// "description": "Describes the kind of router. Set at creation.
/// `read-only`", "allOf": [
/// {
/// "$ref": "#/components/schemas/RouterRouteKind"
/// }
/// ]
/// },
/// "name": {
/// "description": "unique, mutable, user-controlled identifier for
/// each resource", "allOf": [
/// {
/// "$ref": "#/components/schemas/Name"
/// }
/// ]
/// },
/// "target": {
/// "$ref": "#/components/schemas/RouteTarget"
/// },
/// "time_created": {
/// "description": "timestamp when this resource was created",
/// "type": "string",
/// "format": "date-time"
/// },
/// "time_modified": {
/// "description": "timestamp when this resource was last modified",
/// "type": "string",
/// "format": "date-time"
/// },
/// "vpc_router_id": {
/// "description": "The VPC Router to which the route belongs.",
/// "type": "string",
/// "format": "uuid"
/// }
/// }
///}
/// ```
/// </details>
2022-07-12 17:57:06 +00:00
#[derive(Clone, Debug, Deserialize, Serialize)]
2021-12-10 02:15:24 +00:00
pub struct RouterRoute {
2022-07-03 02:09:38 +00:00
///human-readable free-form text about a resource
2022-02-08 16:59:38 +00:00
pub description: String,
2021-12-10 02:15:24 +00:00
pub destination: RouteDestination,
2022-07-03 02:09:38 +00:00
///unique, immutable, system-controlled identifier for each resource
2022-02-08 16:59:38 +00:00
pub id: uuid::Uuid,
2022-07-03 02:09:38 +00:00
///Describes the kind of router. Set at creation. `read-only`
2021-12-10 02:15:24 +00:00
pub kind: RouterRouteKind,
2022-07-03 02:09:38 +00:00
///unique, mutable, user-controlled identifier for each resource
2022-02-08 16:59:38 +00:00
pub name: Name,
2021-12-10 02:15:24 +00:00
pub target: RouteTarget,
2022-07-03 02:09:38 +00:00
///timestamp when this resource was created
2022-02-08 16:59:38 +00:00
pub time_created: chrono::DateTime<chrono::offset::Utc>,
2022-07-03 02:09:38 +00:00
///timestamp when this resource was last modified
2022-02-08 16:59:38 +00:00
pub time_modified: chrono::DateTime<chrono::offset::Utc>,
2022-07-03 02:09:38 +00:00
///The VPC Router to which the route belongs.
2022-05-23 15:49:37 +00:00
pub vpc_router_id: uuid::Uuid,
2021-12-10 02:15:24 +00:00
}
2023-02-05 01:22:55 +00:00
impl From<&RouterRoute> for RouterRoute {
fn from(value: &RouterRoute) -> Self {
value.clone()
}
}
2022-07-03 02:09:38 +00:00
///Create-time parameters for a [`RouterRoute`]
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "Create-time parameters for a [`RouterRoute`]",
/// "type": "object",
/// "required": [
/// "description",
/// "destination",
/// "name",
/// "target"
/// ],
/// "properties": {
/// "description": {
/// "type": "string"
/// },
/// "destination": {
/// "$ref": "#/components/schemas/RouteDestination"
/// },
/// "name": {
/// "$ref": "#/components/schemas/Name"
/// },
/// "target": {
/// "$ref": "#/components/schemas/RouteTarget"
/// }
/// }
///}
/// ```
/// </details>
2022-07-12 17:57:06 +00:00
#[derive(Clone, Debug, Deserialize, Serialize)]
2021-12-10 02:15:24 +00:00
pub struct RouterRouteCreateParams {
pub description: String,
pub destination: RouteDestination,
pub name: Name,
pub target: RouteTarget,
}
2023-02-05 01:22:55 +00:00
impl From<&RouterRouteCreateParams> for RouterRouteCreateParams {
fn from(value: &RouterRouteCreateParams) -> Self {
value.clone()
}
}
2022-07-03 02:09:38 +00:00
///The classification of a [`RouterRoute`] as defined by the system. The
/// kind determines certain attributes such as if the route is modifiable
/// and describes how or where the route was created.
///
///See [RFD-21](https://rfd.shared.oxide.computer/rfd/0021#concept-router) for more context
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "The classification of a [`RouterRoute`] as defined by the system. The kind determines certain attributes such as if the route is modifiable and describes how or where the route was created.\n\nSee [RFD-21](https://rfd.shared.oxide.computer/rfd/0021#concept-router) for more context",
/// "oneOf": [
/// {
/// "description": "Determines the default destination of traffic, such
/// as whether it goes to the internet or not.\n\n`Destination: An Internet
/// Gateway` `Modifiable: true`", "type": "string",
/// "enum": [
/// "default"
/// ]
/// },
/// {
/// "description": "Automatically added for each VPC Subnet in the
/// VPC\n\n`Destination: A VPC Subnet` `Modifiable: false`", "type"
/// : "string", "enum": [
/// "vpc_subnet"
/// ]
/// },
/// {
/// "description": "Automatically added when VPC peering is
/// established\n\n`Destination: A different VPC` `Modifiable: false`",
/// "type": "string",
/// "enum": [
/// "vpc_peering"
/// ]
/// },
/// {
/// "description": "Created by a user See
/// [`RouteTarget`]\n\n`Destination: User defined` `Modifiable: true`",
/// "type": "string",
/// "enum": [
/// "custom"
/// ]
/// }
/// ]
///}
/// ```
/// </details>
2022-07-12 17:57:06 +00:00
#[derive(Clone, Copy, Debug, Deserialize, Eq, Hash, Ord, PartialEq, PartialOrd, Serialize)]
2021-12-10 02:15:24 +00:00
pub enum RouterRouteKind {
2023-02-01 05:28:12 +00:00
///Determines the default destination of traffic, such as whether it
/// goes to the internet or not.
///
///`Destination: An Internet Gateway` `Modifiable: true`
2022-02-08 16:59:38 +00:00
#[serde(rename = "default")]
2021-12-10 02:15:24 +00:00
Default,
2023-02-01 05:28:12 +00:00
///Automatically added for each VPC Subnet in the VPC
///
///`Destination: A VPC Subnet` `Modifiable: false`
2022-02-08 16:59:38 +00:00
#[serde(rename = "vpc_subnet")]
2021-12-10 02:15:24 +00:00
VpcSubnet,
2023-02-01 05:28:12 +00:00
///Automatically added when VPC peering is established
///
///`Destination: A different VPC` `Modifiable: false`
2022-02-08 16:59:38 +00:00
#[serde(rename = "vpc_peering")]
2021-12-10 02:15:24 +00:00
VpcPeering,
2023-02-01 05:28:12 +00:00
///Created by a user See [`RouteTarget`]
///
///`Destination: User defined` `Modifiable: true`
2022-02-08 16:59:38 +00:00
#[serde(rename = "custom")]
2021-12-10 02:15:24 +00:00
Custom,
}
2023-02-05 01:22:55 +00:00
impl From<&RouterRouteKind> for RouterRouteKind {
fn from(value: &RouterRouteKind) -> Self {
value.clone()
}
}
2021-12-10 02:15:24 +00:00
impl ToString for RouterRouteKind {
fn to_string(&self) -> String {
2022-03-08 07:22:44 +00:00
match *self {
2022-07-12 17:57:06 +00:00
Self::Default => "default".to_string(),
Self::VpcSubnet => "vpc_subnet".to_string(),
Self::VpcPeering => "vpc_peering".to_string(),
Self::Custom => "custom".to_string(),
}
}
}
impl std::str::FromStr for RouterRouteKind {
type Err = &'static str;
2023-01-25 17:19:15 +00:00
fn from_str(value: &str) -> Result<Self, &'static str> {
2022-07-12 17:57:06 +00:00
match value {
"default" => Ok(Self::Default),
"vpc_subnet" => Ok(Self::VpcSubnet),
"vpc_peering" => Ok(Self::VpcPeering),
"custom" => Ok(Self::Custom),
_ => Err("invalid value"),
2021-12-10 02:15:24 +00:00
}
}
}
2023-01-25 17:19:15 +00:00
impl std::convert::TryFrom<&str> for RouterRouteKind {
type Error = &'static str;
fn try_from(value: &str) -> Result<Self, &'static str> {
value.parse()
}
}
impl std::convert::TryFrom<&String> for RouterRouteKind {
type Error = &'static str;
fn try_from(value: &String) -> Result<Self, &'static str> {
value.parse()
}
}
2023-01-30 20:17:51 +00:00
impl std::convert::TryFrom<String> for RouterRouteKind {
type Error = &'static str;
fn try_from(value: String) -> Result<Self, &'static str> {
value.parse()
}
}
2022-07-03 02:09:38 +00:00
///A single page of results
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "A single page of results",
/// "type": "object",
/// "required": [
/// "items"
/// ],
/// "properties": {
/// "items": {
/// "description": "list of items on this page of results",
/// "type": "array",
/// "items": {
/// "$ref": "#/components/schemas/RouterRoute"
/// }
/// },
/// "next_page": {
/// "description": "token used to fetch the next page of results (if
/// any)", "type": [
/// "string",
/// "null"
/// ]
/// }
/// }
///}
/// ```
/// </details>
2022-07-12 17:57:06 +00:00
#[derive(Clone, Debug, Deserialize, Serialize)]
2021-12-10 02:15:24 +00:00
pub struct RouterRouteResultsPage {
2022-07-03 02:09:38 +00:00
///list of items on this page of results
2021-12-10 02:15:24 +00:00
pub items: Vec<RouterRoute>,
2022-07-03 02:09:38 +00:00
///token used to fetch the next page of results (if any)
2021-12-10 02:15:24 +00:00
#[serde(default, skip_serializing_if = "Option::is_none")]
pub next_page: Option<String>,
}
2023-02-05 01:22:55 +00:00
impl From<&RouterRouteResultsPage> for RouterRouteResultsPage {
fn from(value: &RouterRouteResultsPage) -> Self {
value.clone()
}
}
2022-07-03 02:09:38 +00:00
///Updateable properties of a [`RouterRoute`]
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "Updateable properties of a [`RouterRoute`]",
/// "type": "object",
/// "required": [
/// "destination",
/// "target"
/// ],
/// "properties": {
/// "description": {
/// "type": [
/// "string",
/// "null"
/// ]
/// },
/// "destination": {
/// "$ref": "#/components/schemas/RouteDestination"
/// },
/// "name": {
/// "allOf": [
/// {
/// "$ref": "#/components/schemas/Name"
/// }
/// ]
/// },
/// "target": {
/// "$ref": "#/components/schemas/RouteTarget"
/// }
/// }
///}
/// ```
/// </details>
2022-07-12 17:57:06 +00:00
#[derive(Clone, Debug, Deserialize, Serialize)]
2021-12-10 02:15:24 +00:00
pub struct RouterRouteUpdateParams {
#[serde(default, skip_serializing_if = "Option::is_none")]
pub description: Option<String>,
pub destination: RouteDestination,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub name: Option<Name>,
pub target: RouteTarget,
}
2023-02-05 01:22:55 +00:00
impl From<&RouterRouteUpdateParams> for RouterRouteUpdateParams {
fn from(value: &RouterRouteUpdateParams) -> Self {
value.clone()
}
}
2023-12-13 09:14:28 +00:00
///Saga
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "type": "object",
/// "required": [
/// "id",
/// "state"
/// ],
/// "properties": {
/// "id": {
/// "type": "string",
/// "format": "uuid"
/// },
/// "state": {
/// "$ref": "#/components/schemas/SagaState"
/// }
/// }
///}
/// ```
/// </details>
2022-07-12 17:57:06 +00:00
#[derive(Clone, Debug, Deserialize, Serialize)]
2021-12-10 02:15:24 +00:00
pub struct Saga {
pub id: uuid::Uuid,
pub state: SagaState,
}
2023-02-05 01:22:55 +00:00
impl From<&Saga> for Saga {
fn from(value: &Saga) -> Self {
value.clone()
}
}
2023-12-13 09:14:28 +00:00
///SagaErrorInfo
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "oneOf": [
/// {
/// "type": "object",
/// "required": [
/// "error",
/// "source_error"
/// ],
/// "properties": {
/// "error": {
/// "type": "string",
/// "enum": [
/// "action_failed"
/// ]
/// },
/// "source_error": {}
/// }
/// },
/// {
/// "type": "object",
/// "required": [
/// "error",
/// "message"
/// ],
/// "properties": {
/// "error": {
/// "type": "string",
/// "enum": [
/// "deserialize_failed"
/// ]
/// },
/// "message": {
/// "type": "string"
/// }
/// }
/// },
/// {
/// "type": "object",
/// "required": [
/// "error"
/// ],
/// "properties": {
/// "error": {
/// "type": "string",
/// "enum": [
/// "injected_error"
/// ]
/// }
/// }
/// },
/// {
/// "type": "object",
/// "required": [
/// "error",
/// "message"
/// ],
/// "properties": {
/// "error": {
/// "type": "string",
/// "enum": [
/// "serialize_failed"
/// ]
/// },
/// "message": {
/// "type": "string"
/// }
/// }
/// },
/// {
/// "type": "object",
/// "required": [
/// "error",
/// "message"
/// ],
/// "properties": {
/// "error": {
/// "type": "string",
/// "enum": [
/// "subsaga_create_failed"
/// ]
/// },
/// "message": {
/// "type": "string"
/// }
/// }
/// }
/// ]
///}
/// ```
/// </details>
2022-07-12 17:57:06 +00:00
#[derive(Clone, Debug, Deserialize, Serialize)]
2021-12-10 02:15:24 +00:00
#[serde(tag = "error")]
pub enum SagaErrorInfo {
2022-02-08 16:59:38 +00:00
#[serde(rename = "action_failed")]
2021-12-10 02:15:24 +00:00
ActionFailed { source_error: serde_json::Value },
2022-02-08 16:59:38 +00:00
#[serde(rename = "deserialize_failed")]
2021-12-10 02:15:24 +00:00
DeserializeFailed { message: String },
2022-02-08 16:59:38 +00:00
#[serde(rename = "injected_error")]
2021-12-10 02:15:24 +00:00
InjectedError,
2022-02-08 16:59:38 +00:00
#[serde(rename = "serialize_failed")]
2021-12-10 02:15:24 +00:00
SerializeFailed { message: String },
2022-02-08 16:59:38 +00:00
#[serde(rename = "subsaga_create_failed")]
2021-12-10 02:15:24 +00:00
SubsagaCreateFailed { message: String },
}
2023-02-05 01:22:55 +00:00
impl From<&SagaErrorInfo> for SagaErrorInfo {
fn from(value: &SagaErrorInfo) -> Self {
value.clone()
}
}
2022-07-03 02:09:38 +00:00
///A single page of results
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "A single page of results",
/// "type": "object",
/// "required": [
/// "items"
/// ],
/// "properties": {
/// "items": {
/// "description": "list of items on this page of results",
/// "type": "array",
/// "items": {
/// "$ref": "#/components/schemas/Saga"
/// }
/// },
/// "next_page": {
/// "description": "token used to fetch the next page of results (if
/// any)", "type": [
/// "string",
/// "null"
/// ]
/// }
/// }
///}
/// ```
/// </details>
2022-07-12 17:57:06 +00:00
#[derive(Clone, Debug, Deserialize, Serialize)]
2021-12-10 02:15:24 +00:00
pub struct SagaResultsPage {
2022-07-03 02:09:38 +00:00
///list of items on this page of results
2021-12-10 02:15:24 +00:00
pub items: Vec<Saga>,
2022-07-03 02:09:38 +00:00
///token used to fetch the next page of results (if any)
2021-12-10 02:15:24 +00:00
#[serde(default, skip_serializing_if = "Option::is_none")]
pub next_page: Option<String>,
}
2023-02-05 01:22:55 +00:00
impl From<&SagaResultsPage> for SagaResultsPage {
fn from(value: &SagaResultsPage) -> Self {
value.clone()
}
}
2023-12-13 09:14:28 +00:00
///SagaState
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "oneOf": [
/// {
/// "type": "object",
/// "required": [
/// "state"
/// ],
/// "properties": {
/// "state": {
/// "type": "string",
/// "enum": [
/// "running"
/// ]
/// }
/// }
/// },
/// {
/// "type": "object",
/// "required": [
/// "state"
/// ],
/// "properties": {
/// "state": {
/// "type": "string",
/// "enum": [
/// "succeeded"
/// ]
/// }
/// }
/// },
/// {
/// "type": "object",
/// "required": [
/// "error_info",
/// "error_node_name",
/// "state"
/// ],
/// "properties": {
/// "error_info": {
/// "$ref": "#/components/schemas/SagaErrorInfo"
/// },
/// "error_node_name": {
/// "$ref": "#/components/schemas/NodeName"
/// },
/// "state": {
/// "type": "string",
/// "enum": [
/// "failed"
/// ]
/// }
/// }
/// }
/// ]
///}
/// ```
/// </details>
2022-07-12 17:57:06 +00:00
#[derive(Clone, Debug, Deserialize, Serialize)]
2021-12-10 02:15:24 +00:00
#[serde(tag = "state")]
pub enum SagaState {
#[serde(rename = "running")]
Running,
#[serde(rename = "succeeded")]
Succeeded,
#[serde(rename = "failed")]
Failed {
error_info: SagaErrorInfo,
2023-02-01 05:28:12 +00:00
error_node_name: NodeName,
2021-12-10 02:15:24 +00:00
},
}
2023-02-05 01:22:55 +00:00
impl From<&SagaState> for SagaState {
fn from(value: &SagaState) -> Self {
value.clone()
}
}
2022-07-08 01:35:36 +00:00
///Identity-related metadata that's included in nearly all public API
/// objects
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "Identity-related metadata that's included in nearly all
/// public API objects", "type": "object",
/// "required": [
/// "acs_url",
/// "description",
/// "id",
/// "idp_entity_id",
/// "name",
/// "slo_url",
/// "sp_client_id",
/// "technical_contact_email",
/// "time_created",
/// "time_modified"
/// ],
/// "properties": {
/// "acs_url": {
/// "description": "service provider endpoint where the response will
/// be sent", "type": "string"
/// },
/// "description": {
/// "description": "human-readable free-form text about a resource",
/// "type": "string"
/// },
/// "id": {
/// "description": "unique, immutable, system-controlled identifier for
/// each resource", "type": "string",
/// "format": "uuid"
/// },
/// "idp_entity_id": {
/// "description": "idp's entity id",
/// "type": "string"
/// },
/// "name": {
/// "description": "unique, mutable, user-controlled identifier for
/// each resource", "allOf": [
/// {
/// "$ref": "#/components/schemas/Name"
/// }
/// ]
/// },
/// "public_cert": {
/// "description": "optional request signing public certificate (base64
/// encoded der file)", "type": [
/// "string",
/// "null"
/// ]
/// },
/// "slo_url": {
/// "description": "service provider endpoint where the idp should send
/// log out requests", "type": "string"
/// },
/// "sp_client_id": {
/// "description": "sp's client id",
/// "type": "string"
/// },
/// "technical_contact_email": {
/// "description": "customer's technical contact for saml
/// configuration", "type": "string"
/// },
/// "time_created": {
/// "description": "timestamp when this resource was created",
/// "type": "string",
/// "format": "date-time"
/// },
/// "time_modified": {
/// "description": "timestamp when this resource was last modified",
/// "type": "string",
/// "format": "date-time"
/// }
/// }
///}
/// ```
/// </details>
2022-07-12 17:57:06 +00:00
#[derive(Clone, Debug, Deserialize, Serialize)]
2022-07-08 01:35:36 +00:00
pub struct SamlIdentityProvider {
///service provider endpoint where the response will be sent
pub acs_url: String,
///human-readable free-form text about a resource
pub description: String,
///unique, immutable, system-controlled identifier for each resource
pub id: uuid::Uuid,
///idp's entity id
pub idp_entity_id: String,
///unique, mutable, user-controlled identifier for each resource
pub name: Name,
///optional request signing public certificate (base64 encoded der
/// file)
#[serde(default, skip_serializing_if = "Option::is_none")]
pub public_cert: Option<String>,
///service provider endpoint where the idp should send log out requests
pub slo_url: String,
///sp's client id
pub sp_client_id: String,
///customer's technical contact for saml configuration
pub technical_contact_email: String,
///timestamp when this resource was created
pub time_created: chrono::DateTime<chrono::offset::Utc>,
///timestamp when this resource was last modified
pub time_modified: chrono::DateTime<chrono::offset::Utc>,
}
2023-02-05 01:22:55 +00:00
impl From<&SamlIdentityProvider> for SamlIdentityProvider {
fn from(value: &SamlIdentityProvider) -> Self {
value.clone()
}
}
2022-07-08 01:35:36 +00:00
///Create-time identity-related parameters
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "Create-time identity-related parameters",
/// "type": "object",
/// "required": [
/// "acs_url",
/// "description",
/// "idp_entity_id",
/// "idp_metadata_source",
/// "name",
/// "slo_url",
/// "sp_client_id",
/// "technical_contact_email"
/// ],
/// "properties": {
/// "acs_url": {
/// "description": "service provider endpoint where the response will
/// be sent", "type": "string"
/// },
/// "description": {
/// "type": "string"
/// },
/// "group_attribute_name": {
/// "description": "If set, SAML attributes with this name will be
/// considered to denote a user's group membership, where the attribute
/// value(s) should be a comma-separated list of group names.",
/// "type": [
/// "string",
/// "null"
/// ]
/// },
/// "idp_entity_id": {
/// "description": "idp's entity id",
/// "type": "string"
/// },
/// "idp_metadata_source": {
/// "description": "the source of an identity provider metadata
/// descriptor", "allOf": [
/// {
/// "$ref": "#/components/schemas/IdpMetadataSource"
/// }
/// ]
/// },
/// "name": {
/// "$ref": "#/components/schemas/Name"
/// },
/// "signing_keypair": {
/// "description": "optional request signing key pair",
/// "allOf": [
/// {
/// "$ref": "#/components/schemas/DerEncodedKeyPair"
/// }
/// ]
/// },
/// "slo_url": {
/// "description": "service provider endpoint where the idp should send
/// log out requests", "type": "string"
/// },
/// "sp_client_id": {
/// "description": "sp's client id",
/// "type": "string"
/// },
/// "technical_contact_email": {
/// "description": "customer's technical contact for saml
/// configuration", "type": "string"
/// }
/// }
///}
/// ```
/// </details>
2022-07-12 17:57:06 +00:00
#[derive(Clone, Debug, Deserialize, Serialize)]
2022-07-08 01:35:36 +00:00
pub struct SamlIdentityProviderCreate {
///service provider endpoint where the response will be sent
pub acs_url: String,
pub description: String,
2023-02-01 05:28:12 +00:00
///If set, SAML attributes with this name will be considered to denote
/// a user's group membership, where the attribute value(s) should be a
/// comma-separated list of group names.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub group_attribute_name: Option<String>,
2022-07-08 01:35:36 +00:00
///idp's entity id
pub idp_entity_id: String,
///the source of an identity provider metadata descriptor
pub idp_metadata_source: IdpMetadataSource,
pub name: Name,
///optional request signing key pair
#[serde(default, skip_serializing_if = "Option::is_none")]
pub signing_keypair: Option<DerEncodedKeyPair>,
///service provider endpoint where the idp should send log out requests
pub slo_url: String,
///sp's client id
pub sp_client_id: String,
///customer's technical contact for saml configuration
pub technical_contact_email: String,
}
2023-02-05 01:22:55 +00:00
impl From<&SamlIdentityProviderCreate> for SamlIdentityProviderCreate {
fn from(value: &SamlIdentityProviderCreate) -> Self {
value.clone()
}
}
2023-12-13 09:14:28 +00:00
///SemverVersion
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "type": "string",
/// "pattern": "^\\d+\\.\\d+\\.\\d+([\\-\\+].+)?$"
///}
/// ```
/// </details>
2023-05-02 20:55:50 +00:00
#[derive(Clone, Debug, Eq, Hash, Ord, PartialEq, PartialOrd, Serialize)]
2023-02-01 05:28:12 +00:00
pub struct SemverVersion(String);
impl std::ops::Deref for SemverVersion {
type Target = String;
fn deref(&self) -> &String {
&self.0
}
2022-05-23 15:49:37 +00:00
}
2023-02-05 01:22:55 +00:00
impl From<SemverVersion> for String {
fn from(value: SemverVersion) -> Self {
value.0
}
}
impl From<&SemverVersion> for SemverVersion {
fn from(value: &SemverVersion) -> Self {
value.clone()
}
}
2023-02-01 05:28:12 +00:00
impl std::str::FromStr for SemverVersion {
type Err = &'static str;
fn from_str(value: &str) -> Result<Self, &'static str> {
if regress::Regex::new("^\\d+\\.\\d+\\.\\d+([\\-\\+].+)?$")
.unwrap()
.find(value)
.is_none()
{
return Err("doesn't match pattern \"^\\d+\\.\\d+\\.\\d+([\\-\\+].+)?$\"");
}
Ok(Self(value.to_string()))
}
}
impl std::convert::TryFrom<&str> for SemverVersion {
type Error = &'static str;
fn try_from(value: &str) -> Result<Self, &'static str> {
value.parse()
}
}
impl std::convert::TryFrom<&String> for SemverVersion {
type Error = &'static str;
fn try_from(value: &String) -> Result<Self, &'static str> {
value.parse()
}
}
impl std::convert::TryFrom<String> for SemverVersion {
type Error = &'static str;
fn try_from(value: String) -> Result<Self, &'static str> {
value.parse()
}
}
impl<'de> serde::Deserialize<'de> for SemverVersion {
fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where
D: serde::Deserializer<'de>,
{
String::deserialize(deserializer)?
.parse()
.map_err(|e: &'static str| <D::Error as serde::de::Error>::custom(e.to_string()))
}
}
///The service intended to use this certificate.
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "The service intended to use this certificate.",
/// "oneOf": [
/// {
/// "description": "This certificate is intended for access to the
/// external API.", "type": "string",
/// "enum": [
/// "external_api"
/// ]
/// }
/// ]
///}
/// ```
/// </details>
2023-02-01 05:28:12 +00:00
#[derive(Clone, Copy, Debug, Deserialize, Eq, Hash, Ord, PartialEq, PartialOrd, Serialize)]
pub enum ServiceUsingCertificate {
///This certificate is intended for access to the external API.
#[serde(rename = "external_api")]
ExternalApi,
}
2023-02-05 01:22:55 +00:00
impl From<&ServiceUsingCertificate> for ServiceUsingCertificate {
fn from(value: &ServiceUsingCertificate) -> Self {
value.clone()
}
}
2023-02-01 05:28:12 +00:00
impl ToString for ServiceUsingCertificate {
fn to_string(&self) -> String {
match *self {
Self::ExternalApi => "external_api".to_string(),
}
}
}
impl std::str::FromStr for ServiceUsingCertificate {
type Err = &'static str;
fn from_str(value: &str) -> Result<Self, &'static str> {
match value {
"external_api" => Ok(Self::ExternalApi),
_ => Err("invalid value"),
}
}
}
impl std::convert::TryFrom<&str> for ServiceUsingCertificate {
type Error = &'static str;
fn try_from(value: &str) -> Result<Self, &'static str> {
value.parse()
}
}
impl std::convert::TryFrom<&String> for ServiceUsingCertificate {
type Error = &'static str;
fn try_from(value: &String) -> Result<Self, &'static str> {
value.parse()
}
}
impl std::convert::TryFrom<String> for ServiceUsingCertificate {
type Error = &'static str;
fn try_from(value: String) -> Result<Self, &'static str> {
value.parse()
}
}
///Client view of a ['Silo']
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "Client view of a ['Silo']",
/// "type": "object",
/// "required": [
/// "description",
/// "discoverable",
/// "id",
/// "identity_mode",
/// "name",
/// "time_created",
/// "time_modified"
/// ],
/// "properties": {
/// "description": {
/// "description": "human-readable free-form text about a resource",
/// "type": "string"
/// },
/// "discoverable": {
/// "description": "A silo where discoverable is false can be retrieved only by its id - it will not be part of the \"list all silos\" output.",
/// "type": "boolean"
/// },
/// "id": {
/// "description": "unique, immutable, system-controlled identifier for
/// each resource", "type": "string",
/// "format": "uuid"
/// },
/// "identity_mode": {
/// "description": "How users and groups are managed in this Silo",
/// "allOf": [
/// {
/// "$ref": "#/components/schemas/SiloIdentityMode"
/// }
/// ]
/// },
/// "name": {
/// "description": "unique, mutable, user-controlled identifier for
/// each resource", "allOf": [
/// {
/// "$ref": "#/components/schemas/Name"
/// }
/// ]
/// },
/// "time_created": {
/// "description": "timestamp when this resource was created",
/// "type": "string",
/// "format": "date-time"
/// },
/// "time_modified": {
/// "description": "timestamp when this resource was last modified",
/// "type": "string",
/// "format": "date-time"
/// }
/// }
///}
/// ```
/// </details>
2023-02-01 05:28:12 +00:00
#[derive(Clone, Debug, Deserialize, Serialize)]
pub struct Silo {
///human-readable free-form text about a resource
pub description: String,
///A silo where discoverable is false can be retrieved only by its id -
/// it will not be part of the "list all silos" output.
pub discoverable: bool,
///unique, immutable, system-controlled identifier for each resource
pub id: uuid::Uuid,
///How users and groups are managed in this Silo
pub identity_mode: SiloIdentityMode,
///unique, mutable, user-controlled identifier for each resource
pub name: Name,
///timestamp when this resource was created
pub time_created: chrono::DateTime<chrono::offset::Utc>,
///timestamp when this resource was last modified
pub time_modified: chrono::DateTime<chrono::offset::Utc>,
}
2023-02-05 01:22:55 +00:00
impl From<&Silo> for Silo {
fn from(value: &Silo) -> Self {
value.clone()
}
}
2023-02-01 05:28:12 +00:00
///Create-time parameters for a [`Silo`](crate::external_api::views::Silo)
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "Create-time parameters for a
/// [`Silo`](crate::external_api::views::Silo)", "type": "object",
/// "required": [
/// "description",
/// "discoverable",
/// "identity_mode",
/// "name"
/// ],
/// "properties": {
/// "admin_group_name": {
/// "description": "If set, this group will be created during Silo
/// creation and granted the \"Silo Admin\" role. Identity providers can
/// assert that users belong to this group and those users can log in and
/// further initialize the Silo.\n\nNote that if configuring a SAML based
/// identity provider, group_attribute_name must be set for users to be
/// considered part of a group. See [`SamlIdentityProviderCreate`] for more
/// information.", "type": [
/// "string",
/// "null"
/// ]
/// },
/// "description": {
/// "type": "string"
/// },
/// "discoverable": {
/// "type": "boolean"
/// },
/// "identity_mode": {
/// "$ref": "#/components/schemas/SiloIdentityMode"
/// },
/// "name": {
/// "$ref": "#/components/schemas/Name"
/// }
/// }
///}
/// ```
/// </details>
2023-02-01 05:28:12 +00:00
#[derive(Clone, Debug, Deserialize, Serialize)]
pub struct SiloCreate {
///If set, this group will be created during Silo creation and granted
/// the "Silo Admin" role. Identity providers can assert that users
/// belong to this group and those users can log in and further
/// initialize the Silo.
///
///Note that if configuring a SAML based identity provider,
/// group_attribute_name must be set for users to be considered part of
/// a group. See [`SamlIdentityProviderCreate`] for more information.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub admin_group_name: Option<String>,
pub description: String,
pub discoverable: bool,
pub identity_mode: SiloIdentityMode,
pub name: Name,
}
2023-02-05 01:22:55 +00:00
impl From<&SiloCreate> for SiloCreate {
fn from(value: &SiloCreate) -> Self {
value.clone()
}
}
2023-02-01 05:28:12 +00:00
///Describes how identities are managed and users are authenticated in this
/// Silo
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "Describes how identities are managed and users are
/// authenticated in this Silo", "oneOf": [
/// {
/// "description": "Users are authenticated with SAML using an external
/// authentication provider. The system updates information about users and
/// groups only during successful authentication (i.e,. \"JIT provisioning\"
/// of users and groups).", "type": "string",
/// "enum": [
/// "saml_jit"
/// ]
/// },
/// {
/// "description": "The system is the source of truth about users.
/// There is no linkage to an external authentication provider or identity
/// provider.", "type": "string",
/// "enum": [
/// "local_only"
/// ]
/// }
/// ]
///}
/// ```
/// </details>
2023-02-01 05:28:12 +00:00
#[derive(Clone, Copy, Debug, Deserialize, Eq, Hash, Ord, PartialEq, PartialOrd, Serialize)]
pub enum SiloIdentityMode {
///Users are authenticated with SAML using an external authentication
/// provider. The system updates information about users and groups
/// only during successful authentication (i.e,. "JIT provisioning" of
/// users and groups).
#[serde(rename = "saml_jit")]
SamlJit,
///The system is the source of truth about users. There is no linkage
/// to an external authentication provider or identity provider.
#[serde(rename = "local_only")]
LocalOnly,
}
2023-02-05 01:22:55 +00:00
impl From<&SiloIdentityMode> for SiloIdentityMode {
fn from(value: &SiloIdentityMode) -> Self {
value.clone()
}
}
2023-02-01 05:28:12 +00:00
impl ToString for SiloIdentityMode {
fn to_string(&self) -> String {
match *self {
Self::SamlJit => "saml_jit".to_string(),
Self::LocalOnly => "local_only".to_string(),
}
}
}
impl std::str::FromStr for SiloIdentityMode {
type Err = &'static str;
fn from_str(value: &str) -> Result<Self, &'static str> {
match value {
"saml_jit" => Ok(Self::SamlJit),
"local_only" => Ok(Self::LocalOnly),
_ => Err("invalid value"),
}
}
}
impl std::convert::TryFrom<&str> for SiloIdentityMode {
type Error = &'static str;
fn try_from(value: &str) -> Result<Self, &'static str> {
value.parse()
}
}
impl std::convert::TryFrom<&String> for SiloIdentityMode {
type Error = &'static str;
fn try_from(value: &String) -> Result<Self, &'static str> {
value.parse()
}
}
impl std::convert::TryFrom<String> for SiloIdentityMode {
type Error = &'static str;
fn try_from(value: String) -> Result<Self, &'static str> {
value.parse()
}
}
///A single page of results
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "A single page of results",
/// "type": "object",
/// "required": [
/// "items"
/// ],
/// "properties": {
/// "items": {
/// "description": "list of items on this page of results",
/// "type": "array",
/// "items": {
/// "$ref": "#/components/schemas/Silo"
/// }
/// },
/// "next_page": {
/// "description": "token used to fetch the next page of results (if
/// any)", "type": [
/// "string",
/// "null"
/// ]
/// }
/// }
///}
/// ```
/// </details>
2022-07-12 17:57:06 +00:00
#[derive(Clone, Debug, Deserialize, Serialize)]
2022-05-23 15:49:37 +00:00
pub struct SiloResultsPage {
2022-07-03 02:09:38 +00:00
///list of items on this page of results
2022-05-23 15:49:37 +00:00
pub items: Vec<Silo>,
2022-07-03 02:09:38 +00:00
///token used to fetch the next page of results (if any)
2022-05-23 15:49:37 +00:00
#[serde(default, skip_serializing_if = "Option::is_none")]
pub next_page: Option<String>,
}
2023-02-05 01:22:55 +00:00
impl From<&SiloResultsPage> for SiloResultsPage {
fn from(value: &SiloResultsPage) -> Self {
value.clone()
}
}
2023-12-13 09:14:28 +00:00
///SiloRole
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "type": "string",
/// "enum": [
/// "admin",
/// "collaborator",
/// "viewer"
/// ]
///}
/// ```
/// </details>
2022-07-12 17:57:06 +00:00
#[derive(Clone, Copy, Debug, Deserialize, Eq, Hash, Ord, PartialEq, PartialOrd, Serialize)]
2022-07-08 01:35:36 +00:00
pub enum SiloRole {
2022-05-23 15:49:37 +00:00
#[serde(rename = "admin")]
Admin,
#[serde(rename = "collaborator")]
Collaborator,
#[serde(rename = "viewer")]
Viewer,
}
2023-02-05 01:22:55 +00:00
impl From<&SiloRole> for SiloRole {
fn from(value: &SiloRole) -> Self {
value.clone()
}
}
2022-07-08 01:35:36 +00:00
impl ToString for SiloRole {
2022-05-23 15:49:37 +00:00
fn to_string(&self) -> String {
match *self {
2022-07-12 17:57:06 +00:00
Self::Admin => "admin".to_string(),
Self::Collaborator => "collaborator".to_string(),
Self::Viewer => "viewer".to_string(),
}
}
}
impl std::str::FromStr for SiloRole {
type Err = &'static str;
2023-01-25 17:19:15 +00:00
fn from_str(value: &str) -> Result<Self, &'static str> {
2022-07-12 17:57:06 +00:00
match value {
"admin" => Ok(Self::Admin),
"collaborator" => Ok(Self::Collaborator),
"viewer" => Ok(Self::Viewer),
_ => Err("invalid value"),
2022-05-23 15:49:37 +00:00
}
}
}
2023-01-25 17:19:15 +00:00
impl std::convert::TryFrom<&str> for SiloRole {
type Error = &'static str;
fn try_from(value: &str) -> Result<Self, &'static str> {
value.parse()
}
}
impl std::convert::TryFrom<&String> for SiloRole {
type Error = &'static str;
fn try_from(value: &String) -> Result<Self, &'static str> {
value.parse()
}
}
2023-01-30 20:17:51 +00:00
impl std::convert::TryFrom<String> for SiloRole {
type Error = &'static str;
fn try_from(value: String) -> Result<Self, &'static str> {
value.parse()
}
}
2022-07-03 02:09:38 +00:00
///Client view of a [`Policy`], which describes how this resource may be
/// accessed
///
///Note that the Policy only describes access granted explicitly for this
/// resource. The policies of parent resources can also cause a user to
/// have access to this resource.
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "Client view of a [`Policy`], which describes how this
/// resource may be accessed\n\nNote that the Policy only describes access
/// granted explicitly for this resource. The policies of parent resources
/// can also cause a user to have access to this resource.",
/// "type": "object",
/// "required": [
/// "role_assignments"
/// ],
/// "properties": {
/// "role_assignments": {
/// "description": "Roles directly assigned on this resource",
/// "type": "array",
/// "items": {
/// "$ref": "#/components/schemas/SiloRoleRoleAssignment"
/// }
/// }
/// }
///}
/// ```
/// </details>
2022-07-12 17:57:06 +00:00
#[derive(Clone, Debug, Deserialize, Serialize)]
2022-07-08 01:35:36 +00:00
pub struct SiloRolePolicy {
2022-07-03 02:09:38 +00:00
///Roles directly assigned on this resource
2022-07-08 01:35:36 +00:00
pub role_assignments: Vec<SiloRoleRoleAssignment>,
2022-05-23 15:49:37 +00:00
}
2023-02-05 01:22:55 +00:00
impl From<&SiloRolePolicy> for SiloRolePolicy {
fn from(value: &SiloRolePolicy) -> Self {
value.clone()
}
}
2022-07-03 02:09:38 +00:00
///Describes the assignment of a particular role on a particular resource
/// to a particular identity (user, group, etc.)
///
///The resource is not part of this structure. Rather, [`RoleAssignment`]s
/// are put into a [`Policy`] and that Policy is applied to a particular
/// resource.
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "Describes the assignment of a particular role on a
/// particular resource to a particular identity (user, group, etc.)\n\nThe
/// resource is not part of this structure. Rather, [`RoleAssignment`]s are
/// put into a [`Policy`] and that Policy is applied to a particular
/// resource.", "type": "object",
/// "required": [
/// "identity_id",
/// "identity_type",
/// "role_name"
/// ],
/// "properties": {
/// "identity_id": {
/// "type": "string",
/// "format": "uuid"
/// },
/// "identity_type": {
/// "$ref": "#/components/schemas/IdentityType"
/// },
/// "role_name": {
/// "$ref": "#/components/schemas/SiloRole"
/// }
/// }
///}
/// ```
/// </details>
2022-07-12 17:57:06 +00:00
#[derive(Clone, Debug, Deserialize, Serialize)]
2022-07-08 01:35:36 +00:00
pub struct SiloRoleRoleAssignment {
2022-05-23 15:49:37 +00:00
pub identity_id: uuid::Uuid,
pub identity_type: IdentityType,
2022-07-08 01:35:36 +00:00
pub role_name: SiloRole,
2022-05-23 15:49:37 +00:00
}
2023-02-05 01:22:55 +00:00
impl From<&SiloRoleRoleAssignment> for SiloRoleRoleAssignment {
fn from(value: &SiloRoleRoleAssignment) -> Self {
value.clone()
}
}
2023-02-01 05:28:12 +00:00
///Client view of a [`Sled`]
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "Client view of a [`Sled`]",
/// "type": "object",
/// "required": [
/// "baseboard",
/// "id",
/// "service_address",
/// "time_created",
/// "time_modified"
/// ],
/// "properties": {
/// "baseboard": {
/// "$ref": "#/components/schemas/Baseboard"
/// },
/// "id": {
/// "description": "unique, immutable, system-controlled identifier for
/// each resource", "type": "string",
/// "format": "uuid"
/// },
/// "service_address": {
/// "type": "string"
/// },
/// "time_created": {
/// "description": "timestamp when this resource was created",
/// "type": "string",
/// "format": "date-time"
/// },
/// "time_modified": {
/// "description": "timestamp when this resource was last modified",
/// "type": "string",
/// "format": "date-time"
/// }
/// }
///}
/// ```
/// </details>
2022-07-12 17:57:06 +00:00
#[derive(Clone, Debug, Deserialize, Serialize)]
2021-12-10 02:15:24 +00:00
pub struct Sled {
2023-02-01 05:28:12 +00:00
pub baseboard: Baseboard,
2022-07-03 02:09:38 +00:00
///unique, immutable, system-controlled identifier for each resource
2021-12-10 02:15:24 +00:00
pub id: uuid::Uuid,
pub service_address: String,
2022-07-03 02:09:38 +00:00
///timestamp when this resource was created
2021-12-10 02:15:24 +00:00
pub time_created: chrono::DateTime<chrono::offset::Utc>,
2022-07-03 02:09:38 +00:00
///timestamp when this resource was last modified
2021-12-10 02:15:24 +00:00
pub time_modified: chrono::DateTime<chrono::offset::Utc>,
}
2023-02-05 01:22:55 +00:00
impl From<&Sled> for Sled {
fn from(value: &Sled) -> Self {
value.clone()
}
}
2022-07-03 02:09:38 +00:00
///A single page of results
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "A single page of results",
/// "type": "object",
/// "required": [
/// "items"
/// ],
/// "properties": {
/// "items": {
/// "description": "list of items on this page of results",
/// "type": "array",
/// "items": {
/// "$ref": "#/components/schemas/Sled"
/// }
/// },
/// "next_page": {
/// "description": "token used to fetch the next page of results (if
/// any)", "type": [
/// "string",
/// "null"
/// ]
/// }
/// }
///}
/// ```
/// </details>
2022-07-12 17:57:06 +00:00
#[derive(Clone, Debug, Deserialize, Serialize)]
2021-12-10 02:15:24 +00:00
pub struct SledResultsPage {
2022-07-03 02:09:38 +00:00
///list of items on this page of results
2021-12-10 02:15:24 +00:00
pub items: Vec<Sled>,
2022-07-03 02:09:38 +00:00
///token used to fetch the next page of results (if any)
2021-12-10 02:15:24 +00:00
#[serde(default, skip_serializing_if = "Option::is_none")]
pub next_page: Option<String>,
}
2023-02-05 01:22:55 +00:00
impl From<&SledResultsPage> for SledResultsPage {
fn from(value: &SledResultsPage) -> Self {
value.clone()
}
}
2022-07-03 02:09:38 +00:00
///Client view of a Snapshot
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "Client view of a Snapshot",
/// "type": "object",
/// "required": [
/// "description",
/// "disk_id",
/// "id",
/// "name",
/// "project_id",
/// "size",
/// "state",
/// "time_created",
/// "time_modified"
/// ],
/// "properties": {
/// "description": {
/// "description": "human-readable free-form text about a resource",
/// "type": "string"
/// },
/// "disk_id": {
/// "type": "string",
/// "format": "uuid"
/// },
/// "id": {
/// "description": "unique, immutable, system-controlled identifier for
/// each resource", "type": "string",
/// "format": "uuid"
/// },
/// "name": {
/// "description": "unique, mutable, user-controlled identifier for
/// each resource", "allOf": [
/// {
/// "$ref": "#/components/schemas/Name"
/// }
/// ]
/// },
/// "project_id": {
/// "type": "string",
/// "format": "uuid"
/// },
/// "size": {
/// "$ref": "#/components/schemas/ByteCount"
/// },
/// "state": {
/// "$ref": "#/components/schemas/SnapshotState"
/// },
/// "time_created": {
/// "description": "timestamp when this resource was created",
/// "type": "string",
/// "format": "date-time"
/// },
/// "time_modified": {
/// "description": "timestamp when this resource was last modified",
/// "type": "string",
/// "format": "date-time"
/// }
/// }
///}
/// ```
/// </details>
2022-07-12 17:57:06 +00:00
#[derive(Clone, Debug, Deserialize, Serialize)]
2022-03-18 06:54:10 +00:00
pub struct Snapshot {
2022-07-03 02:09:38 +00:00
///human-readable free-form text about a resource
2022-03-18 06:54:10 +00:00
pub description: String,
pub disk_id: uuid::Uuid,
2022-07-03 02:09:38 +00:00
///unique, immutable, system-controlled identifier for each resource
2022-03-18 06:54:10 +00:00
pub id: uuid::Uuid,
2022-07-03 02:09:38 +00:00
///unique, mutable, user-controlled identifier for each resource
2022-03-18 06:54:10 +00:00
pub name: Name,
pub project_id: uuid::Uuid,
pub size: ByteCount,
2023-02-01 05:28:12 +00:00
pub state: SnapshotState,
2022-07-03 02:09:38 +00:00
///timestamp when this resource was created
2022-03-18 06:54:10 +00:00
pub time_created: chrono::DateTime<chrono::offset::Utc>,
2022-07-03 02:09:38 +00:00
///timestamp when this resource was last modified
2022-03-18 06:54:10 +00:00
pub time_modified: chrono::DateTime<chrono::offset::Utc>,
}
2023-02-05 01:22:55 +00:00
impl From<&Snapshot> for Snapshot {
fn from(value: &Snapshot) -> Self {
value.clone()
}
}
2022-07-03 02:09:38 +00:00
///Create-time parameters for a
2023-02-01 05:28:12 +00:00
/// [`Snapshot`](crate::external_api::views::Snapshot)
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "Create-time parameters for a
/// [`Snapshot`](crate::external_api::views::Snapshot)",
/// "type": "object",
/// "required": [
/// "description",
/// "disk",
/// "name"
/// ],
/// "properties": {
/// "description": {
/// "type": "string"
/// },
/// "disk": {
/// "description": "The name of the disk to be snapshotted",
/// "allOf": [
/// {
/// "$ref": "#/components/schemas/Name"
/// }
/// ]
/// },
/// "name": {
/// "$ref": "#/components/schemas/Name"
/// }
/// }
///}
/// ```
/// </details>
2022-07-12 17:57:06 +00:00
#[derive(Clone, Debug, Deserialize, Serialize)]
2022-03-18 06:54:10 +00:00
pub struct SnapshotCreate {
pub description: String,
2022-07-03 02:09:38 +00:00
///The name of the disk to be snapshotted
2022-03-18 06:54:10 +00:00
pub disk: Name,
pub name: Name,
}
2023-02-05 01:22:55 +00:00
impl From<&SnapshotCreate> for SnapshotCreate {
fn from(value: &SnapshotCreate) -> Self {
value.clone()
}
}
2022-07-03 02:09:38 +00:00
///A single page of results
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "A single page of results",
/// "type": "object",
/// "required": [
/// "items"
/// ],
/// "properties": {
/// "items": {
/// "description": "list of items on this page of results",
/// "type": "array",
/// "items": {
/// "$ref": "#/components/schemas/Snapshot"
/// }
/// },
/// "next_page": {
/// "description": "token used to fetch the next page of results (if
/// any)", "type": [
/// "string",
/// "null"
/// ]
/// }
/// }
///}
/// ```
/// </details>
2022-07-12 17:57:06 +00:00
#[derive(Clone, Debug, Deserialize, Serialize)]
2022-03-18 06:54:10 +00:00
pub struct SnapshotResultsPage {
2022-07-03 02:09:38 +00:00
///list of items on this page of results
2022-03-18 06:54:10 +00:00
pub items: Vec<Snapshot>,
2022-07-03 02:09:38 +00:00
///token used to fetch the next page of results (if any)
2022-03-18 06:54:10 +00:00
#[serde(default, skip_serializing_if = "Option::is_none")]
pub next_page: Option<String>,
}
2023-02-05 01:22:55 +00:00
impl From<&SnapshotResultsPage> for SnapshotResultsPage {
fn from(value: &SnapshotResultsPage) -> Self {
value.clone()
}
}
2023-12-13 09:14:28 +00:00
///SnapshotState
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "type": "string",
/// "enum": [
/// "creating",
/// "ready",
/// "faulted",
/// "destroyed"
/// ]
///}
/// ```
/// </details>
2023-02-01 05:28:12 +00:00
#[derive(Clone, Copy, Debug, Deserialize, Eq, Hash, Ord, PartialEq, PartialOrd, Serialize)]
pub enum SnapshotState {
#[serde(rename = "creating")]
Creating,
#[serde(rename = "ready")]
Ready,
#[serde(rename = "faulted")]
Faulted,
#[serde(rename = "destroyed")]
Destroyed,
}
2023-02-05 01:22:55 +00:00
impl From<&SnapshotState> for SnapshotState {
fn from(value: &SnapshotState) -> Self {
value.clone()
}
}
2023-02-01 05:28:12 +00:00
impl ToString for SnapshotState {
fn to_string(&self) -> String {
match *self {
Self::Creating => "creating".to_string(),
Self::Ready => "ready".to_string(),
Self::Faulted => "faulted".to_string(),
Self::Destroyed => "destroyed".to_string(),
}
}
}
impl std::str::FromStr for SnapshotState {
type Err = &'static str;
fn from_str(value: &str) -> Result<Self, &'static str> {
match value {
"creating" => Ok(Self::Creating),
"ready" => Ok(Self::Ready),
"faulted" => Ok(Self::Faulted),
"destroyed" => Ok(Self::Destroyed),
_ => Err("invalid value"),
}
}
}
impl std::convert::TryFrom<&str> for SnapshotState {
type Error = &'static str;
fn try_from(value: &str) -> Result<Self, &'static str> {
value.parse()
}
}
impl std::convert::TryFrom<&String> for SnapshotState {
type Error = &'static str;
fn try_from(value: &String) -> Result<Self, &'static str> {
value.parse()
}
}
impl std::convert::TryFrom<String> for SnapshotState {
type Error = &'static str;
fn try_from(value: String) -> Result<Self, &'static str> {
value.parse()
}
}
2023-12-13 09:14:28 +00:00
///SpoofLoginBody
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "type": "object",
/// "required": [
/// "username"
/// ],
/// "properties": {
/// "username": {
/// "type": "string"
/// }
/// }
///}
/// ```
/// </details>
2022-07-12 17:57:06 +00:00
#[derive(Clone, Debug, Deserialize, Serialize)]
2022-07-08 01:35:36 +00:00
pub struct SpoofLoginBody {
pub username: String,
}
2023-02-05 01:22:55 +00:00
impl From<&SpoofLoginBody> for SpoofLoginBody {
fn from(value: &SpoofLoginBody) -> Self {
value.clone()
}
}
2022-07-03 02:09:38 +00:00
///Client view of a [`SshKey`]
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "Client view of a [`SshKey`]",
/// "type": "object",
/// "required": [
/// "description",
/// "id",
/// "name",
/// "public_key",
/// "silo_user_id",
/// "time_created",
/// "time_modified"
/// ],
/// "properties": {
/// "description": {
/// "description": "human-readable free-form text about a resource",
/// "type": "string"
/// },
/// "id": {
/// "description": "unique, immutable, system-controlled identifier for
/// each resource", "type": "string",
/// "format": "uuid"
/// },
/// "name": {
/// "description": "unique, mutable, user-controlled identifier for
/// each resource", "allOf": [
/// {
/// "$ref": "#/components/schemas/Name"
/// }
/// ]
/// },
/// "public_key": {
/// "description": "SSH public key, e.g., `\"ssh-ed25519
/// AAAAC3NzaC...\"`", "type": "string"
/// },
/// "silo_user_id": {
/// "description": "The user to whom this key belongs",
/// "type": "string",
/// "format": "uuid"
/// },
/// "time_created": {
/// "description": "timestamp when this resource was created",
/// "type": "string",
/// "format": "date-time"
/// },
/// "time_modified": {
/// "description": "timestamp when this resource was last modified",
/// "type": "string",
/// "format": "date-time"
/// }
/// }
///}
/// ```
/// </details>
2022-07-12 17:57:06 +00:00
#[derive(Clone, Debug, Deserialize, Serialize)]
2022-05-23 15:49:37 +00:00
pub struct SshKey {
2022-07-03 02:09:38 +00:00
///human-readable free-form text about a resource
2022-05-23 15:49:37 +00:00
pub description: String,
2022-07-03 02:09:38 +00:00
///unique, immutable, system-controlled identifier for each resource
2022-05-23 15:49:37 +00:00
pub id: uuid::Uuid,
2022-07-03 02:09:38 +00:00
///unique, mutable, user-controlled identifier for each resource
2022-05-23 15:49:37 +00:00
pub name: Name,
2022-07-03 02:09:38 +00:00
///SSH public key, e.g., `"ssh-ed25519 AAAAC3NzaC..."`
2022-05-23 15:49:37 +00:00
pub public_key: String,
2022-07-03 02:09:38 +00:00
///The user to whom this key belongs
2022-05-23 15:49:37 +00:00
pub silo_user_id: uuid::Uuid,
2022-07-03 02:09:38 +00:00
///timestamp when this resource was created
2022-05-23 15:49:37 +00:00
pub time_created: chrono::DateTime<chrono::offset::Utc>,
2022-07-03 02:09:38 +00:00
///timestamp when this resource was last modified
2022-05-23 15:49:37 +00:00
pub time_modified: chrono::DateTime<chrono::offset::Utc>,
}
2023-02-05 01:22:55 +00:00
impl From<&SshKey> for SshKey {
fn from(value: &SshKey) -> Self {
value.clone()
}
}
2022-07-03 02:09:38 +00:00
///Create-time parameters for an
/// [`SshKey`](crate::external_api::views::SshKey)
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "Create-time parameters for an
/// [`SshKey`](crate::external_api::views::SshKey)", "type": "object",
/// "required": [
/// "description",
/// "name",
/// "public_key"
/// ],
/// "properties": {
/// "description": {
/// "type": "string"
/// },
/// "name": {
/// "$ref": "#/components/schemas/Name"
/// },
/// "public_key": {
/// "description": "SSH public key, e.g., `\"ssh-ed25519
/// AAAAC3NzaC...\"`", "type": "string"
/// }
/// }
///}
/// ```
/// </details>
2022-07-12 17:57:06 +00:00
#[derive(Clone, Debug, Deserialize, Serialize)]
2022-05-23 15:49:37 +00:00
pub struct SshKeyCreate {
pub description: String,
pub name: Name,
2022-07-03 02:09:38 +00:00
///SSH public key, e.g., `"ssh-ed25519 AAAAC3NzaC..."`
2022-05-23 15:49:37 +00:00
pub public_key: String,
}
2023-02-05 01:22:55 +00:00
impl From<&SshKeyCreate> for SshKeyCreate {
fn from(value: &SshKeyCreate) -> Self {
value.clone()
}
}
2022-07-03 02:09:38 +00:00
///A single page of results
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "A single page of results",
/// "type": "object",
/// "required": [
/// "items"
/// ],
/// "properties": {
/// "items": {
/// "description": "list of items on this page of results",
/// "type": "array",
/// "items": {
/// "$ref": "#/components/schemas/SshKey"
/// }
/// },
/// "next_page": {
/// "description": "token used to fetch the next page of results (if
/// any)", "type": [
/// "string",
/// "null"
/// ]
/// }
/// }
///}
/// ```
/// </details>
2022-07-12 17:57:06 +00:00
#[derive(Clone, Debug, Deserialize, Serialize)]
2022-05-23 15:49:37 +00:00
pub struct SshKeyResultsPage {
2022-07-03 02:09:38 +00:00
///list of items on this page of results
2022-05-23 15:49:37 +00:00
pub items: Vec<SshKey>,
2022-07-03 02:09:38 +00:00
///token used to fetch the next page of results (if any)
2022-05-23 15:49:37 +00:00
#[serde(default, skip_serializing_if = "Option::is_none")]
pub next_page: Option<String>,
}
2023-02-05 01:22:55 +00:00
impl From<&SshKeyResultsPage> for SshKeyResultsPage {
fn from(value: &SshKeyResultsPage) -> Self {
value.clone()
}
}
2023-12-13 09:14:28 +00:00
///SystemMetricName
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "type": "string",
/// "enum": [
/// "virtual_disk_space_provisioned",
/// "cpus_provisioned",
/// "ram_provisioned"
/// ]
///}
/// ```
/// </details>
2023-02-01 05:28:12 +00:00
#[derive(Clone, Copy, Debug, Deserialize, Eq, Hash, Ord, PartialEq, PartialOrd, Serialize)]
pub enum SystemMetricName {
#[serde(rename = "virtual_disk_space_provisioned")]
VirtualDiskSpaceProvisioned,
#[serde(rename = "cpus_provisioned")]
CpusProvisioned,
#[serde(rename = "ram_provisioned")]
RamProvisioned,
}
2023-02-05 01:22:55 +00:00
impl From<&SystemMetricName> for SystemMetricName {
fn from(value: &SystemMetricName) -> Self {
value.clone()
}
}
2023-02-01 05:28:12 +00:00
impl ToString for SystemMetricName {
fn to_string(&self) -> String {
match *self {
Self::VirtualDiskSpaceProvisioned => "virtual_disk_space_provisioned".to_string(),
Self::CpusProvisioned => "cpus_provisioned".to_string(),
Self::RamProvisioned => "ram_provisioned".to_string(),
}
}
}
impl std::str::FromStr for SystemMetricName {
type Err = &'static str;
fn from_str(value: &str) -> Result<Self, &'static str> {
match value {
"virtual_disk_space_provisioned" => Ok(Self::VirtualDiskSpaceProvisioned),
"cpus_provisioned" => Ok(Self::CpusProvisioned),
"ram_provisioned" => Ok(Self::RamProvisioned),
_ => Err("invalid value"),
}
}
}
impl std::convert::TryFrom<&str> for SystemMetricName {
type Error = &'static str;
fn try_from(value: &str) -> Result<Self, &'static str> {
value.parse()
}
}
impl std::convert::TryFrom<&String> for SystemMetricName {
type Error = &'static str;
fn try_from(value: &String) -> Result<Self, &'static str> {
value.parse()
}
}
impl std::convert::TryFrom<String> for SystemMetricName {
type Error = &'static str;
fn try_from(value: String) -> Result<Self, &'static str> {
value.parse()
}
}
///Identity-related metadata that's included in "asset" public API objects
/// (which generally have no name or description)
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "Identity-related metadata that's included in \"asset\"
/// public API objects (which generally have no name or description)",
/// "type": "object",
/// "required": [
/// "id",
/// "time_created",
/// "time_modified",
/// "version"
/// ],
/// "properties": {
/// "id": {
/// "description": "unique, immutable, system-controlled identifier for
/// each resource", "type": "string",
/// "format": "uuid"
/// },
/// "time_created": {
/// "description": "timestamp when this resource was created",
/// "type": "string",
/// "format": "date-time"
/// },
/// "time_modified": {
/// "description": "timestamp when this resource was last modified",
/// "type": "string",
/// "format": "date-time"
/// },
/// "version": {
/// "$ref": "#/components/schemas/SemverVersion"
/// }
/// }
///}
/// ```
/// </details>
2023-02-01 05:28:12 +00:00
#[derive(Clone, Debug, Deserialize, Serialize)]
pub struct SystemUpdate {
///unique, immutable, system-controlled identifier for each resource
pub id: uuid::Uuid,
///timestamp when this resource was created
pub time_created: chrono::DateTime<chrono::offset::Utc>,
///timestamp when this resource was last modified
pub time_modified: chrono::DateTime<chrono::offset::Utc>,
pub version: SemverVersion,
}
2023-02-05 01:22:55 +00:00
impl From<&SystemUpdate> for SystemUpdate {
fn from(value: &SystemUpdate) -> Self {
value.clone()
}
}
2023-02-01 05:28:12 +00:00
///A single page of results
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "A single page of results",
/// "type": "object",
/// "required": [
/// "items"
/// ],
/// "properties": {
/// "items": {
/// "description": "list of items on this page of results",
/// "type": "array",
/// "items": {
/// "$ref": "#/components/schemas/SystemUpdate"
/// }
/// },
/// "next_page": {
/// "description": "token used to fetch the next page of results (if
/// any)", "type": [
/// "string",
/// "null"
/// ]
/// }
/// }
///}
/// ```
/// </details>
2023-02-01 05:28:12 +00:00
#[derive(Clone, Debug, Deserialize, Serialize)]
pub struct SystemUpdateResultsPage {
///list of items on this page of results
pub items: Vec<SystemUpdate>,
///token used to fetch the next page of results (if any)
#[serde(default, skip_serializing_if = "Option::is_none")]
pub next_page: Option<String>,
}
2023-02-05 01:22:55 +00:00
impl From<&SystemUpdateResultsPage> for SystemUpdateResultsPage {
fn from(value: &SystemUpdateResultsPage) -> Self {
value.clone()
}
}
2023-12-13 09:14:28 +00:00
///SystemUpdateStart
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "type": "object",
/// "required": [
/// "version"
/// ],
/// "properties": {
/// "version": {
/// "$ref": "#/components/schemas/SemverVersion"
/// }
/// }
///}
/// ```
/// </details>
2023-02-01 05:28:12 +00:00
#[derive(Clone, Debug, Deserialize, Serialize)]
pub struct SystemUpdateStart {
pub version: SemverVersion,
}
2023-02-05 01:22:55 +00:00
impl From<&SystemUpdateStart> for SystemUpdateStart {
fn from(value: &SystemUpdateStart) -> Self {
value.clone()
}
}
2023-12-13 09:14:28 +00:00
///SystemVersion
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "type": "object",
/// "required": [
/// "status",
/// "version_range"
/// ],
/// "properties": {
/// "status": {
/// "$ref": "#/components/schemas/UpdateStatus"
/// },
/// "version_range": {
/// "$ref": "#/components/schemas/VersionRange"
/// }
/// }
///}
/// ```
/// </details>
2023-02-01 05:28:12 +00:00
#[derive(Clone, Debug, Deserialize, Serialize)]
pub struct SystemVersion {
pub status: UpdateStatus,
pub version_range: VersionRange,
}
2023-02-05 01:22:55 +00:00
impl From<&SystemVersion> for SystemVersion {
fn from(value: &SystemVersion) -> Self {
value.clone()
}
}
2022-07-03 02:09:38 +00:00
///Names are constructed by concatenating the target and metric names with
/// ':'. Target and metric names must be lowercase alphanumeric characters
/// with '_' separating words.
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "title": "The name of a timeseries",
/// "description": "Names are constructed by concatenating the target and
/// metric names with ':'. Target and metric names must be lowercase
/// alphanumeric characters with '_' separating words.",
/// "type": "string",
/// "pattern":
/// "(([a-z]+[a-z0-9]*)(_([a-z0-9]+))*):(([a-z]+[a-z0-9]*)(_([a-z0-9]+))*)"
/// }
/// ```
/// </details>
2023-05-02 20:55:50 +00:00
#[derive(Clone, Debug, Eq, Hash, Ord, PartialEq, PartialOrd, Serialize)]
2022-07-12 17:57:06 +00:00
pub struct TimeseriesName(String);
2022-01-05 20:02:46 +00:00
impl std::ops::Deref for TimeseriesName {
type Target = String;
2023-01-25 17:19:15 +00:00
fn deref(&self) -> &String {
2022-01-05 20:02:46 +00:00
&self.0
}
}
2023-02-05 01:22:55 +00:00
impl From<TimeseriesName> for String {
fn from(value: TimeseriesName) -> Self {
value.0
}
}
impl From<&TimeseriesName> for TimeseriesName {
fn from(value: &TimeseriesName) -> Self {
value.clone()
}
}
2023-01-25 17:19:15 +00:00
impl std::str::FromStr for TimeseriesName {
type Err = &'static str;
fn from_str(value: &str) -> Result<Self, &'static str> {
2022-07-12 17:57:06 +00:00
if regress::Regex::new(
"(([a-z]+[a-z0-9]*)(_([a-z0-9]+))*):(([a-z]+[a-z0-9]*)(_([a-z0-9]+))*)",
)
.unwrap()
.find(value)
.is_none()
{
2023-04-25 16:11:52 +00:00
return Err("doesn't match pattern \
\"(([a-z]+[a-z0-9]*)(_([a-z0-9]+))*):(([a-z]+[a-z0-9]*\
)(_([a-z0-9]+))*)\"");
2022-07-12 17:57:06 +00:00
}
Ok(Self(value.to_string()))
}
}
2023-01-25 17:19:15 +00:00
impl std::convert::TryFrom<&str> for TimeseriesName {
2022-09-10 16:41:07 +00:00
type Error = &'static str;
2023-01-25 17:19:15 +00:00
fn try_from(value: &str) -> Result<Self, &'static str> {
value.parse()
2022-09-10 16:41:07 +00:00
}
}
2023-01-25 17:19:15 +00:00
impl std::convert::TryFrom<&String> for TimeseriesName {
2022-07-12 17:57:06 +00:00
type Error = &'static str;
2023-01-25 17:19:15 +00:00
fn try_from(value: &String) -> Result<Self, &'static str> {
value.parse()
2022-07-12 17:57:06 +00:00
}
}
2023-01-30 20:17:51 +00:00
impl std::convert::TryFrom<String> for TimeseriesName {
type Error = &'static str;
fn try_from(value: String) -> Result<Self, &'static str> {
value.parse()
}
}
2022-07-12 17:57:06 +00:00
impl<'de> serde::Deserialize<'de> for TimeseriesName {
fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where
D: serde::Deserializer<'de>,
{
2023-01-25 17:19:15 +00:00
String::deserialize(deserializer)?
.parse()
.map_err(|e: &'static str| <D::Error as serde::de::Error>::custom(e.to_string()))
2022-07-12 17:57:06 +00:00
}
}
2022-07-03 02:09:38 +00:00
///The schema for a timeseries.
///
///This includes the name of the timeseries, as well as the datum type of
/// its metric and the schema for each field.
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "The schema for a timeseries.\n\nThis includes the name
/// of the timeseries, as well as the datum type of its metric and the
/// schema for each field.", "type": "object",
/// "required": [
/// "created",
/// "datum_type",
/// "field_schema",
/// "timeseries_name"
/// ],
/// "properties": {
/// "created": {
/// "type": "string",
/// "format": "date-time"
/// },
/// "datum_type": {
/// "$ref": "#/components/schemas/DatumType"
/// },
/// "field_schema": {
/// "type": "array",
/// "items": {
/// "$ref": "#/components/schemas/FieldSchema"
/// }
/// },
/// "timeseries_name": {
/// "$ref": "#/components/schemas/TimeseriesName"
/// }
/// }
///}
/// ```
/// </details>
2022-07-12 17:57:06 +00:00
#[derive(Clone, Debug, Deserialize, Serialize)]
2022-01-05 20:02:46 +00:00
pub struct TimeseriesSchema {
pub created: chrono::DateTime<chrono::offset::Utc>,
pub datum_type: DatumType,
pub field_schema: Vec<FieldSchema>,
pub timeseries_name: TimeseriesName,
}
2023-02-05 01:22:55 +00:00
impl From<&TimeseriesSchema> for TimeseriesSchema {
fn from(value: &TimeseriesSchema) -> Self {
value.clone()
}
}
2022-07-03 02:09:38 +00:00
///A single page of results
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "A single page of results",
/// "type": "object",
/// "required": [
/// "items"
/// ],
/// "properties": {
/// "items": {
/// "description": "list of items on this page of results",
/// "type": "array",
/// "items": {
/// "$ref": "#/components/schemas/TimeseriesSchema"
/// }
/// },
/// "next_page": {
/// "description": "token used to fetch the next page of results (if
/// any)", "type": [
/// "string",
/// "null"
/// ]
/// }
/// }
///}
/// ```
/// </details>
2022-07-12 17:57:06 +00:00
#[derive(Clone, Debug, Deserialize, Serialize)]
2022-01-05 20:02:46 +00:00
pub struct TimeseriesSchemaResultsPage {
2022-07-03 02:09:38 +00:00
///list of items on this page of results
2022-01-05 20:02:46 +00:00
pub items: Vec<TimeseriesSchema>,
2022-07-03 02:09:38 +00:00
///token used to fetch the next page of results (if any)
2022-01-05 20:02:46 +00:00
#[serde(default, skip_serializing_if = "Option::is_none")]
pub next_page: Option<String>,
}
2023-02-05 01:22:55 +00:00
impl From<&TimeseriesSchemaResultsPage> for TimeseriesSchemaResultsPage {
fn from(value: &TimeseriesSchemaResultsPage) -> Self {
value.clone()
}
}
2023-02-01 05:28:12 +00:00
///Identity-related metadata that's included in "asset" public API objects
/// (which generally have no name or description)
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "Identity-related metadata that's included in \"asset\"
/// public API objects (which generally have no name or description)",
/// "type": "object",
/// "required": [
/// "id",
/// "status",
/// "time_created",
/// "time_modified",
/// "version"
/// ],
/// "properties": {
/// "id": {
/// "description": "unique, immutable, system-controlled identifier for
/// each resource", "type": "string",
/// "format": "uuid"
/// },
/// "status": {
/// "$ref": "#/components/schemas/UpdateStatus"
/// },
/// "time_created": {
/// "description": "timestamp when this resource was created",
/// "type": "string",
/// "format": "date-time"
/// },
/// "time_modified": {
/// "description": "timestamp when this resource was last modified",
/// "type": "string",
/// "format": "date-time"
/// },
/// "version": {
/// "$ref": "#/components/schemas/SemverVersion"
/// }
/// }
///}
/// ```
/// </details>
2022-07-12 17:57:06 +00:00
#[derive(Clone, Debug, Deserialize, Serialize)]
2023-02-01 05:28:12 +00:00
pub struct UpdateDeployment {
2022-07-03 02:09:38 +00:00
///unique, immutable, system-controlled identifier for each resource
2021-12-10 02:15:24 +00:00
pub id: uuid::Uuid,
2023-02-01 05:28:12 +00:00
pub status: UpdateStatus,
2022-07-03 02:09:38 +00:00
///timestamp when this resource was created
2021-12-10 02:15:24 +00:00
pub time_created: chrono::DateTime<chrono::offset::Utc>,
2022-07-03 02:09:38 +00:00
///timestamp when this resource was last modified
2021-12-10 02:15:24 +00:00
pub time_modified: chrono::DateTime<chrono::offset::Utc>,
2023-02-01 05:28:12 +00:00
pub version: SemverVersion,
2021-12-10 02:15:24 +00:00
}
2023-02-05 01:22:55 +00:00
impl From<&UpdateDeployment> for UpdateDeployment {
fn from(value: &UpdateDeployment) -> Self {
value.clone()
}
}
2022-07-08 01:35:36 +00:00
///A single page of results
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "A single page of results",
/// "type": "object",
/// "required": [
/// "items"
/// ],
/// "properties": {
/// "items": {
/// "description": "list of items on this page of results",
/// "type": "array",
/// "items": {
/// "$ref": "#/components/schemas/UpdateDeployment"
/// }
/// },
/// "next_page": {
/// "description": "token used to fetch the next page of results (if
/// any)", "type": [
/// "string",
/// "null"
/// ]
/// }
/// }
///}
/// ```
/// </details>
2022-07-12 17:57:06 +00:00
#[derive(Clone, Debug, Deserialize, Serialize)]
2023-02-01 05:28:12 +00:00
pub struct UpdateDeploymentResultsPage {
2022-07-08 01:35:36 +00:00
///list of items on this page of results
2023-02-01 05:28:12 +00:00
pub items: Vec<UpdateDeployment>,
2022-07-08 01:35:36 +00:00
///token used to fetch the next page of results (if any)
#[serde(default, skip_serializing_if = "Option::is_none")]
pub next_page: Option<String>,
}
2023-02-05 01:22:55 +00:00
impl From<&UpdateDeploymentResultsPage> for UpdateDeploymentResultsPage {
fn from(value: &UpdateDeploymentResultsPage) -> Self {
value.clone()
}
}
2023-12-13 09:14:28 +00:00
///UpdateStatus
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "oneOf": [
/// {
/// "type": "object",
/// "required": [
/// "status"
/// ],
/// "properties": {
/// "status": {
/// "type": "string",
/// "enum": [
/// "updating"
/// ]
/// }
/// }
/// },
/// {
/// "type": "object",
/// "required": [
/// "status"
/// ],
/// "properties": {
/// "status": {
/// "type": "string",
/// "enum": [
/// "steady"
/// ]
/// }
/// }
/// }
/// ]
///}
/// ```
/// </details>
2022-07-12 17:57:06 +00:00
#[derive(Clone, Copy, Debug, Deserialize, Eq, Hash, Ord, PartialEq, PartialOrd, Serialize)]
2023-02-01 05:28:12 +00:00
#[serde(tag = "status")]
pub enum UpdateStatus {
#[serde(rename = "updating")]
Updating,
#[serde(rename = "steady")]
Steady,
2022-07-08 01:35:36 +00:00
}
2023-02-05 01:22:55 +00:00
impl From<&UpdateStatus> for UpdateStatus {
fn from(value: &UpdateStatus) -> Self {
value.clone()
}
}
2023-02-01 05:28:12 +00:00
impl ToString for UpdateStatus {
2022-07-08 01:35:36 +00:00
fn to_string(&self) -> String {
match *self {
2023-02-01 05:28:12 +00:00
Self::Updating => "updating".to_string(),
Self::Steady => "steady".to_string(),
2022-07-12 17:57:06 +00:00
}
}
}
2023-02-01 05:28:12 +00:00
impl std::str::FromStr for UpdateStatus {
2022-07-12 17:57:06 +00:00
type Err = &'static str;
2023-01-25 17:19:15 +00:00
fn from_str(value: &str) -> Result<Self, &'static str> {
2022-07-12 17:57:06 +00:00
match value {
2023-02-01 05:28:12 +00:00
"updating" => Ok(Self::Updating),
"steady" => Ok(Self::Steady),
2022-07-12 17:57:06 +00:00
_ => Err("invalid value"),
2022-07-08 01:35:36 +00:00
}
}
}
2023-02-01 05:28:12 +00:00
impl std::convert::TryFrom<&str> for UpdateStatus {
2023-01-25 17:19:15 +00:00
type Error = &'static str;
fn try_from(value: &str) -> Result<Self, &'static str> {
value.parse()
}
}
2023-02-01 05:28:12 +00:00
impl std::convert::TryFrom<&String> for UpdateStatus {
2023-01-25 17:19:15 +00:00
type Error = &'static str;
fn try_from(value: &String) -> Result<Self, &'static str> {
value.parse()
}
}
2023-02-01 05:28:12 +00:00
impl std::convert::TryFrom<String> for UpdateStatus {
2023-01-30 20:17:51 +00:00
type Error = &'static str;
fn try_from(value: String) -> Result<Self, &'static str> {
value.parse()
}
}
2023-02-01 05:28:12 +00:00
///Identity-related metadata that's included in "asset" public API objects
/// (which generally have no name or description)
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "Identity-related metadata that's included in \"asset\"
/// public API objects (which generally have no name or description)",
/// "type": "object",
/// "required": [
/// "component_type",
/// "device_id",
/// "id",
/// "status",
/// "system_version",
/// "time_created",
/// "time_modified",
/// "version"
/// ],
/// "properties": {
/// "component_type": {
/// "$ref": "#/components/schemas/UpdateableComponentType"
/// },
/// "device_id": {
/// "type": "string"
/// },
/// "id": {
/// "description": "unique, immutable, system-controlled identifier for
/// each resource", "type": "string",
/// "format": "uuid"
/// },
/// "status": {
/// "$ref": "#/components/schemas/UpdateStatus"
/// },
/// "system_version": {
/// "$ref": "#/components/schemas/SemverVersion"
/// },
/// "time_created": {
/// "description": "timestamp when this resource was created",
/// "type": "string",
/// "format": "date-time"
/// },
/// "time_modified": {
/// "description": "timestamp when this resource was last modified",
/// "type": "string",
/// "format": "date-time"
/// },
/// "version": {
/// "$ref": "#/components/schemas/SemverVersion"
/// }
/// }
///}
/// ```
/// </details>
2023-02-01 05:28:12 +00:00
#[derive(Clone, Debug, Deserialize, Serialize)]
pub struct UpdateableComponent {
pub component_type: UpdateableComponentType,
pub device_id: String,
///unique, immutable, system-controlled identifier for each resource
pub id: uuid::Uuid,
pub status: UpdateStatus,
pub system_version: SemverVersion,
///timestamp when this resource was created
pub time_created: chrono::DateTime<chrono::offset::Utc>,
///timestamp when this resource was last modified
pub time_modified: chrono::DateTime<chrono::offset::Utc>,
pub version: SemverVersion,
}
2023-02-05 01:22:55 +00:00
impl From<&UpdateableComponent> for UpdateableComponent {
fn from(value: &UpdateableComponent) -> Self {
value.clone()
}
}
2023-02-01 05:28:12 +00:00
///A single page of results
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "A single page of results",
/// "type": "object",
/// "required": [
/// "items"
/// ],
/// "properties": {
/// "items": {
/// "description": "list of items on this page of results",
/// "type": "array",
/// "items": {
/// "$ref": "#/components/schemas/UpdateableComponent"
/// }
/// },
/// "next_page": {
/// "description": "token used to fetch the next page of results (if
/// any)", "type": [
/// "string",
/// "null"
/// ]
/// }
/// }
///}
/// ```
/// </details>
2023-02-01 05:28:12 +00:00
#[derive(Clone, Debug, Deserialize, Serialize)]
pub struct UpdateableComponentResultsPage {
///list of items on this page of results
pub items: Vec<UpdateableComponent>,
///token used to fetch the next page of results (if any)
#[serde(default, skip_serializing_if = "Option::is_none")]
pub next_page: Option<String>,
}
2023-02-05 01:22:55 +00:00
impl From<&UpdateableComponentResultsPage> for UpdateableComponentResultsPage {
fn from(value: &UpdateableComponentResultsPage) -> Self {
value.clone()
}
}
2023-12-13 09:14:28 +00:00
///UpdateableComponentType
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "type": "string",
/// "enum": [
/// "bootloader_for_rot",
/// "bootloader_for_sp",
/// "bootloader_for_host_proc",
/// "hubris_for_psc_rot",
/// "hubris_for_psc_sp",
/// "hubris_for_sidecar_rot",
/// "hubris_for_sidecar_sp",
/// "hubris_for_gimlet_rot",
/// "hubris_for_gimlet_sp",
/// "helios_host_phase1",
/// "helios_host_phase2",
/// "host_omicron"
/// ]
///}
/// ```
/// </details>
2023-02-01 05:28:12 +00:00
#[derive(Clone, Copy, Debug, Deserialize, Eq, Hash, Ord, PartialEq, PartialOrd, Serialize)]
pub enum UpdateableComponentType {
#[serde(rename = "bootloader_for_rot")]
BootloaderForRot,
#[serde(rename = "bootloader_for_sp")]
BootloaderForSp,
#[serde(rename = "bootloader_for_host_proc")]
BootloaderForHostProc,
#[serde(rename = "hubris_for_psc_rot")]
HubrisForPscRot,
#[serde(rename = "hubris_for_psc_sp")]
HubrisForPscSp,
#[serde(rename = "hubris_for_sidecar_rot")]
HubrisForSidecarRot,
#[serde(rename = "hubris_for_sidecar_sp")]
HubrisForSidecarSp,
#[serde(rename = "hubris_for_gimlet_rot")]
HubrisForGimletRot,
#[serde(rename = "hubris_for_gimlet_sp")]
HubrisForGimletSp,
#[serde(rename = "helios_host_phase1")]
HeliosHostPhase1,
#[serde(rename = "helios_host_phase2")]
HeliosHostPhase2,
#[serde(rename = "host_omicron")]
HostOmicron,
}
2023-02-05 01:22:55 +00:00
impl From<&UpdateableComponentType> for UpdateableComponentType {
fn from(value: &UpdateableComponentType) -> Self {
value.clone()
}
}
2023-02-01 05:28:12 +00:00
impl ToString for UpdateableComponentType {
fn to_string(&self) -> String {
match *self {
Self::BootloaderForRot => "bootloader_for_rot".to_string(),
Self::BootloaderForSp => "bootloader_for_sp".to_string(),
Self::BootloaderForHostProc => "bootloader_for_host_proc".to_string(),
Self::HubrisForPscRot => "hubris_for_psc_rot".to_string(),
Self::HubrisForPscSp => "hubris_for_psc_sp".to_string(),
Self::HubrisForSidecarRot => "hubris_for_sidecar_rot".to_string(),
Self::HubrisForSidecarSp => "hubris_for_sidecar_sp".to_string(),
Self::HubrisForGimletRot => "hubris_for_gimlet_rot".to_string(),
Self::HubrisForGimletSp => "hubris_for_gimlet_sp".to_string(),
Self::HeliosHostPhase1 => "helios_host_phase1".to_string(),
Self::HeliosHostPhase2 => "helios_host_phase2".to_string(),
Self::HostOmicron => "host_omicron".to_string(),
}
}
}
impl std::str::FromStr for UpdateableComponentType {
type Err = &'static str;
fn from_str(value: &str) -> Result<Self, &'static str> {
match value {
"bootloader_for_rot" => Ok(Self::BootloaderForRot),
"bootloader_for_sp" => Ok(Self::BootloaderForSp),
"bootloader_for_host_proc" => Ok(Self::BootloaderForHostProc),
"hubris_for_psc_rot" => Ok(Self::HubrisForPscRot),
"hubris_for_psc_sp" => Ok(Self::HubrisForPscSp),
"hubris_for_sidecar_rot" => Ok(Self::HubrisForSidecarRot),
"hubris_for_sidecar_sp" => Ok(Self::HubrisForSidecarSp),
"hubris_for_gimlet_rot" => Ok(Self::HubrisForGimletRot),
"hubris_for_gimlet_sp" => Ok(Self::HubrisForGimletSp),
"helios_host_phase1" => Ok(Self::HeliosHostPhase1),
"helios_host_phase2" => Ok(Self::HeliosHostPhase2),
"host_omicron" => Ok(Self::HostOmicron),
_ => Err("invalid value"),
}
}
}
impl std::convert::TryFrom<&str> for UpdateableComponentType {
type Error = &'static str;
fn try_from(value: &str) -> Result<Self, &'static str> {
value.parse()
}
}
impl std::convert::TryFrom<&String> for UpdateableComponentType {
type Error = &'static str;
fn try_from(value: &String) -> Result<Self, &'static str> {
value.parse()
}
}
impl std::convert::TryFrom<String> for UpdateableComponentType {
type Error = &'static str;
fn try_from(value: String) -> Result<Self, &'static str> {
value.parse()
}
}
///Client view of a [`User`]
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "Client view of a [`User`]",
/// "type": "object",
/// "required": [
/// "display_name",
/// "id",
/// "silo_id"
/// ],
/// "properties": {
/// "display_name": {
/// "description": "Human-readable name that can identify the user",
/// "type": "string"
/// },
/// "id": {
/// "type": "string",
/// "format": "uuid"
/// },
/// "silo_id": {
/// "description": "Uuid of the silo to which this user belongs",
/// "type": "string",
/// "format": "uuid"
/// }
/// }
///}
/// ```
/// </details>
2023-02-01 05:28:12 +00:00
#[derive(Clone, Debug, Deserialize, Serialize)]
pub struct User {
///Human-readable name that can identify the user
pub display_name: String,
pub id: uuid::Uuid,
///Uuid of the silo to which this user belongs
pub silo_id: uuid::Uuid,
}
2023-02-05 01:22:55 +00:00
impl From<&User> for User {
fn from(value: &User) -> Self {
value.clone()
}
}
2023-02-01 05:28:12 +00:00
///Client view of a [`UserBuiltin`]
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "Client view of a [`UserBuiltin`]",
/// "type": "object",
/// "required": [
/// "description",
/// "id",
/// "name",
/// "time_created",
/// "time_modified"
/// ],
/// "properties": {
/// "description": {
/// "description": "human-readable free-form text about a resource",
/// "type": "string"
/// },
/// "id": {
/// "description": "unique, immutable, system-controlled identifier for
/// each resource", "type": "string",
/// "format": "uuid"
/// },
/// "name": {
/// "description": "unique, mutable, user-controlled identifier for
/// each resource", "allOf": [
/// {
/// "$ref": "#/components/schemas/Name"
/// }
/// ]
/// },
/// "time_created": {
/// "description": "timestamp when this resource was created",
/// "type": "string",
/// "format": "date-time"
/// },
/// "time_modified": {
/// "description": "timestamp when this resource was last modified",
/// "type": "string",
/// "format": "date-time"
/// }
/// }
///}
/// ```
/// </details>
2023-02-01 05:28:12 +00:00
#[derive(Clone, Debug, Deserialize, Serialize)]
pub struct UserBuiltin {
///human-readable free-form text about a resource
pub description: String,
///unique, immutable, system-controlled identifier for each resource
pub id: uuid::Uuid,
///unique, mutable, user-controlled identifier for each resource
pub name: Name,
///timestamp when this resource was created
pub time_created: chrono::DateTime<chrono::offset::Utc>,
///timestamp when this resource was last modified
pub time_modified: chrono::DateTime<chrono::offset::Utc>,
}
2023-02-05 01:22:55 +00:00
impl From<&UserBuiltin> for UserBuiltin {
fn from(value: &UserBuiltin) -> Self {
value.clone()
}
}
2023-02-01 05:28:12 +00:00
///A single page of results
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "A single page of results",
/// "type": "object",
/// "required": [
/// "items"
/// ],
/// "properties": {
/// "items": {
/// "description": "list of items on this page of results",
/// "type": "array",
/// "items": {
/// "$ref": "#/components/schemas/UserBuiltin"
/// }
/// },
/// "next_page": {
/// "description": "token used to fetch the next page of results (if
/// any)", "type": [
/// "string",
/// "null"
/// ]
/// }
/// }
///}
/// ```
/// </details>
2023-02-01 05:28:12 +00:00
#[derive(Clone, Debug, Deserialize, Serialize)]
pub struct UserBuiltinResultsPage {
///list of items on this page of results
pub items: Vec<UserBuiltin>,
///token used to fetch the next page of results (if any)
#[serde(default, skip_serializing_if = "Option::is_none")]
pub next_page: Option<String>,
}
2023-02-05 01:22:55 +00:00
impl From<&UserBuiltinResultsPage> for UserBuiltinResultsPage {
fn from(value: &UserBuiltinResultsPage) -> Self {
value.clone()
}
}
2023-02-01 05:28:12 +00:00
///Create-time parameters for a [`User`](crate::external_api::views::User)
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "Create-time parameters for a
/// [`User`](crate::external_api::views::User)", "type": "object",
/// "required": [
/// "external_id",
/// "password"
/// ],
/// "properties": {
/// "external_id": {
/// "description": "username used to log in",
/// "allOf": [
/// {
/// "$ref": "#/components/schemas/UserId"
/// }
/// ]
/// },
/// "password": {
/// "description": "password used to log in",
/// "allOf": [
/// {
/// "$ref": "#/components/schemas/UserPassword"
/// }
/// ]
/// }
/// }
///}
/// ```
/// </details>
2023-02-01 05:28:12 +00:00
#[derive(Clone, Debug, Deserialize, Serialize)]
pub struct UserCreate {
///username used to log in
pub external_id: UserId,
///password used to log in
pub password: UserPassword,
}
2023-02-05 01:22:55 +00:00
impl From<&UserCreate> for UserCreate {
fn from(value: &UserCreate) -> Self {
value.clone()
}
}
2023-02-01 05:28:12 +00:00
///Names must begin with a lower case ASCII letter, be composed exclusively
/// of lowercase ASCII, uppercase ASCII, numbers, and '-', and may not end
/// with a '-'. Names cannot be a UUID though they may contain a UUID.
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "title": "A name unique within the parent collection",
/// "description": "Names must begin with a lower case ASCII letter, be
/// composed exclusively of lowercase ASCII, uppercase ASCII, numbers, and
/// '-', and may not end with a '-'. Names cannot be a UUID though they may
/// contain a UUID.", "type": "string",
/// "maxLength": 63,
/// "pattern":
/// "^(?![0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$)^[a-z][a-z0-9-]*
/// [a-zA-Z0-9]$" }
/// ```
/// </details>
2023-05-02 20:55:50 +00:00
#[derive(Clone, Debug, Eq, Hash, Ord, PartialEq, PartialOrd, Serialize)]
2023-02-01 05:28:12 +00:00
pub struct UserId(String);
impl std::ops::Deref for UserId {
type Target = String;
fn deref(&self) -> &String {
&self.0
}
}
2023-02-05 01:22:55 +00:00
impl From<UserId> for String {
fn from(value: UserId) -> Self {
value.0
}
}
impl From<&UserId> for UserId {
fn from(value: &UserId) -> Self {
value.clone()
}
}
2023-02-01 05:28:12 +00:00
impl std::str::FromStr for UserId {
type Err = &'static str;
fn from_str(value: &str) -> Result<Self, &'static str> {
if value.len() > 63usize {
return Err("longer than 63 characters");
}
if regress :: Regex :: new ("^(?![0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$)^[a-z][a-z0-9-]*[a-zA-Z0-9]$") . unwrap () . find (value) . is_none () { return Err ("doesn't match pattern \"^(?![0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$)^[a-z][a-z0-9-]*[a-zA-Z0-9]$\"") ; }
Ok(Self(value.to_string()))
}
}
impl std::convert::TryFrom<&str> for UserId {
type Error = &'static str;
fn try_from(value: &str) -> Result<Self, &'static str> {
value.parse()
}
}
impl std::convert::TryFrom<&String> for UserId {
type Error = &'static str;
fn try_from(value: &String) -> Result<Self, &'static str> {
value.parse()
}
}
impl std::convert::TryFrom<String> for UserId {
type Error = &'static str;
fn try_from(value: String) -> Result<Self, &'static str> {
value.parse()
}
}
impl<'de> serde::Deserialize<'de> for UserId {
fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where
D: serde::Deserializer<'de>,
{
String::deserialize(deserializer)?
.parse()
.map_err(|e: &'static str| <D::Error as serde::de::Error>::custom(e.to_string()))
}
}
///Parameters for setting a user's password
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "Parameters for setting a user's password",
/// "oneOf": [
/// {
/// "description": "Sets the user's password to the provided value",
/// "type": "object",
/// "required": [
/// "details",
/// "user_password_value"
/// ],
/// "properties": {
/// "details": {
/// "$ref": "#/components/schemas/Password"
/// },
/// "user_password_value": {
/// "type": "string",
/// "enum": [
/// "password"
/// ]
/// }
/// }
/// },
/// {
/// "description": "Invalidates any current password (disabling
/// password authentication)", "type": "object",
/// "required": [
/// "user_password_value"
/// ],
/// "properties": {
/// "user_password_value": {
/// "type": "string",
/// "enum": [
/// "invalid_password"
/// ]
/// }
/// }
/// }
/// ]
///}
/// ```
/// </details>
2023-02-01 05:28:12 +00:00
#[derive(Clone, Debug, Deserialize, Serialize)]
#[serde(tag = "user_password_value", content = "details")]
pub enum UserPassword {
///Sets the user's password to the provided value
#[serde(rename = "password")]
Password(Password),
#[serde(rename = "invalid_password")]
InvalidPassword,
}
2023-02-05 01:22:55 +00:00
impl From<&UserPassword> for UserPassword {
fn from(value: &UserPassword) -> Self {
value.clone()
}
}
2023-03-17 22:39:46 +00:00
impl From<Password> for UserPassword {
fn from(value: Password) -> Self {
Self::Password(value)
}
}
2023-02-01 05:28:12 +00:00
///A single page of results
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "A single page of results",
/// "type": "object",
/// "required": [
/// "items"
/// ],
/// "properties": {
/// "items": {
/// "description": "list of items on this page of results",
/// "type": "array",
/// "items": {
/// "$ref": "#/components/schemas/User"
/// }
/// },
/// "next_page": {
/// "description": "token used to fetch the next page of results (if
/// any)", "type": [
/// "string",
/// "null"
/// ]
/// }
/// }
///}
/// ```
/// </details>
2022-07-12 17:57:06 +00:00
#[derive(Clone, Debug, Deserialize, Serialize)]
2021-12-10 02:15:24 +00:00
pub struct UserResultsPage {
2022-07-03 02:09:38 +00:00
///list of items on this page of results
2021-12-10 02:15:24 +00:00
pub items: Vec<User>,
2022-07-03 02:09:38 +00:00
///token used to fetch the next page of results (if any)
2021-12-10 02:15:24 +00:00
#[serde(default, skip_serializing_if = "Option::is_none")]
pub next_page: Option<String>,
}
2023-02-05 01:22:55 +00:00
impl From<&UserResultsPage> for UserResultsPage {
fn from(value: &UserResultsPage) -> Self {
value.clone()
}
}
2023-02-01 05:28:12 +00:00
///Credentials for local user login
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "Credentials for local user login",
/// "type": "object",
/// "required": [
/// "password",
/// "username"
/// ],
/// "properties": {
/// "password": {
/// "$ref": "#/components/schemas/Password"
/// },
/// "username": {
/// "$ref": "#/components/schemas/UserId"
/// }
/// }
///}
/// ```
/// </details>
2023-02-01 05:28:12 +00:00
#[derive(Clone, Debug, Deserialize, Serialize)]
pub struct UsernamePasswordCredentials {
pub password: Password,
pub username: UserId,
}
2023-02-05 01:22:55 +00:00
impl From<&UsernamePasswordCredentials> for UsernamePasswordCredentials {
fn from(value: &UsernamePasswordCredentials) -> Self {
value.clone()
}
}
2023-12-13 09:14:28 +00:00
///VersionRange
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "type": "object",
/// "required": [
/// "high",
/// "low"
/// ],
/// "properties": {
/// "high": {
/// "$ref": "#/components/schemas/SemverVersion"
/// },
/// "low": {
/// "$ref": "#/components/schemas/SemverVersion"
/// }
/// }
///}
/// ```
/// </details>
2023-02-01 05:28:12 +00:00
#[derive(Clone, Debug, Deserialize, Serialize)]
pub struct VersionRange {
pub high: SemverVersion,
pub low: SemverVersion,
}
2023-02-05 01:22:55 +00:00
impl From<&VersionRange> for VersionRange {
fn from(value: &VersionRange) -> Self {
value.clone()
}
}
2022-07-03 02:09:38 +00:00
///Client view of a [`Vpc`]
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "Client view of a [`Vpc`]",
/// "type": "object",
/// "required": [
/// "description",
/// "dns_name",
/// "id",
/// "ipv6_prefix",
/// "name",
/// "project_id",
/// "system_router_id",
/// "time_created",
/// "time_modified"
/// ],
/// "properties": {
/// "description": {
/// "description": "human-readable free-form text about a resource",
/// "type": "string"
/// },
/// "dns_name": {
/// "description": "The name used for the VPC in DNS.",
/// "allOf": [
/// {
/// "$ref": "#/components/schemas/Name"
/// }
/// ]
/// },
/// "id": {
/// "description": "unique, immutable, system-controlled identifier for
/// each resource", "type": "string",
/// "format": "uuid"
/// },
/// "ipv6_prefix": {
/// "description": "The unique local IPv6 address range for subnets in
/// this VPC", "allOf": [
/// {
/// "$ref": "#/components/schemas/Ipv6Net"
/// }
/// ]
/// },
/// "name": {
/// "description": "unique, mutable, user-controlled identifier for
/// each resource", "allOf": [
/// {
/// "$ref": "#/components/schemas/Name"
/// }
/// ]
/// },
/// "project_id": {
/// "description": "id for the project containing this VPC",
/// "type": "string",
/// "format": "uuid"
/// },
/// "system_router_id": {
/// "description": "id for the system router where subnet default
/// routes are registered", "type": "string",
/// "format": "uuid"
/// },
/// "time_created": {
/// "description": "timestamp when this resource was created",
/// "type": "string",
/// "format": "date-time"
/// },
/// "time_modified": {
/// "description": "timestamp when this resource was last modified",
/// "type": "string",
/// "format": "date-time"
/// }
/// }
///}
/// ```
/// </details>
2022-07-12 17:57:06 +00:00
#[derive(Clone, Debug, Deserialize, Serialize)]
2021-12-10 02:15:24 +00:00
pub struct Vpc {
2022-07-03 02:09:38 +00:00
///human-readable free-form text about a resource
2021-12-10 02:15:24 +00:00
pub description: String,
2022-07-03 02:09:38 +00:00
///The name used for the VPC in DNS.
2021-12-10 02:15:24 +00:00
pub dns_name: Name,
2022-07-03 02:09:38 +00:00
///unique, immutable, system-controlled identifier for each resource
2021-12-10 02:15:24 +00:00
pub id: uuid::Uuid,
2022-07-03 02:09:38 +00:00
///The unique local IPv6 address range for subnets in this VPC
2022-05-10 00:30:08 +00:00
pub ipv6_prefix: Ipv6Net,
2022-07-03 02:09:38 +00:00
///unique, mutable, user-controlled identifier for each resource
2021-12-10 02:15:24 +00:00
pub name: Name,
2022-07-03 02:09:38 +00:00
///id for the project containing this VPC
2021-12-10 02:15:24 +00:00
pub project_id: uuid::Uuid,
2022-07-03 02:09:38 +00:00
///id for the system router where subnet default routes are registered
2021-12-10 02:15:24 +00:00
pub system_router_id: uuid::Uuid,
2022-07-03 02:09:38 +00:00
///timestamp when this resource was created
2021-12-10 02:15:24 +00:00
pub time_created: chrono::DateTime<chrono::offset::Utc>,
2022-07-03 02:09:38 +00:00
///timestamp when this resource was last modified
2021-12-10 02:15:24 +00:00
pub time_modified: chrono::DateTime<chrono::offset::Utc>,
}
2023-02-05 01:22:55 +00:00
impl From<&Vpc> for Vpc {
fn from(value: &Vpc) -> Self {
value.clone()
}
}
2022-07-03 02:09:38 +00:00
///Create-time parameters for a [`Vpc`](crate::external_api::views::Vpc)
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "Create-time parameters for a
/// [`Vpc`](crate::external_api::views::Vpc)", "type": "object",
/// "required": [
/// "description",
/// "dns_name",
/// "name"
/// ],
/// "properties": {
/// "description": {
/// "type": "string"
/// },
/// "dns_name": {
/// "$ref": "#/components/schemas/Name"
/// },
/// "ipv6_prefix": {
/// "description": "The IPv6 prefix for this VPC.\n\nAll IPv6 subnets
/// created from this VPC must be taken from this range, which sould be a
/// Unique Local Address in the range `fd00::/48`. The default VPC Subnet
/// will have the first `/64` range from this prefix.", "allOf": [
/// {
/// "$ref": "#/components/schemas/Ipv6Net"
/// }
/// ]
/// },
/// "name": {
/// "$ref": "#/components/schemas/Name"
/// }
/// }
///}
/// ```
/// </details>
2022-07-12 17:57:06 +00:00
#[derive(Clone, Debug, Deserialize, Serialize)]
2021-12-10 02:15:24 +00:00
pub struct VpcCreate {
pub description: String,
pub dns_name: Name,
2022-07-03 02:09:38 +00:00
///The IPv6 prefix for this VPC.
///
///All IPv6 subnets created from this VPC must be taken from this
/// range, which sould be a Unique Local Address in the range
/// `fd00::/48`. The default VPC Subnet will have the first `/64` range
/// from this prefix.
2022-05-10 00:30:08 +00:00
#[serde(default, skip_serializing_if = "Option::is_none")]
pub ipv6_prefix: Option<Ipv6Net>,
2021-12-10 02:15:24 +00:00
pub name: Name,
}
2023-02-05 01:22:55 +00:00
impl From<&VpcCreate> for VpcCreate {
fn from(value: &VpcCreate) -> Self {
value.clone()
}
}
2022-07-03 02:09:38 +00:00
///A single rule in a VPC firewall
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "A single rule in a VPC firewall",
/// "type": "object",
/// "required": [
/// "action",
/// "description",
/// "direction",
/// "filters",
/// "id",
/// "name",
/// "priority",
/// "status",
/// "targets",
/// "time_created",
/// "time_modified",
/// "vpc_id"
/// ],
/// "properties": {
/// "action": {
/// "description": "whether traffic matching the rule should be allowed
/// or dropped", "allOf": [
/// {
/// "$ref": "#/components/schemas/VpcFirewallRuleAction"
/// }
/// ]
/// },
/// "description": {
/// "description": "human-readable free-form text about a resource",
/// "type": "string"
/// },
/// "direction": {
/// "description": "whether this rule is for incoming or outgoing
/// traffic", "allOf": [
/// {
/// "$ref": "#/components/schemas/VpcFirewallRuleDirection"
/// }
/// ]
/// },
/// "filters": {
/// "description": "reductions on the scope of the rule",
/// "allOf": [
/// {
/// "$ref": "#/components/schemas/VpcFirewallRuleFilter"
/// }
/// ]
/// },
/// "id": {
/// "description": "unique, immutable, system-controlled identifier for
/// each resource", "type": "string",
/// "format": "uuid"
/// },
/// "name": {
/// "description": "unique, mutable, user-controlled identifier for
/// each resource", "allOf": [
/// {
/// "$ref": "#/components/schemas/Name"
/// }
/// ]
/// },
/// "priority": {
/// "description": "the relative priority of this rule",
/// "type": "integer",
/// "format": "uint16",
/// "minimum": 0.0
/// },
/// "status": {
/// "description": "whether this rule is in effect",
/// "allOf": [
/// {
/// "$ref": "#/components/schemas/VpcFirewallRuleStatus"
/// }
/// ]
/// },
/// "targets": {
/// "description": "list of sets of instances that the rule applies
/// to", "type": "array",
/// "items": {
/// "$ref": "#/components/schemas/VpcFirewallRuleTarget"
/// }
/// },
/// "time_created": {
/// "description": "timestamp when this resource was created",
/// "type": "string",
/// "format": "date-time"
/// },
/// "time_modified": {
/// "description": "timestamp when this resource was last modified",
/// "type": "string",
/// "format": "date-time"
/// },
/// "vpc_id": {
/// "description": "the VPC to which this rule belongs",
/// "type": "string",
/// "format": "uuid"
/// }
/// }
///}
/// ```
/// </details>
2022-07-12 17:57:06 +00:00
#[derive(Clone, Debug, Deserialize, Serialize)]
2021-12-10 02:15:24 +00:00
pub struct VpcFirewallRule {
2022-07-03 02:09:38 +00:00
///whether traffic matching the rule should be allowed or dropped
2021-12-10 02:15:24 +00:00
pub action: VpcFirewallRuleAction,
2022-07-03 02:09:38 +00:00
///human-readable free-form text about a resource
2022-02-08 16:59:38 +00:00
pub description: String,
2022-07-03 02:09:38 +00:00
///whether this rule is for incoming or outgoing traffic
2021-12-10 02:15:24 +00:00
pub direction: VpcFirewallRuleDirection,
2022-07-03 02:09:38 +00:00
///reductions on the scope of the rule
2021-12-10 02:15:24 +00:00
pub filters: VpcFirewallRuleFilter,
2022-07-03 02:09:38 +00:00
///unique, immutable, system-controlled identifier for each resource
2022-02-08 16:59:38 +00:00
pub id: uuid::Uuid,
2022-07-03 02:09:38 +00:00
///unique, mutable, user-controlled identifier for each resource
2022-02-08 16:59:38 +00:00
pub name: Name,
2022-07-03 02:09:38 +00:00
///the relative priority of this rule
2021-12-10 02:15:24 +00:00
pub priority: u16,
2022-07-03 02:09:38 +00:00
///whether this rule is in effect
2021-12-10 02:15:24 +00:00
pub status: VpcFirewallRuleStatus,
2022-07-03 02:09:38 +00:00
///list of sets of instances that the rule applies to
2021-12-10 02:15:24 +00:00
pub targets: Vec<VpcFirewallRuleTarget>,
2022-07-03 02:09:38 +00:00
///timestamp when this resource was created
2022-02-08 16:59:38 +00:00
pub time_created: chrono::DateTime<chrono::offset::Utc>,
2022-07-03 02:09:38 +00:00
///timestamp when this resource was last modified
2022-02-08 16:59:38 +00:00
pub time_modified: chrono::DateTime<chrono::offset::Utc>,
2022-07-03 02:09:38 +00:00
///the VPC to which this rule belongs
2022-03-18 06:54:10 +00:00
pub vpc_id: uuid::Uuid,
2021-12-10 02:15:24 +00:00
}
2023-02-05 01:22:55 +00:00
impl From<&VpcFirewallRule> for VpcFirewallRule {
fn from(value: &VpcFirewallRule) -> Self {
value.clone()
}
}
2023-12-13 09:14:28 +00:00
///VpcFirewallRuleAction
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "type": "string",
/// "enum": [
/// "allow",
/// "deny"
/// ]
///}
/// ```
/// </details>
2022-07-12 17:57:06 +00:00
#[derive(Clone, Copy, Debug, Deserialize, Eq, Hash, Ord, PartialEq, PartialOrd, Serialize)]
2021-12-10 02:15:24 +00:00
pub enum VpcFirewallRuleAction {
#[serde(rename = "allow")]
Allow,
#[serde(rename = "deny")]
Deny,
}
2023-02-05 01:22:55 +00:00
impl From<&VpcFirewallRuleAction> for VpcFirewallRuleAction {
fn from(value: &VpcFirewallRuleAction) -> Self {
value.clone()
}
}
2021-12-10 02:15:24 +00:00
impl ToString for VpcFirewallRuleAction {
fn to_string(&self) -> String {
2022-03-08 07:22:44 +00:00
match *self {
2022-07-12 17:57:06 +00:00
Self::Allow => "allow".to_string(),
Self::Deny => "deny".to_string(),
}
}
}
impl std::str::FromStr for VpcFirewallRuleAction {
type Err = &'static str;
2023-01-25 17:19:15 +00:00
fn from_str(value: &str) -> Result<Self, &'static str> {
2022-07-12 17:57:06 +00:00
match value {
"allow" => Ok(Self::Allow),
"deny" => Ok(Self::Deny),
_ => Err("invalid value"),
2021-12-10 02:15:24 +00:00
}
}
}
2023-01-25 17:19:15 +00:00
impl std::convert::TryFrom<&str> for VpcFirewallRuleAction {
type Error = &'static str;
fn try_from(value: &str) -> Result<Self, &'static str> {
value.parse()
}
}
impl std::convert::TryFrom<&String> for VpcFirewallRuleAction {
type Error = &'static str;
fn try_from(value: &String) -> Result<Self, &'static str> {
value.parse()
}
}
2023-01-30 20:17:51 +00:00
impl std::convert::TryFrom<String> for VpcFirewallRuleAction {
type Error = &'static str;
fn try_from(value: String) -> Result<Self, &'static str> {
value.parse()
}
}
2023-12-13 09:14:28 +00:00
///VpcFirewallRuleDirection
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "type": "string",
/// "enum": [
/// "inbound",
/// "outbound"
/// ]
///}
/// ```
/// </details>
2022-07-12 17:57:06 +00:00
#[derive(Clone, Copy, Debug, Deserialize, Eq, Hash, Ord, PartialEq, PartialOrd, Serialize)]
2021-12-10 02:15:24 +00:00
pub enum VpcFirewallRuleDirection {
#[serde(rename = "inbound")]
Inbound,
#[serde(rename = "outbound")]
Outbound,
}
2023-02-05 01:22:55 +00:00
impl From<&VpcFirewallRuleDirection> for VpcFirewallRuleDirection {
fn from(value: &VpcFirewallRuleDirection) -> Self {
value.clone()
}
}
2021-12-10 02:15:24 +00:00
impl ToString for VpcFirewallRuleDirection {
fn to_string(&self) -> String {
2022-03-08 07:22:44 +00:00
match *self {
2022-07-12 17:57:06 +00:00
Self::Inbound => "inbound".to_string(),
Self::Outbound => "outbound".to_string(),
}
}
}
impl std::str::FromStr for VpcFirewallRuleDirection {
type Err = &'static str;
2023-01-25 17:19:15 +00:00
fn from_str(value: &str) -> Result<Self, &'static str> {
2022-07-12 17:57:06 +00:00
match value {
"inbound" => Ok(Self::Inbound),
"outbound" => Ok(Self::Outbound),
_ => Err("invalid value"),
2021-12-10 02:15:24 +00:00
}
}
}
2023-01-25 17:19:15 +00:00
impl std::convert::TryFrom<&str> for VpcFirewallRuleDirection {
type Error = &'static str;
fn try_from(value: &str) -> Result<Self, &'static str> {
value.parse()
}
}
impl std::convert::TryFrom<&String> for VpcFirewallRuleDirection {
type Error = &'static str;
fn try_from(value: &String) -> Result<Self, &'static str> {
value.parse()
}
}
2023-01-30 20:17:51 +00:00
impl std::convert::TryFrom<String> for VpcFirewallRuleDirection {
type Error = &'static str;
fn try_from(value: String) -> Result<Self, &'static str> {
value.parse()
}
}
2022-07-03 02:09:38 +00:00
///Filter for a firewall rule. A given packet must match every field that
/// is present for the rule to apply to it. A packet matches a field if any
/// entry in that field matches the packet.
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "Filter for a firewall rule. A given packet must match
/// every field that is present for the rule to apply to it. A packet
/// matches a field if any entry in that field matches the packet.",
/// "type": "object",
/// "properties": {
/// "hosts": {
/// "description": "If present, the sources (if incoming) or
/// destinations (if outgoing) this rule applies to.", "type": [
/// "array",
/// "null"
/// ],
/// "items": {
/// "$ref": "#/components/schemas/VpcFirewallRuleHostFilter"
/// }
/// },
/// "ports": {
/// "description": "If present, the destination ports this rule applies
/// to.", "type": [
/// "array",
/// "null"
/// ],
/// "items": {
/// "$ref": "#/components/schemas/L4PortRange"
/// }
/// },
/// "protocols": {
/// "description": "If present, the networking protocols this rule
/// applies to.", "type": [
/// "array",
/// "null"
/// ],
/// "items": {
/// "$ref": "#/components/schemas/VpcFirewallRuleProtocol"
/// }
/// }
/// }
///}
/// ```
/// </details>
2022-07-12 17:57:06 +00:00
#[derive(Clone, Debug, Deserialize, Serialize)]
2021-12-10 02:15:24 +00:00
pub struct VpcFirewallRuleFilter {
2022-07-03 02:09:38 +00:00
///If present, the sources (if incoming) or destinations (if outgoing)
/// this rule applies to.
2021-12-10 02:15:24 +00:00
#[serde(default, skip_serializing_if = "Option::is_none")]
pub hosts: Option<Vec<VpcFirewallRuleHostFilter>>,
2022-07-03 02:09:38 +00:00
///If present, the destination ports this rule applies to.
2021-12-10 02:15:24 +00:00
#[serde(default, skip_serializing_if = "Option::is_none")]
pub ports: Option<Vec<L4PortRange>>,
2022-07-03 02:09:38 +00:00
///If present, the networking protocols this rule applies to.
2021-12-10 02:15:24 +00:00
#[serde(default, skip_serializing_if = "Option::is_none")]
pub protocols: Option<Vec<VpcFirewallRuleProtocol>>,
}
2023-02-05 01:22:55 +00:00
impl From<&VpcFirewallRuleFilter> for VpcFirewallRuleFilter {
fn from(value: &VpcFirewallRuleFilter) -> Self {
value.clone()
}
}
2022-07-03 02:09:38 +00:00
///The `VpcFirewallRuleHostFilter` is used to filter traffic on the basis
/// of its source or destination host.
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "The `VpcFirewallRuleHostFilter` is used to filter
/// traffic on the basis of its source or destination host.",
/// "oneOf": [
/// {
/// "description": "The rule applies to traffic from/to all instances
/// in the VPC", "type": "object",
/// "required": [
/// "type",
/// "value"
/// ],
/// "properties": {
/// "type": {
/// "type": "string",
/// "enum": [
/// "vpc"
/// ]
/// },
/// "value": {
/// "$ref": "#/components/schemas/Name"
/// }
/// }
/// },
/// {
/// "description": "The rule applies to traffic from/to all instances
/// in the VPC Subnet", "type": "object",
/// "required": [
/// "type",
/// "value"
/// ],
/// "properties": {
/// "type": {
/// "type": "string",
/// "enum": [
/// "subnet"
/// ]
/// },
/// "value": {
/// "$ref": "#/components/schemas/Name"
/// }
/// }
/// },
/// {
/// "description": "The rule applies to traffic from/to this specific
/// instance", "type": "object",
/// "required": [
/// "type",
/// "value"
/// ],
/// "properties": {
/// "type": {
/// "type": "string",
/// "enum": [
/// "instance"
/// ]
/// },
/// "value": {
/// "$ref": "#/components/schemas/Name"
/// }
/// }
/// },
/// {
/// "description": "The rule applies to traffic from/to a specific IP
/// address", "type": "object",
/// "required": [
/// "type",
/// "value"
/// ],
/// "properties": {
/// "type": {
/// "type": "string",
/// "enum": [
/// "ip"
/// ]
/// },
/// "value": {
/// "type": "string",
/// "format": "ip"
/// }
/// }
/// },
/// {
/// "description": "The rule applies to traffic from/to a specific IP
/// subnet", "type": "object",
/// "required": [
/// "type",
/// "value"
/// ],
/// "properties": {
/// "type": {
/// "type": "string",
/// "enum": [
/// "ip_net"
/// ]
/// },
/// "value": {
/// "$ref": "#/components/schemas/IpNet"
/// }
/// }
/// }
/// ]
///}
/// ```
/// </details>
2022-07-12 17:57:06 +00:00
#[derive(Clone, Debug, Deserialize, Serialize)]
2021-12-10 02:15:24 +00:00
#[serde(tag = "type", content = "value")]
pub enum VpcFirewallRuleHostFilter {
2022-07-03 02:09:38 +00:00
///The rule applies to traffic from/to all instances in the VPC
2021-12-10 02:15:24 +00:00
#[serde(rename = "vpc")]
Vpc(Name),
2022-07-03 02:09:38 +00:00
///The rule applies to traffic from/to all instances in the VPC Subnet
2021-12-10 02:15:24 +00:00
#[serde(rename = "subnet")]
Subnet(Name),
2022-07-03 02:09:38 +00:00
///The rule applies to traffic from/to this specific instance
2021-12-10 02:15:24 +00:00
#[serde(rename = "instance")]
Instance(Name),
2022-07-03 02:09:38 +00:00
///The rule applies to traffic from/to a specific IP address
2021-12-10 02:15:24 +00:00
#[serde(rename = "ip")]
2022-07-03 05:28:06 +00:00
Ip(std::net::IpAddr),
2022-07-03 02:09:38 +00:00
///The rule applies to traffic from/to a specific IP subnet
2022-03-18 06:54:10 +00:00
#[serde(rename = "ip_net")]
IpNet(IpNet),
2021-12-10 02:15:24 +00:00
}
2023-02-05 01:22:55 +00:00
impl From<&VpcFirewallRuleHostFilter> for VpcFirewallRuleHostFilter {
fn from(value: &VpcFirewallRuleHostFilter) -> Self {
value.clone()
}
}
2023-03-17 22:39:46 +00:00
impl From<std::net::IpAddr> for VpcFirewallRuleHostFilter {
fn from(value: std::net::IpAddr) -> Self {
Self::Ip(value)
}
}
impl From<IpNet> for VpcFirewallRuleHostFilter {
fn from(value: IpNet) -> Self {
Self::IpNet(value)
}
}
2022-07-03 02:09:38 +00:00
///The protocols that may be specified in a firewall rule's filter
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "The protocols that may be specified in a firewall
/// rule's filter", "type": "string",
/// "enum": [
/// "TCP",
/// "UDP",
/// "ICMP"
/// ]
///}
/// ```
/// </details>
2022-07-12 17:57:06 +00:00
#[derive(Clone, Copy, Debug, Deserialize, Eq, Hash, Ord, PartialEq, PartialOrd, Serialize)]
2021-12-10 02:15:24 +00:00
pub enum VpcFirewallRuleProtocol {
#[serde(rename = "TCP")]
Tcp,
#[serde(rename = "UDP")]
Udp,
#[serde(rename = "ICMP")]
Icmp,
}
2023-02-05 01:22:55 +00:00
impl From<&VpcFirewallRuleProtocol> for VpcFirewallRuleProtocol {
fn from(value: &VpcFirewallRuleProtocol) -> Self {
value.clone()
}
}
2021-12-10 02:15:24 +00:00
impl ToString for VpcFirewallRuleProtocol {
fn to_string(&self) -> String {
2022-03-08 07:22:44 +00:00
match *self {
2022-07-12 17:57:06 +00:00
Self::Tcp => "TCP".to_string(),
Self::Udp => "UDP".to_string(),
Self::Icmp => "ICMP".to_string(),
2021-12-10 02:15:24 +00:00
}
}
}
2022-07-12 17:57:06 +00:00
impl std::str::FromStr for VpcFirewallRuleProtocol {
type Err = &'static str;
2023-01-25 17:19:15 +00:00
fn from_str(value: &str) -> Result<Self, &'static str> {
2022-07-12 17:57:06 +00:00
match value {
"TCP" => Ok(Self::Tcp),
"UDP" => Ok(Self::Udp),
"ICMP" => Ok(Self::Icmp),
_ => Err("invalid value"),
}
}
}
2023-01-25 17:19:15 +00:00
impl std::convert::TryFrom<&str> for VpcFirewallRuleProtocol {
type Error = &'static str;
fn try_from(value: &str) -> Result<Self, &'static str> {
value.parse()
}
}
impl std::convert::TryFrom<&String> for VpcFirewallRuleProtocol {
type Error = &'static str;
fn try_from(value: &String) -> Result<Self, &'static str> {
value.parse()
}
}
2023-01-30 20:17:51 +00:00
impl std::convert::TryFrom<String> for VpcFirewallRuleProtocol {
type Error = &'static str;
fn try_from(value: String) -> Result<Self, &'static str> {
value.parse()
}
}
2023-12-13 09:14:28 +00:00
///VpcFirewallRuleStatus
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "type": "string",
/// "enum": [
/// "disabled",
/// "enabled"
/// ]
///}
/// ```
/// </details>
2022-07-12 17:57:06 +00:00
#[derive(Clone, Copy, Debug, Deserialize, Eq, Hash, Ord, PartialEq, PartialOrd, Serialize)]
2021-12-10 02:15:24 +00:00
pub enum VpcFirewallRuleStatus {
#[serde(rename = "disabled")]
Disabled,
#[serde(rename = "enabled")]
Enabled,
}
2023-02-05 01:22:55 +00:00
impl From<&VpcFirewallRuleStatus> for VpcFirewallRuleStatus {
fn from(value: &VpcFirewallRuleStatus) -> Self {
value.clone()
}
}
2021-12-10 02:15:24 +00:00
impl ToString for VpcFirewallRuleStatus {
fn to_string(&self) -> String {
2022-03-08 07:22:44 +00:00
match *self {
2022-07-12 17:57:06 +00:00
Self::Disabled => "disabled".to_string(),
Self::Enabled => "enabled".to_string(),
}
}
}
impl std::str::FromStr for VpcFirewallRuleStatus {
type Err = &'static str;
2023-01-25 17:19:15 +00:00
fn from_str(value: &str) -> Result<Self, &'static str> {
2022-07-12 17:57:06 +00:00
match value {
"disabled" => Ok(Self::Disabled),
"enabled" => Ok(Self::Enabled),
_ => Err("invalid value"),
2021-12-10 02:15:24 +00:00
}
}
}
2023-01-25 17:19:15 +00:00
impl std::convert::TryFrom<&str> for VpcFirewallRuleStatus {
type Error = &'static str;
fn try_from(value: &str) -> Result<Self, &'static str> {
value.parse()
}
}
impl std::convert::TryFrom<&String> for VpcFirewallRuleStatus {
type Error = &'static str;
fn try_from(value: &String) -> Result<Self, &'static str> {
value.parse()
}
}
2023-01-30 20:17:51 +00:00
impl std::convert::TryFrom<String> for VpcFirewallRuleStatus {
type Error = &'static str;
fn try_from(value: String) -> Result<Self, &'static str> {
value.parse()
}
}
2022-07-03 02:09:38 +00:00
///A `VpcFirewallRuleTarget` is used to specify the set of [`Instance`]s to
/// which a firewall rule applies.
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "A `VpcFirewallRuleTarget` is used to specify the set of
/// [`Instance`]s to which a firewall rule applies.", "oneOf": [
/// {
/// "description": "The rule applies to all instances in the VPC",
/// "type": "object",
/// "required": [
/// "type",
/// "value"
/// ],
/// "properties": {
/// "type": {
/// "type": "string",
/// "enum": [
/// "vpc"
/// ]
/// },
/// "value": {
/// "$ref": "#/components/schemas/Name"
/// }
/// }
/// },
/// {
/// "description": "The rule applies to all instances in the VPC
/// Subnet", "type": "object",
/// "required": [
/// "type",
/// "value"
/// ],
/// "properties": {
/// "type": {
/// "type": "string",
/// "enum": [
/// "subnet"
/// ]
/// },
/// "value": {
/// "$ref": "#/components/schemas/Name"
/// }
/// }
/// },
/// {
/// "description": "The rule applies to this specific instance",
/// "type": "object",
/// "required": [
/// "type",
/// "value"
/// ],
/// "properties": {
/// "type": {
/// "type": "string",
/// "enum": [
/// "instance"
/// ]
/// },
/// "value": {
/// "$ref": "#/components/schemas/Name"
/// }
/// }
/// },
/// {
/// "description": "The rule applies to a specific IP address",
/// "type": "object",
/// "required": [
/// "type",
/// "value"
/// ],
/// "properties": {
/// "type": {
/// "type": "string",
/// "enum": [
/// "ip"
/// ]
/// },
/// "value": {
/// "type": "string",
/// "format": "ip"
/// }
/// }
/// },
/// {
/// "description": "The rule applies to a specific IP subnet",
/// "type": "object",
/// "required": [
/// "type",
/// "value"
/// ],
/// "properties": {
/// "type": {
/// "type": "string",
/// "enum": [
/// "ip_net"
/// ]
/// },
/// "value": {
/// "$ref": "#/components/schemas/IpNet"
/// }
/// }
/// }
/// ]
///}
/// ```
/// </details>
2022-07-12 17:57:06 +00:00
#[derive(Clone, Debug, Deserialize, Serialize)]
2021-12-10 02:15:24 +00:00
#[serde(tag = "type", content = "value")]
pub enum VpcFirewallRuleTarget {
2022-07-03 02:09:38 +00:00
///The rule applies to all instances in the VPC
2021-12-10 02:15:24 +00:00
#[serde(rename = "vpc")]
Vpc(Name),
2022-07-03 02:09:38 +00:00
///The rule applies to all instances in the VPC Subnet
2021-12-10 02:15:24 +00:00
#[serde(rename = "subnet")]
Subnet(Name),
2022-07-03 02:09:38 +00:00
///The rule applies to this specific instance
2021-12-10 02:15:24 +00:00
#[serde(rename = "instance")]
Instance(Name),
2022-07-03 02:09:38 +00:00
///The rule applies to a specific IP address
2022-03-18 06:54:10 +00:00
#[serde(rename = "ip")]
2022-07-03 05:28:06 +00:00
Ip(std::net::IpAddr),
2022-07-03 02:09:38 +00:00
///The rule applies to a specific IP subnet
2022-03-18 06:54:10 +00:00
#[serde(rename = "ip_net")]
IpNet(IpNet),
2021-12-10 02:15:24 +00:00
}
2023-02-05 01:22:55 +00:00
impl From<&VpcFirewallRuleTarget> for VpcFirewallRuleTarget {
fn from(value: &VpcFirewallRuleTarget) -> Self {
value.clone()
}
}
2023-03-17 22:39:46 +00:00
impl From<std::net::IpAddr> for VpcFirewallRuleTarget {
fn from(value: std::net::IpAddr) -> Self {
Self::Ip(value)
}
}
impl From<IpNet> for VpcFirewallRuleTarget {
fn from(value: IpNet) -> Self {
Self::IpNet(value)
}
}
2022-07-03 02:09:38 +00:00
///A single rule in a VPC firewall
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "A single rule in a VPC firewall",
/// "type": "object",
/// "required": [
/// "action",
/// "description",
/// "direction",
/// "filters",
/// "name",
/// "priority",
/// "status",
/// "targets"
/// ],
/// "properties": {
/// "action": {
/// "description": "whether traffic matching the rule should be allowed
/// or dropped", "allOf": [
/// {
/// "$ref": "#/components/schemas/VpcFirewallRuleAction"
/// }
/// ]
/// },
/// "description": {
/// "description": "human-readable free-form text about a resource",
/// "type": "string"
/// },
/// "direction": {
/// "description": "whether this rule is for incoming or outgoing
/// traffic", "allOf": [
/// {
/// "$ref": "#/components/schemas/VpcFirewallRuleDirection"
/// }
/// ]
/// },
/// "filters": {
/// "description": "reductions on the scope of the rule",
/// "allOf": [
/// {
/// "$ref": "#/components/schemas/VpcFirewallRuleFilter"
/// }
/// ]
/// },
/// "name": {
/// "description": "name of the rule, unique to this VPC",
/// "allOf": [
/// {
/// "$ref": "#/components/schemas/Name"
/// }
/// ]
/// },
/// "priority": {
/// "description": "the relative priority of this rule",
/// "type": "integer",
/// "format": "uint16",
/// "minimum": 0.0
/// },
/// "status": {
/// "description": "whether this rule is in effect",
/// "allOf": [
/// {
/// "$ref": "#/components/schemas/VpcFirewallRuleStatus"
/// }
/// ]
/// },
/// "targets": {
/// "description": "list of sets of instances that the rule applies
/// to", "type": "array",
/// "items": {
/// "$ref": "#/components/schemas/VpcFirewallRuleTarget"
/// }
/// }
/// }
///}
/// ```
/// </details>
2022-07-12 17:57:06 +00:00
#[derive(Clone, Debug, Deserialize, Serialize)]
2021-12-10 02:15:24 +00:00
pub struct VpcFirewallRuleUpdate {
2022-07-03 02:09:38 +00:00
///whether traffic matching the rule should be allowed or dropped
2021-12-10 02:15:24 +00:00
pub action: VpcFirewallRuleAction,
2022-07-03 02:09:38 +00:00
///human-readable free-form text about a resource
2021-12-10 02:15:24 +00:00
pub description: String,
2022-07-03 02:09:38 +00:00
///whether this rule is for incoming or outgoing traffic
2021-12-10 02:15:24 +00:00
pub direction: VpcFirewallRuleDirection,
2022-07-03 02:09:38 +00:00
///reductions on the scope of the rule
2021-12-10 02:15:24 +00:00
pub filters: VpcFirewallRuleFilter,
2022-07-03 02:09:38 +00:00
///name of the rule, unique to this VPC
2022-03-18 06:54:10 +00:00
pub name: Name,
2022-07-03 02:09:38 +00:00
///the relative priority of this rule
2021-12-10 02:15:24 +00:00
pub priority: u16,
2022-07-03 02:09:38 +00:00
///whether this rule is in effect
2021-12-10 02:15:24 +00:00
pub status: VpcFirewallRuleStatus,
2022-07-03 02:09:38 +00:00
///list of sets of instances that the rule applies to
2021-12-10 02:15:24 +00:00
pub targets: Vec<VpcFirewallRuleTarget>,
}
2023-02-05 01:22:55 +00:00
impl From<&VpcFirewallRuleUpdate> for VpcFirewallRuleUpdate {
fn from(value: &VpcFirewallRuleUpdate) -> Self {
value.clone()
}
}
2022-07-03 02:09:38 +00:00
///Updateable properties of a `Vpc`'s firewall Note that VpcFirewallRules
/// are implicitly created along with a Vpc, so there is no explicit
/// creation.
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "Updateable properties of a `Vpc`'s firewall Note that
/// VpcFirewallRules are implicitly created along with a Vpc, so there is no
/// explicit creation.", "type": "object",
/// "required": [
/// "rules"
/// ],
/// "properties": {
/// "rules": {
/// "type": "array",
/// "items": {
/// "$ref": "#/components/schemas/VpcFirewallRuleUpdate"
/// }
/// }
/// }
///}
/// ```
/// </details>
2022-07-12 17:57:06 +00:00
#[derive(Clone, Debug, Deserialize, Serialize)]
2022-03-18 06:54:10 +00:00
pub struct VpcFirewallRuleUpdateParams {
pub rules: Vec<VpcFirewallRuleUpdate>,
2021-12-10 02:15:24 +00:00
}
2023-02-05 01:22:55 +00:00
impl From<&VpcFirewallRuleUpdateParams> for VpcFirewallRuleUpdateParams {
fn from(value: &VpcFirewallRuleUpdateParams) -> Self {
value.clone()
}
}
2023-02-01 05:28:12 +00:00
///Collection of a Vpc's firewall rules
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "Collection of a Vpc's firewall rules",
/// "type": "object",
/// "required": [
/// "rules"
/// ],
/// "properties": {
/// "rules": {
/// "type": "array",
/// "items": {
/// "$ref": "#/components/schemas/VpcFirewallRule"
/// }
/// }
/// }
///}
/// ```
/// </details>
2022-07-12 17:57:06 +00:00
#[derive(Clone, Debug, Deserialize, Serialize)]
2022-03-18 06:54:10 +00:00
pub struct VpcFirewallRules {
pub rules: Vec<VpcFirewallRule>,
2021-12-10 02:15:24 +00:00
}
2023-02-05 01:22:55 +00:00
impl From<&VpcFirewallRules> for VpcFirewallRules {
fn from(value: &VpcFirewallRules) -> Self {
value.clone()
}
}
2022-07-03 02:09:38 +00:00
///A single page of results
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "A single page of results",
/// "type": "object",
/// "required": [
/// "items"
/// ],
/// "properties": {
/// "items": {
/// "description": "list of items on this page of results",
/// "type": "array",
/// "items": {
/// "$ref": "#/components/schemas/Vpc"
/// }
/// },
/// "next_page": {
/// "description": "token used to fetch the next page of results (if
/// any)", "type": [
/// "string",
/// "null"
/// ]
/// }
/// }
///}
/// ```
/// </details>
2022-07-12 17:57:06 +00:00
#[derive(Clone, Debug, Deserialize, Serialize)]
2021-12-10 02:15:24 +00:00
pub struct VpcResultsPage {
2022-07-03 02:09:38 +00:00
///list of items on this page of results
2021-12-10 02:15:24 +00:00
pub items: Vec<Vpc>,
2022-07-03 02:09:38 +00:00
///token used to fetch the next page of results (if any)
2021-12-10 02:15:24 +00:00
#[serde(default, skip_serializing_if = "Option::is_none")]
pub next_page: Option<String>,
}
2023-02-05 01:22:55 +00:00
impl From<&VpcResultsPage> for VpcResultsPage {
fn from(value: &VpcResultsPage) -> Self {
value.clone()
}
}
2022-07-03 02:09:38 +00:00
///A VPC router defines a series of rules that indicate where traffic
/// should be sent depending on its destination.
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "A VPC router defines a series of rules that indicate
/// where traffic should be sent depending on its destination.",
/// "type": "object",
/// "required": [
/// "description",
/// "id",
/// "kind",
/// "name",
/// "time_created",
/// "time_modified",
/// "vpc_id"
/// ],
/// "properties": {
/// "description": {
/// "description": "human-readable free-form text about a resource",
/// "type": "string"
/// },
/// "id": {
/// "description": "unique, immutable, system-controlled identifier for
/// each resource", "type": "string",
/// "format": "uuid"
/// },
/// "kind": {
/// "$ref": "#/components/schemas/VpcRouterKind"
/// },
/// "name": {
/// "description": "unique, mutable, user-controlled identifier for
/// each resource", "allOf": [
/// {
/// "$ref": "#/components/schemas/Name"
/// }
/// ]
/// },
/// "time_created": {
/// "description": "timestamp when this resource was created",
/// "type": "string",
/// "format": "date-time"
/// },
/// "time_modified": {
/// "description": "timestamp when this resource was last modified",
/// "type": "string",
/// "format": "date-time"
/// },
/// "vpc_id": {
/// "description": "The VPC to which the router belongs.",
/// "type": "string",
/// "format": "uuid"
/// }
/// }
///}
/// ```
/// </details>
2022-07-12 17:57:06 +00:00
#[derive(Clone, Debug, Deserialize, Serialize)]
2021-12-10 02:15:24 +00:00
pub struct VpcRouter {
2022-07-03 02:09:38 +00:00
///human-readable free-form text about a resource
2022-02-08 16:59:38 +00:00
pub description: String,
2022-07-03 02:09:38 +00:00
///unique, immutable, system-controlled identifier for each resource
2022-02-08 16:59:38 +00:00
pub id: uuid::Uuid,
2021-12-10 02:15:24 +00:00
pub kind: VpcRouterKind,
2022-07-03 02:09:38 +00:00
///unique, mutable, user-controlled identifier for each resource
2022-02-08 16:59:38 +00:00
pub name: Name,
2022-07-03 02:09:38 +00:00
///timestamp when this resource was created
2022-02-08 16:59:38 +00:00
pub time_created: chrono::DateTime<chrono::offset::Utc>,
2022-07-03 02:09:38 +00:00
///timestamp when this resource was last modified
2022-02-08 16:59:38 +00:00
pub time_modified: chrono::DateTime<chrono::offset::Utc>,
2022-07-03 02:09:38 +00:00
///The VPC to which the router belongs.
2021-12-10 02:15:24 +00:00
pub vpc_id: uuid::Uuid,
}
2023-02-05 01:22:55 +00:00
impl From<&VpcRouter> for VpcRouter {
fn from(value: &VpcRouter) -> Self {
value.clone()
}
}
2022-07-03 02:09:38 +00:00
///Create-time parameters for a
/// [`VpcRouter`](crate::external_api::views::VpcRouter)
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "Create-time parameters for a
/// [`VpcRouter`](crate::external_api::views::VpcRouter)",
/// "type": "object",
/// "required": [
/// "description",
/// "name"
/// ],
/// "properties": {
/// "description": {
/// "type": "string"
/// },
/// "name": {
/// "$ref": "#/components/schemas/Name"
/// }
/// }
///}
/// ```
/// </details>
2022-07-12 17:57:06 +00:00
#[derive(Clone, Debug, Deserialize, Serialize)]
2021-12-10 02:15:24 +00:00
pub struct VpcRouterCreate {
pub description: String,
pub name: Name,
}
2023-02-05 01:22:55 +00:00
impl From<&VpcRouterCreate> for VpcRouterCreate {
fn from(value: &VpcRouterCreate) -> Self {
value.clone()
}
}
2023-12-13 09:14:28 +00:00
///VpcRouterKind
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "type": "string",
/// "enum": [
/// "system",
/// "custom"
/// ]
///}
/// ```
/// </details>
2022-07-12 17:57:06 +00:00
#[derive(Clone, Copy, Debug, Deserialize, Eq, Hash, Ord, PartialEq, PartialOrd, Serialize)]
2021-12-10 02:15:24 +00:00
pub enum VpcRouterKind {
#[serde(rename = "system")]
System,
#[serde(rename = "custom")]
Custom,
}
2023-02-05 01:22:55 +00:00
impl From<&VpcRouterKind> for VpcRouterKind {
fn from(value: &VpcRouterKind) -> Self {
value.clone()
}
}
2021-12-10 02:15:24 +00:00
impl ToString for VpcRouterKind {
fn to_string(&self) -> String {
2022-03-08 07:22:44 +00:00
match *self {
2022-07-12 17:57:06 +00:00
Self::System => "system".to_string(),
Self::Custom => "custom".to_string(),
}
}
}
impl std::str::FromStr for VpcRouterKind {
type Err = &'static str;
2023-01-25 17:19:15 +00:00
fn from_str(value: &str) -> Result<Self, &'static str> {
2022-07-12 17:57:06 +00:00
match value {
"system" => Ok(Self::System),
"custom" => Ok(Self::Custom),
_ => Err("invalid value"),
2021-12-10 02:15:24 +00:00
}
}
2023-01-25 17:19:15 +00:00
}
impl std::convert::TryFrom<&str> for VpcRouterKind {
type Error = &'static str;
fn try_from(value: &str) -> Result<Self, &'static str> {
value.parse()
}
}
impl std::convert::TryFrom<&String> for VpcRouterKind {
type Error = &'static str;
fn try_from(value: &String) -> Result<Self, &'static str> {
value.parse()
}
2023-01-30 20:17:51 +00:00
}
impl std::convert::TryFrom<String> for VpcRouterKind {
type Error = &'static str;
fn try_from(value: String) -> Result<Self, &'static str> {
value.parse()
}
2021-12-10 02:15:24 +00:00
}
2022-07-03 02:09:38 +00:00
///A single page of results
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "A single page of results",
/// "type": "object",
/// "required": [
/// "items"
/// ],
/// "properties": {
/// "items": {
/// "description": "list of items on this page of results",
/// "type": "array",
/// "items": {
/// "$ref": "#/components/schemas/VpcRouter"
/// }
/// },
/// "next_page": {
/// "description": "token used to fetch the next page of results (if
/// any)", "type": [
/// "string",
/// "null"
/// ]
/// }
/// }
///}
/// ```
/// </details>
2022-07-12 17:57:06 +00:00
#[derive(Clone, Debug, Deserialize, Serialize)]
2021-12-10 02:15:24 +00:00
pub struct VpcRouterResultsPage {
2022-07-03 02:09:38 +00:00
///list of items on this page of results
2021-12-10 02:15:24 +00:00
pub items: Vec<VpcRouter>,
2022-07-03 02:09:38 +00:00
///token used to fetch the next page of results (if any)
2021-12-10 02:15:24 +00:00
#[serde(default, skip_serializing_if = "Option::is_none")]
pub next_page: Option<String>,
}
2023-02-05 01:22:55 +00:00
impl From<&VpcRouterResultsPage> for VpcRouterResultsPage {
fn from(value: &VpcRouterResultsPage) -> Self {
value.clone()
}
}
2022-07-03 02:09:38 +00:00
///Updateable properties of a
/// [`VpcRouter`](crate::external_api::views::VpcRouter)
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "Updateable properties of a
/// [`VpcRouter`](crate::external_api::views::VpcRouter)",
/// "type": "object",
/// "properties": {
/// "description": {
/// "type": [
/// "string",
/// "null"
/// ]
/// },
/// "name": {
/// "allOf": [
/// {
/// "$ref": "#/components/schemas/Name"
/// }
/// ]
/// }
/// }
///}
/// ```
/// </details>
2022-07-12 17:57:06 +00:00
#[derive(Clone, Debug, Deserialize, Serialize)]
2021-12-10 02:15:24 +00:00
pub struct VpcRouterUpdate {
#[serde(default, skip_serializing_if = "Option::is_none")]
pub description: Option<String>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub name: Option<Name>,
}
2023-02-05 01:22:55 +00:00
impl From<&VpcRouterUpdate> for VpcRouterUpdate {
fn from(value: &VpcRouterUpdate) -> Self {
value.clone()
}
}
2022-07-03 02:09:38 +00:00
///A VPC subnet represents a logical grouping for instances that allows
/// network traffic between them, within a IPv4 subnetwork or optionall an
/// IPv6 subnetwork.
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "A VPC subnet represents a logical grouping for
/// instances that allows network traffic between them, within a IPv4
/// subnetwork or optionall an IPv6 subnetwork.", "type": "object",
/// "required": [
/// "description",
/// "id",
/// "ipv4_block",
/// "ipv6_block",
/// "name",
/// "time_created",
/// "time_modified",
/// "vpc_id"
/// ],
/// "properties": {
/// "description": {
/// "description": "human-readable free-form text about a resource",
/// "type": "string"
/// },
/// "id": {
/// "description": "unique, immutable, system-controlled identifier for
/// each resource", "type": "string",
/// "format": "uuid"
/// },
/// "ipv4_block": {
/// "description": "The IPv4 subnet CIDR block.",
/// "allOf": [
/// {
/// "$ref": "#/components/schemas/Ipv4Net"
/// }
/// ]
/// },
/// "ipv6_block": {
/// "description": "The IPv6 subnet CIDR block.",
/// "allOf": [
/// {
/// "$ref": "#/components/schemas/Ipv6Net"
/// }
/// ]
/// },
/// "name": {
/// "description": "unique, mutable, user-controlled identifier for
/// each resource", "allOf": [
/// {
/// "$ref": "#/components/schemas/Name"
/// }
/// ]
/// },
/// "time_created": {
/// "description": "timestamp when this resource was created",
/// "type": "string",
/// "format": "date-time"
/// },
/// "time_modified": {
/// "description": "timestamp when this resource was last modified",
/// "type": "string",
/// "format": "date-time"
/// },
/// "vpc_id": {
/// "description": "The VPC to which the subnet belongs.",
/// "type": "string",
/// "format": "uuid"
/// }
/// }
///}
/// ```
/// </details>
2022-07-12 17:57:06 +00:00
#[derive(Clone, Debug, Deserialize, Serialize)]
2021-12-10 02:15:24 +00:00
pub struct VpcSubnet {
2022-07-03 02:09:38 +00:00
///human-readable free-form text about a resource
2022-02-08 16:59:38 +00:00
pub description: String,
2022-07-03 02:09:38 +00:00
///unique, immutable, system-controlled identifier for each resource
2022-02-08 16:59:38 +00:00
pub id: uuid::Uuid,
2022-07-03 02:09:38 +00:00
///The IPv4 subnet CIDR block.
2022-05-10 00:30:08 +00:00
pub ipv4_block: Ipv4Net,
2022-07-03 02:09:38 +00:00
///The IPv6 subnet CIDR block.
2022-05-10 00:30:08 +00:00
pub ipv6_block: Ipv6Net,
2022-07-03 02:09:38 +00:00
///unique, mutable, user-controlled identifier for each resource
2022-02-08 16:59:38 +00:00
pub name: Name,
2022-07-03 02:09:38 +00:00
///timestamp when this resource was created
2022-02-08 16:59:38 +00:00
pub time_created: chrono::DateTime<chrono::offset::Utc>,
2022-07-03 02:09:38 +00:00
///timestamp when this resource was last modified
2022-02-08 16:59:38 +00:00
pub time_modified: chrono::DateTime<chrono::offset::Utc>,
2022-07-03 02:09:38 +00:00
///The VPC to which the subnet belongs.
2021-12-10 02:15:24 +00:00
pub vpc_id: uuid::Uuid,
}
2023-02-05 01:22:55 +00:00
impl From<&VpcSubnet> for VpcSubnet {
fn from(value: &VpcSubnet) -> Self {
value.clone()
}
}
2022-07-03 02:09:38 +00:00
///Create-time parameters for a
/// [`VpcSubnet`](crate::external_api::views::VpcSubnet)
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "Create-time parameters for a
/// [`VpcSubnet`](crate::external_api::views::VpcSubnet)",
/// "type": "object",
/// "required": [
/// "description",
/// "ipv4_block",
/// "name"
/// ],
/// "properties": {
/// "description": {
/// "type": "string"
/// },
/// "ipv4_block": {
/// "description": "The IPv4 address range for this subnet.\n\nIt must
/// be allocated from an RFC 1918 private address range, and must not
/// overlap with any other existing subnet in the VPC.", "allOf": [
/// {
/// "$ref": "#/components/schemas/Ipv4Net"
/// }
/// ]
/// },
/// "ipv6_block": {
/// "description": "The IPv6 address range for this subnet.\n\nIt must
/// be allocated from the RFC 4193 Unique Local Address range, with the
/// prefix equal to the parent VPC's prefix. A random `/64` block will be
/// assigned if one is not provided. It must not overlap with any existing
/// subnet in the VPC.", "allOf": [
/// {
/// "$ref": "#/components/schemas/Ipv6Net"
/// }
/// ]
/// },
/// "name": {
/// "$ref": "#/components/schemas/Name"
/// }
/// }
///}
/// ```
/// </details>
2022-07-12 17:57:06 +00:00
#[derive(Clone, Debug, Deserialize, Serialize)]
2021-12-10 02:15:24 +00:00
pub struct VpcSubnetCreate {
pub description: String,
2022-07-03 02:09:38 +00:00
///The IPv4 address range for this subnet.
///
///It must be allocated from an RFC 1918 private address range, and
/// must not overlap with any other existing subnet in the VPC.
2022-05-10 00:30:08 +00:00
pub ipv4_block: Ipv4Net,
2022-07-03 02:09:38 +00:00
///The IPv6 address range for this subnet.
///
///It must be allocated from the RFC 4193 Unique Local Address range,
/// with the prefix equal to the parent VPC's prefix. A random `/64`
/// block will be assigned if one is not provided. It must not overlap
/// with any existing subnet in the VPC.
2022-05-10 00:30:08 +00:00
#[serde(default, skip_serializing_if = "Option::is_none")]
pub ipv6_block: Option<Ipv6Net>,
2021-12-10 02:15:24 +00:00
pub name: Name,
}
2023-02-05 01:22:55 +00:00
impl From<&VpcSubnetCreate> for VpcSubnetCreate {
fn from(value: &VpcSubnetCreate) -> Self {
value.clone()
}
}
2022-07-03 02:09:38 +00:00
///A single page of results
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "A single page of results",
/// "type": "object",
/// "required": [
/// "items"
/// ],
/// "properties": {
/// "items": {
/// "description": "list of items on this page of results",
/// "type": "array",
/// "items": {
/// "$ref": "#/components/schemas/VpcSubnet"
/// }
/// },
/// "next_page": {
/// "description": "token used to fetch the next page of results (if
/// any)", "type": [
/// "string",
/// "null"
/// ]
/// }
/// }
///}
/// ```
/// </details>
2022-07-12 17:57:06 +00:00
#[derive(Clone, Debug, Deserialize, Serialize)]
2021-12-10 02:15:24 +00:00
pub struct VpcSubnetResultsPage {
2022-07-03 02:09:38 +00:00
///list of items on this page of results
2021-12-10 02:15:24 +00:00
pub items: Vec<VpcSubnet>,
2022-07-03 02:09:38 +00:00
///token used to fetch the next page of results (if any)
2021-12-10 02:15:24 +00:00
#[serde(default, skip_serializing_if = "Option::is_none")]
pub next_page: Option<String>,
}
2023-02-05 01:22:55 +00:00
impl From<&VpcSubnetResultsPage> for VpcSubnetResultsPage {
fn from(value: &VpcSubnetResultsPage) -> Self {
value.clone()
}
}
2022-07-03 02:09:38 +00:00
///Updateable properties of a
/// [`VpcSubnet`](crate::external_api::views::VpcSubnet)
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "Updateable properties of a
/// [`VpcSubnet`](crate::external_api::views::VpcSubnet)",
/// "type": "object",
/// "properties": {
/// "description": {
/// "type": [
/// "string",
/// "null"
/// ]
/// },
/// "name": {
/// "allOf": [
/// {
/// "$ref": "#/components/schemas/Name"
/// }
/// ]
/// }
/// }
///}
/// ```
/// </details>
2022-07-12 17:57:06 +00:00
#[derive(Clone, Debug, Deserialize, Serialize)]
2021-12-10 02:15:24 +00:00
pub struct VpcSubnetUpdate {
#[serde(default, skip_serializing_if = "Option::is_none")]
pub description: Option<String>,
2022-05-10 00:30:08 +00:00
#[serde(default, skip_serializing_if = "Option::is_none")]
2021-12-10 02:15:24 +00:00
pub name: Option<Name>,
}
2023-02-05 01:22:55 +00:00
impl From<&VpcSubnetUpdate> for VpcSubnetUpdate {
fn from(value: &VpcSubnetUpdate) -> Self {
value.clone()
}
}
2022-07-03 02:09:38 +00:00
///Updateable properties of a [`Vpc`](crate::external_api::views::Vpc)
2023-12-13 09:14:28 +00:00
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "Updateable properties of a
/// [`Vpc`](crate::external_api::views::Vpc)", "type": "object",
/// "properties": {
/// "description": {
/// "type": [
/// "string",
/// "null"
/// ]
/// },
/// "dns_name": {
/// "allOf": [
/// {
/// "$ref": "#/components/schemas/Name"
/// }
/// ]
/// },
/// "name": {
/// "allOf": [
/// {
/// "$ref": "#/components/schemas/Name"
/// }
/// ]
/// }
/// }
///}
/// ```
/// </details>
2022-07-12 17:57:06 +00:00
#[derive(Clone, Debug, Deserialize, Serialize)]
2021-12-10 02:15:24 +00:00
pub struct VpcUpdate {
#[serde(default, skip_serializing_if = "Option::is_none")]
pub description: Option<String>,
2022-02-08 16:59:38 +00:00
#[serde(default, skip_serializing_if = "Option::is_none")]
2021-12-10 02:15:24 +00:00
pub dns_name: Option<Name>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub name: Option<Name>,
}
2022-08-18 18:58:55 +00:00
2023-02-05 01:22:55 +00:00
impl From<&VpcUpdate> for VpcUpdate {
fn from(value: &VpcUpdate) -> Self {
value.clone()
}
}
2023-03-24 01:11:44 +00:00
pub mod defaults {
2023-02-01 05:28:12 +00:00
pub(super) fn default_bool<const V: bool>() -> bool {
V
}
2022-08-18 18:58:55 +00:00
pub(super) fn instance_create_network_interfaces(
) -> super::InstanceNetworkInterfaceAttachment {
super::InstanceNetworkInterfaceAttachment::Default
}
}
2021-12-10 02:15:24 +00:00
}
2022-08-03 01:18:43 +00:00
#[derive(Clone, Debug)]
2023-01-08 02:05:33 +00:00
///Client for Oxide Region API
///
///API for interacting with the Oxide control plane
2023-03-30 06:02:17 +00:00
///
///Version: 0.0.1
2021-12-10 02:15:24 +00:00
pub struct Client {
2022-07-03 02:09:38 +00:00
pub(crate) baseurl: String,
pub(crate) client: reqwest::Client,
2021-12-10 02:15:24 +00:00
}
impl Client {
2023-01-08 02:05:33 +00:00
/// Create a new client.
///
/// `baseurl` is the base URL provided to the internal
/// `reqwest::Client`, and should include a scheme and hostname,
/// as well as port and a path stem if applicable.
2021-12-10 02:15:24 +00:00
pub fn new(baseurl: &str) -> Self {
2023-04-26 04:50:04 +00:00
#[cfg(not(target_arch = "wasm32"))]
let client = {
let dur = std::time::Duration::from_secs(15);
reqwest::ClientBuilder::new()
.connect_timeout(dur)
.timeout(dur)
};
#[cfg(target_arch = "wasm32")]
let client = reqwest::ClientBuilder::new();
Self::new_with_client(baseurl, client.build().unwrap())
2021-12-10 02:15:24 +00:00
}
2023-01-08 02:05:33 +00:00
/// Construct a new client with an existing `reqwest::Client`,
/// allowing more control over its configuration.
///
/// `baseurl` is the base URL provided to the internal
/// `reqwest::Client`, and should include a scheme and hostname,
/// as well as port and a path stem if applicable.
2021-12-10 02:15:24 +00:00
pub fn new_with_client(baseurl: &str, client: reqwest::Client) -> Self {
Self {
baseurl: baseurl.to_string(),
client,
}
}
2023-03-30 06:02:17 +00:00
/// Get the base URL to which requests are made.
2021-12-10 02:15:24 +00:00
pub fn baseurl(&self) -> &String {
&self.baseurl
}
2023-03-30 06:02:17 +00:00
/// Get the internal `reqwest::Client` used to make requests.
2021-12-10 02:15:24 +00:00
pub fn client(&self) -> &reqwest::Client {
&self.client
}
2023-03-30 06:02:17 +00:00
/// Get the version of this API.
///
/// This string is pulled directly from the source OpenAPI
/// document and may be in any format the API selects.
pub fn api_version(&self) -> &'static str {
"0.0.1"
}
2022-07-03 02:09:38 +00:00
}
2021-12-10 02:15:24 +00:00
2022-07-03 02:09:38 +00:00
impl Client {
2023-02-01 05:28:12 +00:00
///Fetch a disk by id
///
///Use `GET /v1/disks/{disk}` instead
2022-07-15 03:59:36 +00:00
///
///Sends a `GET` request to `/by-id/disks/{id}`
pub async fn disk_view_by_id<'a>(
&'a self,
id: &'a uuid::Uuid,
) -> Result<ResponseValue<types::Disk>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!(
2022-07-15 03:59:36 +00:00
"{}/by-id/disks/{}",
self.baseurl,
encode_path(&id.to_string()),
);
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.get(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
200u16 => ResponseValue::from_response(response).await,
2022-07-15 03:59:36 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-07-15 03:59:36 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-07-15 03:59:36 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2022-07-15 03:59:36 +00:00
}
}
///Fetch an image by id
///
///Sends a `GET` request to `/by-id/images/{id}`
pub async fn image_view_by_id<'a>(
&'a self,
id: &'a uuid::Uuid,
) -> Result<ResponseValue<types::Image>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!(
2022-07-15 03:59:36 +00:00
"{}/by-id/images/{}",
self.baseurl,
encode_path(&id.to_string()),
);
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.get(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
200u16 => ResponseValue::from_response(response).await,
2022-07-15 03:59:36 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-07-15 03:59:36 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-07-15 03:59:36 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2022-07-15 03:59:36 +00:00
}
}
2023-02-01 05:28:12 +00:00
///Fetch an instance by id
2022-07-15 03:59:36 +00:00
///
///Sends a `GET` request to `/by-id/instances/{id}`
pub async fn instance_view_by_id<'a>(
&'a self,
id: &'a uuid::Uuid,
) -> Result<ResponseValue<types::Instance>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!(
2022-07-15 03:59:36 +00:00
"{}/by-id/instances/{}",
self.baseurl,
encode_path(&id.to_string()),
);
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.get(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
200u16 => ResponseValue::from_response(response).await,
2022-07-15 03:59:36 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-07-15 03:59:36 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-07-15 03:59:36 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2022-07-15 03:59:36 +00:00
}
}
2023-02-01 05:28:12 +00:00
///Fetch a network interface by id
2022-07-15 03:59:36 +00:00
///
///Sends a `GET` request to `/by-id/network-interfaces/{id}`
pub async fn instance_network_interface_view_by_id<'a>(
&'a self,
id: &'a uuid::Uuid,
) -> Result<ResponseValue<types::NetworkInterface>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!(
2022-07-15 03:59:36 +00:00
"{}/by-id/network-interfaces/{}",
self.baseurl,
encode_path(&id.to_string()),
);
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.get(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
200u16 => ResponseValue::from_response(response).await,
2022-07-15 03:59:36 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-07-15 03:59:36 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-07-15 03:59:36 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2022-07-15 03:59:36 +00:00
}
}
2023-02-01 05:28:12 +00:00
///Fetch an organization by id
///
///Use `GET /v1/organizations/{organization}` instead
2022-07-15 03:59:36 +00:00
///
///Sends a `GET` request to `/by-id/organizations/{id}`
pub async fn organization_view_by_id<'a>(
&'a self,
id: &'a uuid::Uuid,
) -> Result<ResponseValue<types::Organization>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!(
2022-07-15 03:59:36 +00:00
"{}/by-id/organizations/{}",
self.baseurl,
encode_path(&id.to_string()),
);
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.get(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
200u16 => ResponseValue::from_response(response).await,
2022-07-15 03:59:36 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-07-15 03:59:36 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-07-15 03:59:36 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2022-07-15 03:59:36 +00:00
}
}
2023-02-01 05:28:12 +00:00
///Fetch a project by id
///
///Use `GET /v1/projects/{project}` instead
2022-07-15 03:59:36 +00:00
///
///Sends a `GET` request to `/by-id/projects/{id}`
pub async fn project_view_by_id<'a>(
&'a self,
id: &'a uuid::Uuid,
) -> Result<ResponseValue<types::Project>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!(
2022-07-15 03:59:36 +00:00
"{}/by-id/projects/{}",
self.baseurl,
encode_path(&id.to_string()),
);
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.get(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
200u16 => ResponseValue::from_response(response).await,
2022-07-15 03:59:36 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-07-15 03:59:36 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-07-15 03:59:36 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2022-07-15 03:59:36 +00:00
}
}
2023-02-01 05:28:12 +00:00
///Fetch a snapshot by id
2022-07-15 03:59:36 +00:00
///
///Sends a `GET` request to `/by-id/snapshots/{id}`
pub async fn snapshot_view_by_id<'a>(
&'a self,
id: &'a uuid::Uuid,
) -> Result<ResponseValue<types::Snapshot>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!(
2022-07-15 03:59:36 +00:00
"{}/by-id/snapshots/{}",
self.baseurl,
encode_path(&id.to_string()),
);
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.get(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
200u16 => ResponseValue::from_response(response).await,
2022-07-15 03:59:36 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-07-15 03:59:36 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-07-15 03:59:36 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2022-07-15 03:59:36 +00:00
}
}
2023-02-01 05:28:12 +00:00
///Fetch a route by id
2022-07-15 03:59:36 +00:00
///
///Sends a `GET` request to `/by-id/vpc-router-routes/{id}`
pub async fn vpc_router_route_view_by_id<'a>(
&'a self,
id: &'a uuid::Uuid,
) -> Result<ResponseValue<types::RouterRoute>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!(
2022-07-15 03:59:36 +00:00
"{}/by-id/vpc-router-routes/{}",
self.baseurl,
encode_path(&id.to_string()),
);
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.get(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
200u16 => ResponseValue::from_response(response).await,
2022-07-15 03:59:36 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-07-15 03:59:36 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-07-15 03:59:36 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2022-07-15 03:59:36 +00:00
}
}
2023-02-01 05:28:12 +00:00
///Get a router by id
2022-07-15 03:59:36 +00:00
///
///Sends a `GET` request to `/by-id/vpc-routers/{id}`
pub async fn vpc_router_view_by_id<'a>(
&'a self,
id: &'a uuid::Uuid,
) -> Result<ResponseValue<types::VpcRouter>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!(
2022-07-15 03:59:36 +00:00
"{}/by-id/vpc-routers/{}",
self.baseurl,
encode_path(&id.to_string()),
);
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.get(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
200u16 => ResponseValue::from_response(response).await,
2022-07-15 03:59:36 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-07-15 03:59:36 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-07-15 03:59:36 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2022-07-15 03:59:36 +00:00
}
}
2023-02-01 05:28:12 +00:00
///Fetch a subnet by id
2022-07-15 03:59:36 +00:00
///
///Sends a `GET` request to `/by-id/vpc-subnets/{id}`
pub async fn vpc_subnet_view_by_id<'a>(
&'a self,
id: &'a uuid::Uuid,
) -> Result<ResponseValue<types::VpcSubnet>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!(
2022-07-15 03:59:36 +00:00
"{}/by-id/vpc-subnets/{}",
self.baseurl,
encode_path(&id.to_string()),
);
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.get(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
200u16 => ResponseValue::from_response(response).await,
2022-07-15 03:59:36 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-07-15 03:59:36 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-07-15 03:59:36 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2022-07-15 03:59:36 +00:00
}
}
2023-02-01 05:28:12 +00:00
///Fetch a VPC
2022-07-15 03:59:36 +00:00
///
///Sends a `GET` request to `/by-id/vpcs/{id}`
pub async fn vpc_view_by_id<'a>(
&'a self,
id: &'a uuid::Uuid,
) -> Result<ResponseValue<types::Vpc>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!(
2022-07-15 03:59:36 +00:00
"{}/by-id/vpcs/{}",
self.baseurl,
encode_path(&id.to_string()),
);
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.get(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
200u16 => ResponseValue::from_response(response).await,
2022-07-15 03:59:36 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-07-15 03:59:36 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-07-15 03:59:36 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2022-07-15 03:59:36 +00:00
}
}
2022-07-08 01:35:36 +00:00
///Start an OAuth 2.0 Device Authorization Grant
///
///This endpoint is designed to be accessed from an *unauthenticated* API
/// client. It generates and records a `device_code` and `user_code` which
/// must be verified and confirmed prior to a token being granted.
///
///Sends a `POST` request to `/device/auth`
pub async fn device_auth_request<'a>(
&'a self,
body: &'a types::DeviceAuthRequest,
) -> Result<ResponseValue<ByteStream>, Error<ByteStream>> {
2023-10-16 18:44:24 +00:00
let url = format!("{}/device/auth", self.baseurl,);
let request = self.client.post(url).form_urlencoded(&body)?.build()?;
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
200..=299 => Ok(ResponseValue::stream(response)),
_ => Err(Error::ErrorResponse(ResponseValue::stream(response))),
2022-07-08 01:35:36 +00:00
}
}
///Confirm an OAuth 2.0 Device Authorization Grant
///
///This endpoint is designed to be accessed by the user agent (browser),
/// not the client requesting the token. So we do not actually return the
/// token here; it will be returned in response to the poll on
/// `/device/token`.
///
///Sends a `POST` request to `/device/confirm`
pub async fn device_auth_confirm<'a>(
&'a self,
body: &'a types::DeviceAuthVerify,
2022-07-15 03:59:36 +00:00
) -> Result<ResponseValue<()>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!("{}/device/confirm", self.baseurl,);
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.post(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
.json(&body)
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
204u16 => Ok(ResponseValue::empty(response)),
2022-07-08 01:35:36 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-07-08 01:35:36 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-07-08 01:35:36 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2022-07-08 01:35:36 +00:00
}
}
///Request a device access token
///
///This endpoint should be polled by the client until the user code is
/// verified and the grant is confirmed.
///
///Sends a `POST` request to `/device/token`
pub async fn device_access_token<'a>(
&'a self,
body: &'a types::DeviceAccessTokenRequest,
) -> Result<ResponseValue<ByteStream>, Error<ByteStream>> {
2023-10-16 18:44:24 +00:00
let url = format!("{}/device/token", self.baseurl,);
let request = self.client.post(url).form_urlencoded(&body)?.build()?;
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
200..=299 => Ok(ResponseValue::stream(response)),
_ => Err(Error::ErrorResponse(ResponseValue::stream(response))),
2022-07-08 01:35:36 +00:00
}
}
2023-02-01 05:28:12 +00:00
///List groups
2022-07-03 02:09:38 +00:00
///
2023-02-01 05:28:12 +00:00
///Sends a `GET` request to `/groups`
2022-07-03 02:09:38 +00:00
///
///Arguments:
/// - `limit`: Maximum number of items returned by a single call
2022-07-08 01:35:36 +00:00
/// - `page_token`: Token returned by previous call to retrieve the
2022-07-03 02:09:38 +00:00
/// subsequent page
/// - `sort_by`
2023-02-01 05:28:12 +00:00
pub async fn group_list<'a>(
2022-01-05 20:02:46 +00:00
&'a self,
2021-12-10 02:15:24 +00:00
limit: Option<std::num::NonZeroU32>,
2022-01-05 20:02:46 +00:00
page_token: Option<&'a str>,
2021-12-10 02:15:24 +00:00
sort_by: Option<types::IdSortMode>,
2023-02-01 05:28:12 +00:00
) -> Result<ResponseValue<types::GroupResultsPage>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!("{}/groups", self.baseurl,);
let mut query = Vec::with_capacity(3usize);
2021-12-10 02:15:24 +00:00
if let Some(v) = &limit {
2023-10-16 18:44:24 +00:00
query.push(("limit", v.to_string()));
2021-12-10 02:15:24 +00:00
}
if let Some(v) = &page_token {
2023-10-16 18:44:24 +00:00
query.push(("page_token", v.to_string()));
2021-12-10 02:15:24 +00:00
}
if let Some(v) = &sort_by {
2023-10-16 18:44:24 +00:00
query.push(("sort_by", v.to_string()));
2021-12-10 02:15:24 +00:00
}
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.get(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
2023-10-16 18:44:24 +00:00
.query(&query)
2023-04-25 00:42:22 +00:00
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
200u16 => ResponseValue::from_response(response).await,
2022-02-08 16:59:38 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-02-08 16:59:38 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-02-08 16:59:38 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2022-02-08 16:59:38 +00:00
}
2021-12-10 02:15:24 +00:00
}
2023-02-01 05:28:12 +00:00
///List groups as a Stream
2022-07-03 02:09:38 +00:00
///
2023-02-01 05:28:12 +00:00
///Sends repeated `GET` requests to `/groups` until there are no more
/// results.
2022-07-03 02:09:38 +00:00
///
///Arguments:
/// - `limit`: Maximum number of items returned by a single call
/// - `sort_by`
2023-02-01 05:28:12 +00:00
pub fn group_list_stream<'a>(
2022-01-05 20:02:46 +00:00
&'a self,
limit: Option<std::num::NonZeroU32>,
sort_by: Option<types::IdSortMode>,
2023-02-01 05:28:12 +00:00
) -> impl futures::Stream<Item = Result<types::Group, Error<types::Error>>> + Unpin + '_ {
2022-01-05 20:02:46 +00:00
use futures::StreamExt;
use futures::TryFutureExt;
use futures::TryStreamExt;
2023-05-04 03:53:28 +00:00
let final_stream_limit = limit
.clone()
.and_then(|x| std::num::NonZeroUsize::try_from(x).ok())
.map(std::num::NonZeroUsize::get)
.unwrap_or(usize::MAX);
2023-02-01 05:28:12 +00:00
self.group_list(limit, None, sort_by)
2022-01-05 20:02:46 +00:00
.map_ok(move |page| {
2022-02-08 16:59:38 +00:00
let page = page.into_inner();
2023-05-08 03:43:45 +00:00
let first = futures::stream::iter(page.items).map(Ok);
2022-01-05 20:02:46 +00:00
let rest = futures::stream::try_unfold(page.next_page, move |state| async move {
if state.is_none() {
Ok(None)
} else {
2023-02-01 05:28:12 +00:00
self.group_list(None, state.as_deref(), None)
2022-01-05 20:02:46 +00:00
.map_ok(|page| {
2022-02-08 16:59:38 +00:00
let page = page.into_inner();
2023-05-08 03:43:45 +00:00
Some((futures::stream::iter(page.items).map(Ok), page.next_page))
2022-01-05 20:02:46 +00:00
})
.await
}
})
.try_flatten();
first.chain(rest)
})
.try_flatten_stream()
2023-05-04 03:53:28 +00:00
.take(final_stream_limit)
2022-01-05 20:02:46 +00:00
.boxed()
}
2023-02-01 05:28:12 +00:00
///Sends a `POST` request to `/login`
pub async fn login_spoof<'a>(
&'a self,
body: &'a types::SpoofLoginBody,
) -> Result<ResponseValue<()>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!("{}/login", self.baseurl,);
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.post(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
.json(&body)
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
204u16 => Ok(ResponseValue::empty(response)),
2023-02-01 05:28:12 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2023-02-01 05:28:12 +00:00
}
}
///Authenticate a user (i.e., log in) via username and password
2022-07-03 02:09:38 +00:00
///
2023-02-01 05:28:12 +00:00
///Sends a `POST` request to `/login/{silo_name}/local`
pub async fn login_local<'a>(
2022-01-05 20:02:46 +00:00
&'a self,
2023-02-01 05:28:12 +00:00
silo_name: &'a types::Name,
body: &'a types::UsernamePasswordCredentials,
) -> Result<ResponseValue<ByteStream>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!(
2023-02-01 05:28:12 +00:00
"{}/login/{}/local",
2021-12-10 02:15:24 +00:00
self.baseurl,
2023-02-01 05:28:12 +00:00
encode_path(&silo_name.to_string()),
2021-12-10 02:15:24 +00:00
);
2023-10-16 18:44:24 +00:00
let request = self.client.post(url).json(&body).build()?;
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
200..=299 => Ok(ResponseValue::stream(response)),
2022-02-08 16:59:38 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-02-08 16:59:38 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-02-08 16:59:38 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2022-02-08 16:59:38 +00:00
}
2021-12-10 02:15:24 +00:00
}
2023-02-01 05:28:12 +00:00
///Prompt user login
2022-07-03 02:09:38 +00:00
///
2023-02-01 05:28:12 +00:00
///Either display a page asking a user for their credentials, or redirect
/// them to their identity provider.
2022-07-03 02:09:38 +00:00
///
2023-02-01 05:28:12 +00:00
///Sends a `GET` request to `/login/{silo_name}/saml/{provider_name}`
pub async fn login_saml_begin<'a>(
2022-01-05 20:02:46 +00:00
&'a self,
2023-02-01 05:28:12 +00:00
silo_name: &'a types::Name,
provider_name: &'a types::Name,
) -> Result<ResponseValue<ByteStream>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!(
2023-02-01 05:28:12 +00:00
"{}/login/{}/saml/{}",
self.baseurl,
encode_path(&silo_name.to_string()),
encode_path(&provider_name.to_string()),
);
2023-10-16 18:44:24 +00:00
let request = self.client.get(url).build()?;
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
200..=299 => Ok(ResponseValue::stream(response)),
2022-02-08 16:59:38 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-02-08 16:59:38 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-02-08 16:59:38 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2022-02-08 16:59:38 +00:00
}
2021-12-10 02:15:24 +00:00
}
2023-02-01 05:28:12 +00:00
///Authenticate a user (i.e., log in) via SAML
2022-07-03 02:09:38 +00:00
///
2023-02-01 05:28:12 +00:00
///Sends a `POST` request to `/login/{silo_name}/saml/{provider_name}`
pub async fn login_saml<'a, B: Into<reqwest::Body>>(
2022-01-05 20:02:46 +00:00
&'a self,
2023-02-01 05:28:12 +00:00
silo_name: &'a types::Name,
provider_name: &'a types::Name,
body: B,
) -> Result<ResponseValue<ByteStream>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!(
2023-02-01 05:28:12 +00:00
"{}/login/{}/saml/{}",
2021-12-10 02:15:24 +00:00
self.baseurl,
2023-02-01 05:28:12 +00:00
encode_path(&silo_name.to_string()),
encode_path(&provider_name.to_string()),
2021-12-10 02:15:24 +00:00
);
2023-10-16 18:44:24 +00:00
let request = self
2023-02-01 05:28:12 +00:00
.client
2023-10-16 18:44:24 +00:00
.post(url)
2023-02-01 05:28:12 +00:00
.header(
reqwest::header::CONTENT_TYPE,
reqwest::header::HeaderValue::from_static("application/octet-stream"),
)
.body(body)
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
200..=299 => Ok(ResponseValue::stream(response)),
2023-02-01 05:28:12 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2023-02-01 05:28:12 +00:00
}
}
///Sends a `POST` request to `/logout`
pub async fn logout<'a>(&'a self) -> Result<ResponseValue<()>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!("{}/logout", self.baseurl,);
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.post(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
204u16 => Ok(ResponseValue::empty(response)),
2022-02-08 16:59:38 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-02-08 16:59:38 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-02-08 16:59:38 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2022-02-08 16:59:38 +00:00
}
2021-12-10 02:15:24 +00:00
}
2023-02-01 05:28:12 +00:00
///List organizations
2022-07-03 02:09:38 +00:00
///
2023-02-01 05:28:12 +00:00
///Use `GET /v1/organizations` instead
2022-07-03 02:09:38 +00:00
///
2023-02-01 05:28:12 +00:00
///Sends a `GET` request to `/organizations`
2022-07-03 02:09:38 +00:00
///
///Arguments:
/// - `limit`: Maximum number of items returned by a single call
2022-07-08 01:35:36 +00:00
/// - `page_token`: Token returned by previous call to retrieve the
2022-07-03 02:09:38 +00:00
/// subsequent page
/// - `sort_by`
2023-02-01 05:28:12 +00:00
pub async fn organization_list<'a>(
2022-01-05 20:02:46 +00:00
&'a self,
2022-05-23 15:49:37 +00:00
limit: Option<std::num::NonZeroU32>,
page_token: Option<&'a str>,
2023-02-01 05:28:12 +00:00
sort_by: Option<types::NameOrIdSortMode>,
) -> Result<ResponseValue<types::OrganizationResultsPage>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!("{}/organizations", self.baseurl,);
let mut query = Vec::with_capacity(3usize);
2022-05-23 15:49:37 +00:00
if let Some(v) = &limit {
2023-10-16 18:44:24 +00:00
query.push(("limit", v.to_string()));
2022-05-23 15:49:37 +00:00
}
if let Some(v) = &page_token {
2023-10-16 18:44:24 +00:00
query.push(("page_token", v.to_string()));
2022-05-23 15:49:37 +00:00
}
if let Some(v) = &sort_by {
2023-10-16 18:44:24 +00:00
query.push(("sort_by", v.to_string()));
2022-05-23 15:49:37 +00:00
}
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.get(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
2023-10-16 18:44:24 +00:00
.query(&query)
2023-04-25 00:42:22 +00:00
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
200u16 => ResponseValue::from_response(response).await,
2022-05-23 15:49:37 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-05-23 15:49:37 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-05-23 15:49:37 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2022-05-23 15:49:37 +00:00
}
}
2023-02-01 05:28:12 +00:00
///List organizations as a Stream
2022-07-03 02:09:38 +00:00
///
2023-02-01 05:28:12 +00:00
///Use `GET /v1/organizations` instead
2022-07-03 02:09:38 +00:00
///
2023-02-01 05:28:12 +00:00
///Sends repeated `GET` requests to `/organizations` until there are no
/// more results.
2022-07-03 02:09:38 +00:00
///
///Arguments:
/// - `limit`: Maximum number of items returned by a single call
/// - `sort_by`
2023-02-01 05:28:12 +00:00
pub fn organization_list_stream<'a>(
2022-05-23 15:49:37 +00:00
&'a self,
limit: Option<std::num::NonZeroU32>,
2023-02-01 05:28:12 +00:00
sort_by: Option<types::NameOrIdSortMode>,
) -> impl futures::Stream<Item = Result<types::Organization, Error<types::Error>>> + Unpin + '_
2022-05-23 15:49:37 +00:00
{
use futures::StreamExt;
use futures::TryFutureExt;
use futures::TryStreamExt;
2023-05-04 03:53:28 +00:00
let final_stream_limit = limit
.clone()
.and_then(|x| std::num::NonZeroUsize::try_from(x).ok())
.map(std::num::NonZeroUsize::get)
.unwrap_or(usize::MAX);
2023-02-01 05:28:12 +00:00
self.organization_list(limit, None, sort_by)
2022-05-23 15:49:37 +00:00
.map_ok(move |page| {
let page = page.into_inner();
2023-05-08 03:43:45 +00:00
let first = futures::stream::iter(page.items).map(Ok);
2022-05-23 15:49:37 +00:00
let rest = futures::stream::try_unfold(page.next_page, move |state| async move {
if state.is_none() {
Ok(None)
} else {
2023-02-01 05:28:12 +00:00
self.organization_list(None, state.as_deref(), None)
2022-05-23 15:49:37 +00:00
.map_ok(|page| {
let page = page.into_inner();
2023-05-08 03:43:45 +00:00
Some((futures::stream::iter(page.items).map(Ok), page.next_page))
2022-05-23 15:49:37 +00:00
})
.await
}
})
.try_flatten();
first.chain(rest)
})
.try_flatten_stream()
2023-05-04 03:53:28 +00:00
.take(final_stream_limit)
2022-05-23 15:49:37 +00:00
.boxed()
}
2023-02-01 05:28:12 +00:00
///Create an organization
2022-07-03 02:09:38 +00:00
///
2023-02-01 05:28:12 +00:00
///Use `POST /v1/organizations` instead
2022-07-03 02:09:38 +00:00
///
2023-02-01 05:28:12 +00:00
///Sends a `POST` request to `/organizations`
pub async fn organization_create<'a>(
2022-05-23 15:49:37 +00:00
&'a self,
2023-02-01 05:28:12 +00:00
body: &'a types::OrganizationCreate,
) -> Result<ResponseValue<types::Organization>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!("{}/organizations", self.baseurl,);
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.post(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
.json(&body)
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
201u16 => ResponseValue::from_response(response).await,
2022-05-23 15:49:37 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-05-23 15:49:37 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-05-23 15:49:37 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2022-05-23 15:49:37 +00:00
}
}
2023-02-01 05:28:12 +00:00
///Fetch an organization
2022-07-03 02:09:38 +00:00
///
2023-02-01 05:28:12 +00:00
///Use `GET /v1/organizations/{organization}` instead
///
///Sends a `GET` request to `/organizations/{organization_name}`
2022-07-03 02:09:38 +00:00
///
2023-02-01 05:28:12 +00:00
///Arguments:
/// - `organization_name`: The organization's unique name.
pub async fn organization_view<'a>(
2022-05-23 15:49:37 +00:00
&'a self,
2023-02-01 05:28:12 +00:00
organization_name: &'a types::Name,
) -> Result<ResponseValue<types::Organization>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!(
2023-02-01 05:28:12 +00:00
"{}/organizations/{}",
2022-05-23 15:49:37 +00:00
self.baseurl,
2023-02-01 05:28:12 +00:00
encode_path(&organization_name.to_string()),
2022-05-23 15:49:37 +00:00
);
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.get(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
200u16 => ResponseValue::from_response(response).await,
2022-05-23 15:49:37 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-05-23 15:49:37 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-05-23 15:49:37 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2022-05-23 15:49:37 +00:00
}
}
2023-02-01 05:28:12 +00:00
///Update an organization
2022-07-03 02:09:38 +00:00
///
2023-02-01 05:28:12 +00:00
///Use `PUT /v1/organizations/{organization}` instead
///
///Sends a `PUT` request to `/organizations/{organization_name}`
2022-07-03 02:09:38 +00:00
///
2023-02-01 05:28:12 +00:00
///Arguments:
/// - `organization_name`: The organization's unique name.
/// - `body`
pub async fn organization_update<'a>(
2022-05-23 15:49:37 +00:00
&'a self,
2023-02-01 05:28:12 +00:00
organization_name: &'a types::Name,
body: &'a types::OrganizationUpdate,
) -> Result<ResponseValue<types::Organization>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!(
2023-02-01 05:28:12 +00:00
"{}/organizations/{}",
self.baseurl,
encode_path(&organization_name.to_string()),
);
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.put(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
.json(&body)
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
200u16 => ResponseValue::from_response(response).await,
2023-02-01 05:28:12 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2023-02-01 05:28:12 +00:00
}
}
///Delete an organization
///
///Use `DELETE /v1/organizations/{organization}` instead
///
///Sends a `DELETE` request to `/organizations/{organization_name}`
///
///Arguments:
/// - `organization_name`: The organization's unique name.
pub async fn organization_delete<'a>(
&'a self,
organization_name: &'a types::Name,
2022-05-23 15:49:37 +00:00
) -> Result<ResponseValue<()>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!(
2023-02-01 05:28:12 +00:00
"{}/organizations/{}",
2022-05-23 15:49:37 +00:00
self.baseurl,
2023-02-01 05:28:12 +00:00
encode_path(&organization_name.to_string()),
2022-05-23 15:49:37 +00:00
);
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.delete(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
204u16 => Ok(ResponseValue::empty(response)),
2022-05-23 15:49:37 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-05-23 15:49:37 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-05-23 15:49:37 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2022-05-23 15:49:37 +00:00
}
}
2023-02-01 05:28:12 +00:00
///Fetch an organization's IAM policy
///
///Use `GET /v1/organizations/{organization}/policy` instead
///
///Sends a `GET` request to `/organizations/{organization_name}/policy`
///
///Arguments:
/// - `organization_name`: The organization's unique name.
pub async fn organization_policy_view<'a>(
&'a self,
organization_name: &'a types::Name,
) -> Result<ResponseValue<types::OrganizationRolePolicy>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!(
2023-02-01 05:28:12 +00:00
"{}/organizations/{}/policy",
self.baseurl,
encode_path(&organization_name.to_string()),
);
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.get(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
200u16 => ResponseValue::from_response(response).await,
2023-02-01 05:28:12 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2023-02-01 05:28:12 +00:00
}
}
///Update an organization's IAM policy
///
///Use `PUT /v1/organizations/{organization}/policy` instead
///
///Sends a `PUT` request to `/organizations/{organization_name}/policy`
///
///Arguments:
/// - `organization_name`: The organization's unique name.
/// - `body`
pub async fn organization_policy_update<'a>(
&'a self,
organization_name: &'a types::Name,
body: &'a types::OrganizationRolePolicy,
) -> Result<ResponseValue<types::OrganizationRolePolicy>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!(
2023-02-01 05:28:12 +00:00
"{}/organizations/{}/policy",
self.baseurl,
encode_path(&organization_name.to_string()),
);
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.put(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
.json(&body)
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
200u16 => ResponseValue::from_response(response).await,
2023-02-01 05:28:12 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2023-02-01 05:28:12 +00:00
}
}
///List projects
2022-07-08 01:35:36 +00:00
///
2023-02-01 05:28:12 +00:00
///Use `GET /v1/projects` instead
///
///Sends a `GET` request to `/organizations/{organization_name}/projects`
2022-07-08 01:35:36 +00:00
///
///Arguments:
2023-02-01 05:28:12 +00:00
/// - `organization_name`: The organization's unique name.
2022-07-08 01:35:36 +00:00
/// - `limit`: Maximum number of items returned by a single call
/// - `page_token`: Token returned by previous call to retrieve the
/// subsequent page
/// - `sort_by`
2023-02-01 05:28:12 +00:00
pub async fn project_list<'a>(
2022-05-23 15:49:37 +00:00
&'a self,
2023-02-01 05:28:12 +00:00
organization_name: &'a types::Name,
2022-07-08 01:35:36 +00:00
limit: Option<std::num::NonZeroU32>,
page_token: Option<&'a str>,
sort_by: Option<types::NameOrIdSortMode>,
2023-02-01 05:28:12 +00:00
) -> Result<ResponseValue<types::ProjectResultsPage>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!(
2023-02-01 05:28:12 +00:00
"{}/organizations/{}/projects",
self.baseurl,
encode_path(&organization_name.to_string()),
);
2023-10-16 18:44:24 +00:00
let mut query = Vec::with_capacity(3usize);
2022-07-08 01:35:36 +00:00
if let Some(v) = &limit {
2023-10-16 18:44:24 +00:00
query.push(("limit", v.to_string()));
2022-07-08 01:35:36 +00:00
}
if let Some(v) = &page_token {
2023-10-16 18:44:24 +00:00
query.push(("page_token", v.to_string()));
2022-07-08 01:35:36 +00:00
}
if let Some(v) = &sort_by {
2023-10-16 18:44:24 +00:00
query.push(("sort_by", v.to_string()));
2022-07-08 01:35:36 +00:00
}
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.get(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
2023-10-16 18:44:24 +00:00
.query(&query)
2023-04-25 00:42:22 +00:00
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
200u16 => ResponseValue::from_response(response).await,
2022-07-08 01:35:36 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-07-08 01:35:36 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-07-08 01:35:36 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2022-07-08 01:35:36 +00:00
}
}
2023-02-01 05:28:12 +00:00
///List projects as a Stream
///
///Use `GET /v1/projects` instead
2022-07-08 01:35:36 +00:00
///
2023-02-01 05:28:12 +00:00
///Sends repeated `GET` requests to
/// `/organizations/{organization_name}/projects` until there are no more
2022-07-08 01:35:36 +00:00
/// results.
///
///Arguments:
2023-02-01 05:28:12 +00:00
/// - `organization_name`: The organization's unique name.
2022-07-08 01:35:36 +00:00
/// - `limit`: Maximum number of items returned by a single call
/// - `sort_by`
2023-02-01 05:28:12 +00:00
pub fn project_list_stream<'a>(
2022-07-08 01:35:36 +00:00
&'a self,
2023-02-01 05:28:12 +00:00
organization_name: &'a types::Name,
2022-07-08 01:35:36 +00:00
limit: Option<std::num::NonZeroU32>,
sort_by: Option<types::NameOrIdSortMode>,
2023-02-01 05:28:12 +00:00
) -> impl futures::Stream<Item = Result<types::Project, Error<types::Error>>> + Unpin + '_ {
2022-07-08 01:35:36 +00:00
use futures::StreamExt;
use futures::TryFutureExt;
use futures::TryStreamExt;
2023-05-04 03:53:28 +00:00
let final_stream_limit = limit
.clone()
.and_then(|x| std::num::NonZeroUsize::try_from(x).ok())
.map(std::num::NonZeroUsize::get)
.unwrap_or(usize::MAX);
2023-02-01 05:28:12 +00:00
self.project_list(organization_name, limit, None, sort_by)
2022-07-08 01:35:36 +00:00
.map_ok(move |page| {
let page = page.into_inner();
2023-05-08 03:43:45 +00:00
let first = futures::stream::iter(page.items).map(Ok);
2022-07-08 01:35:36 +00:00
let rest = futures::stream::try_unfold(page.next_page, move |state| async move {
if state.is_none() {
Ok(None)
} else {
2023-02-01 05:28:12 +00:00
self.project_list(organization_name, None, state.as_deref(), None)
2022-07-08 01:35:36 +00:00
.map_ok(|page| {
let page = page.into_inner();
2023-05-08 03:43:45 +00:00
Some((futures::stream::iter(page.items).map(Ok), page.next_page))
2022-07-08 01:35:36 +00:00
})
.await
}
})
.try_flatten();
first.chain(rest)
})
.try_flatten_stream()
2023-05-04 03:53:28 +00:00
.take(final_stream_limit)
2022-07-08 01:35:36 +00:00
.boxed()
}
2023-02-01 05:28:12 +00:00
///Create a project
2022-07-08 01:35:36 +00:00
///
2023-02-01 05:28:12 +00:00
///Use `POST /v1/projects` instead
///
///Sends a `POST` request to `/organizations/{organization_name}/projects`
///
///Arguments:
/// - `organization_name`: The organization's unique name.
/// - `body`
pub async fn project_create<'a>(
2022-07-08 01:35:36 +00:00
&'a self,
2023-02-01 05:28:12 +00:00
organization_name: &'a types::Name,
body: &'a types::ProjectCreate,
) -> Result<ResponseValue<types::Project>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!(
2023-02-01 05:28:12 +00:00
"{}/organizations/{}/projects",
self.baseurl,
encode_path(&organization_name.to_string()),
);
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.post(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
.json(&body)
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
201u16 => ResponseValue::from_response(response).await,
2023-02-01 05:28:12 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-07-08 01:35:36 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-07-08 01:35:36 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2022-07-08 01:35:36 +00:00
}
}
2023-02-01 05:28:12 +00:00
///Fetch a project
2022-07-08 01:35:36 +00:00
///
2023-02-01 05:28:12 +00:00
///Use `GET /v1/projects/{project}` instead
///
///Sends a `GET` request to
/// `/organizations/{organization_name}/projects/{project_name}`
///
///Arguments:
/// - `organization_name`: The organization's unique name.
/// - `project_name`: The project's unique name within the organization.
pub async fn project_view<'a>(
2022-07-08 01:35:36 +00:00
&'a self,
2023-02-01 05:28:12 +00:00
organization_name: &'a types::Name,
project_name: &'a types::Name,
) -> Result<ResponseValue<types::Project>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!(
2023-02-01 05:28:12 +00:00
"{}/organizations/{}/projects/{}",
2022-07-08 01:35:36 +00:00
self.baseurl,
2023-02-01 05:28:12 +00:00
encode_path(&organization_name.to_string()),
encode_path(&project_name.to_string()),
2022-07-08 01:35:36 +00:00
);
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.get(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
200u16 => ResponseValue::from_response(response).await,
2022-07-08 01:35:36 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-07-08 01:35:36 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-07-08 01:35:36 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2022-07-08 01:35:36 +00:00
}
}
2023-02-01 05:28:12 +00:00
///Update a project
2022-07-08 01:35:36 +00:00
///
2023-02-01 05:28:12 +00:00
///Use `PUT /v1/projects/{project}` instead
///
///Sends a `PUT` request to
/// `/organizations/{organization_name}/projects/{project_name}`
///
///Arguments:
/// - `organization_name`: The organization's unique name.
/// - `project_name`: The project's unique name within the organization.
/// - `body`
pub async fn project_update<'a>(
2022-07-08 01:35:36 +00:00
&'a self,
2023-02-01 05:28:12 +00:00
organization_name: &'a types::Name,
project_name: &'a types::Name,
body: &'a types::ProjectUpdate,
) -> Result<ResponseValue<types::Project>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!(
2023-02-01 05:28:12 +00:00
"{}/organizations/{}/projects/{}",
2022-07-08 01:35:36 +00:00
self.baseurl,
2023-02-01 05:28:12 +00:00
encode_path(&organization_name.to_string()),
encode_path(&project_name.to_string()),
2022-07-08 01:35:36 +00:00
);
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.put(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
.json(&body)
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
200u16 => ResponseValue::from_response(response).await,
2022-07-08 01:35:36 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-07-08 01:35:36 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-07-08 01:35:36 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2022-07-08 01:35:36 +00:00
}
}
2023-02-01 05:28:12 +00:00
///Delete a project
2022-07-08 01:35:36 +00:00
///
2023-02-01 05:28:12 +00:00
///Use `DELETE /v1/projects/{project}` instead
///
///Sends a `DELETE` request to
/// `/organizations/{organization_name}/projects/{project_name}`
///
///Arguments:
/// - `organization_name`: The organization's unique name.
/// - `project_name`: The project's unique name within the organization.
pub async fn project_delete<'a>(
2022-07-08 01:35:36 +00:00
&'a self,
2023-02-01 05:28:12 +00:00
organization_name: &'a types::Name,
project_name: &'a types::Name,
2022-07-08 01:35:36 +00:00
) -> Result<ResponseValue<()>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!(
2023-02-01 05:28:12 +00:00
"{}/organizations/{}/projects/{}",
2022-07-08 01:35:36 +00:00
self.baseurl,
2023-02-01 05:28:12 +00:00
encode_path(&organization_name.to_string()),
encode_path(&project_name.to_string()),
2022-07-08 01:35:36 +00:00
);
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.delete(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
204u16 => Ok(ResponseValue::empty(response)),
2022-07-08 01:35:36 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-07-08 01:35:36 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-07-08 01:35:36 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2022-07-08 01:35:36 +00:00
}
}
2023-02-01 05:28:12 +00:00
///List disks
2022-07-08 01:35:36 +00:00
///
2023-02-01 05:28:12 +00:00
///Use `GET /v1/disks` instead
2022-07-08 01:35:36 +00:00
///
2023-02-01 05:28:12 +00:00
///Sends a `GET` request to
/// `/organizations/{organization_name}/projects/{project_name}/disks`
2022-07-08 01:35:36 +00:00
///
///Arguments:
2023-02-01 05:28:12 +00:00
/// - `organization_name`: The organization's unique name.
/// - `project_name`: The project's unique name within the organization.
2022-07-08 01:35:36 +00:00
/// - `limit`: Maximum number of items returned by a single call
/// - `page_token`: Token returned by previous call to retrieve the
/// subsequent page
2023-02-01 05:28:12 +00:00
/// - `sort_by`
pub async fn disk_list<'a>(
2022-07-08 01:35:36 +00:00
&'a self,
2023-02-01 05:28:12 +00:00
organization_name: &'a types::Name,
project_name: &'a types::Name,
2022-07-08 01:35:36 +00:00
limit: Option<std::num::NonZeroU32>,
page_token: Option<&'a str>,
2023-02-01 05:28:12 +00:00
sort_by: Option<types::NameSortMode>,
) -> Result<ResponseValue<types::DiskResultsPage>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!(
2023-02-01 05:28:12 +00:00
"{}/organizations/{}/projects/{}/disks",
2022-07-08 01:35:36 +00:00
self.baseurl,
2023-02-01 05:28:12 +00:00
encode_path(&organization_name.to_string()),
encode_path(&project_name.to_string()),
2022-07-08 01:35:36 +00:00
);
2023-10-16 18:44:24 +00:00
let mut query = Vec::with_capacity(3usize);
2022-07-08 01:35:36 +00:00
if let Some(v) = &limit {
2023-10-16 18:44:24 +00:00
query.push(("limit", v.to_string()));
2022-07-08 01:35:36 +00:00
}
if let Some(v) = &page_token {
2023-10-16 18:44:24 +00:00
query.push(("page_token", v.to_string()));
2022-07-08 01:35:36 +00:00
}
2023-02-01 05:28:12 +00:00
if let Some(v) = &sort_by {
2023-10-16 18:44:24 +00:00
query.push(("sort_by", v.to_string()));
2023-02-01 05:28:12 +00:00
}
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.get(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
2023-10-16 18:44:24 +00:00
.query(&query)
2023-04-25 00:42:22 +00:00
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
200u16 => ResponseValue::from_response(response).await,
2022-07-08 01:35:36 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-07-08 01:35:36 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-07-08 01:35:36 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2022-07-08 01:35:36 +00:00
}
}
2023-02-01 05:28:12 +00:00
///List disks as a Stream
2022-07-08 01:35:36 +00:00
///
2023-02-01 05:28:12 +00:00
///Use `GET /v1/disks` instead
2022-07-08 01:35:36 +00:00
///
2023-02-01 05:28:12 +00:00
///Sends repeated `GET` requests to
/// `/organizations/{organization_name}/projects/{project_name}/disks` until
2022-07-08 01:35:36 +00:00
/// there are no more results.
///
///Arguments:
2023-02-01 05:28:12 +00:00
/// - `organization_name`: The organization's unique name.
/// - `project_name`: The project's unique name within the organization.
2022-07-08 01:35:36 +00:00
/// - `limit`: Maximum number of items returned by a single call
2023-02-01 05:28:12 +00:00
/// - `sort_by`
pub fn disk_list_stream<'a>(
2022-07-08 01:35:36 +00:00
&'a self,
2023-02-01 05:28:12 +00:00
organization_name: &'a types::Name,
project_name: &'a types::Name,
2022-07-08 01:35:36 +00:00
limit: Option<std::num::NonZeroU32>,
2023-02-01 05:28:12 +00:00
sort_by: Option<types::NameSortMode>,
) -> impl futures::Stream<Item = Result<types::Disk, Error<types::Error>>> + Unpin + '_ {
2022-07-08 01:35:36 +00:00
use futures::StreamExt;
use futures::TryFutureExt;
use futures::TryStreamExt;
2023-05-04 03:53:28 +00:00
let final_stream_limit = limit
.clone()
.and_then(|x| std::num::NonZeroUsize::try_from(x).ok())
.map(std::num::NonZeroUsize::get)
.unwrap_or(usize::MAX);
2023-02-01 05:28:12 +00:00
self.disk_list(organization_name, project_name, limit, None, sort_by)
2022-07-08 01:35:36 +00:00
.map_ok(move |page| {
let page = page.into_inner();
2023-05-08 03:43:45 +00:00
let first = futures::stream::iter(page.items).map(Ok);
2022-07-08 01:35:36 +00:00
let rest = futures::stream::try_unfold(page.next_page, move |state| async move {
if state.is_none() {
Ok(None)
} else {
2023-02-01 05:28:12 +00:00
self.disk_list(
organization_name,
project_name,
None,
state.as_deref(),
None,
)
.map_ok(|page| {
let page = page.into_inner();
2023-05-08 03:43:45 +00:00
Some((futures::stream::iter(page.items).map(Ok), page.next_page))
2023-02-01 05:28:12 +00:00
})
.await
2022-07-08 01:35:36 +00:00
}
})
.try_flatten();
first.chain(rest)
})
.try_flatten_stream()
2023-05-04 03:53:28 +00:00
.take(final_stream_limit)
2022-07-08 01:35:36 +00:00
.boxed()
}
2023-02-01 05:28:12 +00:00
///Use `POST /v1/disks` instead
2022-07-08 01:35:36 +00:00
///
2023-02-01 05:28:12 +00:00
///Sends a `POST` request to
/// `/organizations/{organization_name}/projects/{project_name}/disks`
///
///Arguments:
/// - `organization_name`: The organization's unique name.
/// - `project_name`: The project's unique name within the organization.
/// - `body`
pub async fn disk_create<'a>(
2022-07-08 01:35:36 +00:00
&'a self,
2023-02-01 05:28:12 +00:00
organization_name: &'a types::Name,
project_name: &'a types::Name,
body: &'a types::DiskCreate,
) -> Result<ResponseValue<types::Disk>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!(
2023-02-01 05:28:12 +00:00
"{}/organizations/{}/projects/{}/disks",
2022-07-08 01:35:36 +00:00
self.baseurl,
2023-02-01 05:28:12 +00:00
encode_path(&organization_name.to_string()),
encode_path(&project_name.to_string()),
2022-07-08 01:35:36 +00:00
);
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.post(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
.json(&body)
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
201u16 => ResponseValue::from_response(response).await,
2022-07-08 01:35:36 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-07-08 01:35:36 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-07-08 01:35:36 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2022-07-08 01:35:36 +00:00
}
}
2023-02-01 05:28:12 +00:00
///Fetch a disk
2022-07-08 01:35:36 +00:00
///
2023-02-01 05:28:12 +00:00
///Use `GET /v1/disks/{disk}` instead
///
///Sends a `GET` request to
/// `/organizations/{organization_name}/projects/{project_name}/disks/
/// {disk_name}`
pub async fn disk_view<'a>(
2022-07-08 01:35:36 +00:00
&'a self,
2023-02-01 05:28:12 +00:00
organization_name: &'a types::Name,
project_name: &'a types::Name,
disk_name: &'a types::Name,
) -> Result<ResponseValue<types::Disk>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!(
2023-02-01 05:28:12 +00:00
"{}/organizations/{}/projects/{}/disks/{}",
2022-07-08 01:35:36 +00:00
self.baseurl,
2023-02-01 05:28:12 +00:00
encode_path(&organization_name.to_string()),
encode_path(&project_name.to_string()),
encode_path(&disk_name.to_string()),
2022-07-08 01:35:36 +00:00
);
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.get(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
200u16 => ResponseValue::from_response(response).await,
2022-07-08 01:35:36 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-07-08 01:35:36 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-07-08 01:35:36 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2022-07-08 01:35:36 +00:00
}
}
2023-02-01 05:28:12 +00:00
///Use `DELETE /v1/disks/{disk}` instead
2022-07-08 01:35:36 +00:00
///
2023-02-01 05:28:12 +00:00
///Sends a `DELETE` request to
/// `/organizations/{organization_name}/projects/{project_name}/disks/
/// {disk_name}`
pub async fn disk_delete<'a>(
2022-07-08 01:35:36 +00:00
&'a self,
2023-02-01 05:28:12 +00:00
organization_name: &'a types::Name,
project_name: &'a types::Name,
disk_name: &'a types::Name,
) -> Result<ResponseValue<()>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!(
2023-02-01 05:28:12 +00:00
"{}/organizations/{}/projects/{}/disks/{}",
2022-07-08 01:35:36 +00:00
self.baseurl,
2023-02-01 05:28:12 +00:00
encode_path(&organization_name.to_string()),
encode_path(&project_name.to_string()),
encode_path(&disk_name.to_string()),
2022-07-08 01:35:36 +00:00
);
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.delete(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
204u16 => Ok(ResponseValue::empty(response)),
2023-02-01 05:28:12 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2022-07-08 01:35:36 +00:00
}
}
2023-02-01 05:28:12 +00:00
///Fetch disk metrics
2022-07-08 01:35:36 +00:00
///
2023-02-01 05:28:12 +00:00
///Sends a `GET` request to
/// `/organizations/{organization_name}/projects/{project_name}/disks/
/// {disk_name}/metrics/{metric_name}`
2022-07-08 01:35:36 +00:00
///
2023-02-01 05:28:12 +00:00
///Arguments:
/// - `organization_name`
/// - `project_name`
/// - `disk_name`
/// - `metric_name`
/// - `end_time`: An exclusive end time of metrics.
/// - `limit`: Maximum number of items returned by a single call
/// - `page_token`: Token returned by previous call to retrieve the
/// subsequent page
/// - `start_time`: An inclusive start time of metrics.
pub async fn disk_metrics_list<'a>(
2022-07-08 01:35:36 +00:00
&'a self,
2023-02-01 05:28:12 +00:00
organization_name: &'a types::Name,
project_name: &'a types::Name,
disk_name: &'a types::Name,
metric_name: types::DiskMetricName,
end_time: Option<&'a chrono::DateTime<chrono::offset::Utc>>,
limit: Option<std::num::NonZeroU32>,
page_token: Option<&'a str>,
start_time: Option<&'a chrono::DateTime<chrono::offset::Utc>>,
) -> Result<ResponseValue<types::MeasurementResultsPage>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!(
2023-02-01 05:28:12 +00:00
"{}/organizations/{}/projects/{}/disks/{}/metrics/{}",
2022-07-08 01:35:36 +00:00
self.baseurl,
2023-02-01 05:28:12 +00:00
encode_path(&organization_name.to_string()),
encode_path(&project_name.to_string()),
encode_path(&disk_name.to_string()),
encode_path(&metric_name.to_string()),
);
2023-10-16 18:44:24 +00:00
let mut query = Vec::with_capacity(4usize);
2023-02-01 05:28:12 +00:00
if let Some(v) = &end_time {
2023-10-16 18:44:24 +00:00
query.push(("end_time", v.to_string()));
2022-07-08 01:35:36 +00:00
}
2023-02-01 05:28:12 +00:00
if let Some(v) = &limit {
2023-10-16 18:44:24 +00:00
query.push(("limit", v.to_string()));
2023-02-01 05:28:12 +00:00
}
if let Some(v) = &page_token {
2023-10-16 18:44:24 +00:00
query.push(("page_token", v.to_string()));
2023-02-01 05:28:12 +00:00
}
if let Some(v) = &start_time {
2023-10-16 18:44:24 +00:00
query.push(("start_time", v.to_string()));
2023-02-01 05:28:12 +00:00
}
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.get(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
2023-10-16 18:44:24 +00:00
.query(&query)
2023-04-25 00:42:22 +00:00
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
200u16 => ResponseValue::from_response(response).await,
2023-02-01 05:28:12 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2022-02-08 16:59:38 +00:00
}
2021-12-10 02:15:24 +00:00
}
2023-02-01 05:28:12 +00:00
///Fetch disk metrics as a Stream
2022-07-03 02:09:38 +00:00
///
2023-02-01 05:28:12 +00:00
///Sends repeated `GET` requests to
/// `/organizations/{organization_name}/projects/{project_name}/disks/
/// {disk_name}/metrics/{metric_name}` until there are no more results.
///
///Arguments:
/// - `organization_name`
/// - `project_name`
/// - `disk_name`
/// - `metric_name`
/// - `end_time`: An exclusive end time of metrics.
/// - `limit`: Maximum number of items returned by a single call
/// - `start_time`: An inclusive start time of metrics.
pub fn disk_metrics_list_stream<'a>(
&'a self,
organization_name: &'a types::Name,
project_name: &'a types::Name,
disk_name: &'a types::Name,
metric_name: types::DiskMetricName,
end_time: Option<&'a chrono::DateTime<chrono::offset::Utc>>,
limit: Option<std::num::NonZeroU32>,
start_time: Option<&'a chrono::DateTime<chrono::offset::Utc>>,
) -> impl futures::Stream<Item = Result<types::Measurement, Error<types::Error>>> + Unpin + '_
{
use futures::StreamExt;
use futures::TryFutureExt;
use futures::TryStreamExt;
2023-05-04 03:53:28 +00:00
let final_stream_limit = limit
.clone()
.and_then(|x| std::num::NonZeroUsize::try_from(x).ok())
.map(std::num::NonZeroUsize::get)
.unwrap_or(usize::MAX);
2023-02-01 05:28:12 +00:00
self.disk_metrics_list(
organization_name,
project_name,
disk_name,
metric_name,
end_time,
limit,
None,
start_time,
)
.map_ok(move |page| {
let page = page.into_inner();
2023-05-08 03:43:45 +00:00
let first = futures::stream::iter(page.items).map(Ok);
2023-02-01 05:28:12 +00:00
let rest = futures::stream::try_unfold(page.next_page, move |state| async move {
if state.is_none() {
Ok(None)
} else {
self.disk_metrics_list(
organization_name,
project_name,
disk_name,
metric_name,
None,
None,
state.as_deref(),
None,
)
.map_ok(|page| {
let page = page.into_inner();
2023-05-08 03:43:45 +00:00
Some((futures::stream::iter(page.items).map(Ok), page.next_page))
2023-02-01 05:28:12 +00:00
})
.await
}
})
.try_flatten();
first.chain(rest)
})
.try_flatten_stream()
2023-05-04 03:53:28 +00:00
.take(final_stream_limit)
2023-02-01 05:28:12 +00:00
.boxed()
}
///List images
///
///List images in a project. The images are returned sorted by creation
/// date, with the most recent images appearing first.
///
///Sends a `GET` request to
/// `/organizations/{organization_name}/projects/{project_name}/images`
2022-07-03 02:09:38 +00:00
///
///Arguments:
2023-02-01 05:28:12 +00:00
/// - `organization_name`: The organization's unique name.
/// - `project_name`: The project's unique name within the organization.
2022-07-03 02:09:38 +00:00
/// - `limit`: Maximum number of items returned by a single call
2022-07-08 01:35:36 +00:00
/// - `page_token`: Token returned by previous call to retrieve the
2022-07-03 02:09:38 +00:00
/// subsequent page
/// - `sort_by`
2023-02-01 05:28:12 +00:00
pub async fn image_list<'a>(
2022-01-05 20:02:46 +00:00
&'a self,
2023-02-01 05:28:12 +00:00
organization_name: &'a types::Name,
project_name: &'a types::Name,
2021-12-10 02:15:24 +00:00
limit: Option<std::num::NonZeroU32>,
2022-01-05 20:02:46 +00:00
page_token: Option<&'a str>,
2023-02-01 05:28:12 +00:00
sort_by: Option<types::NameSortMode>,
) -> Result<ResponseValue<types::ImageResultsPage>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!(
2023-02-01 05:28:12 +00:00
"{}/organizations/{}/projects/{}/images",
self.baseurl,
encode_path(&organization_name.to_string()),
encode_path(&project_name.to_string()),
);
2023-10-16 18:44:24 +00:00
let mut query = Vec::with_capacity(3usize);
2021-12-10 02:15:24 +00:00
if let Some(v) = &limit {
2023-10-16 18:44:24 +00:00
query.push(("limit", v.to_string()));
2021-12-10 02:15:24 +00:00
}
if let Some(v) = &page_token {
2023-10-16 18:44:24 +00:00
query.push(("page_token", v.to_string()));
2021-12-10 02:15:24 +00:00
}
if let Some(v) = &sort_by {
2023-10-16 18:44:24 +00:00
query.push(("sort_by", v.to_string()));
2021-12-10 02:15:24 +00:00
}
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.get(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
2023-10-16 18:44:24 +00:00
.query(&query)
2023-04-25 00:42:22 +00:00
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
200u16 => ResponseValue::from_response(response).await,
2022-02-08 16:59:38 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-02-08 16:59:38 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-02-08 16:59:38 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2022-02-08 16:59:38 +00:00
}
2021-12-10 02:15:24 +00:00
}
2023-02-01 05:28:12 +00:00
///List images as a Stream
2022-07-03 02:09:38 +00:00
///
2023-02-01 05:28:12 +00:00
///List images in a project. The images are returned sorted by creation
/// date, with the most recent images appearing first.
///
///Sends repeated `GET` requests to
/// `/organizations/{organization_name}/projects/{project_name}/images`
/// until there are no more results.
2022-07-03 02:09:38 +00:00
///
///Arguments:
2023-02-01 05:28:12 +00:00
/// - `organization_name`: The organization's unique name.
/// - `project_name`: The project's unique name within the organization.
2022-07-03 02:09:38 +00:00
/// - `limit`: Maximum number of items returned by a single call
/// - `sort_by`
2023-02-01 05:28:12 +00:00
pub fn image_list_stream<'a>(
2022-01-05 20:02:46 +00:00
&'a self,
2023-02-01 05:28:12 +00:00
organization_name: &'a types::Name,
project_name: &'a types::Name,
2022-01-05 20:02:46 +00:00
limit: Option<std::num::NonZeroU32>,
2023-02-01 05:28:12 +00:00
sort_by: Option<types::NameSortMode>,
) -> impl futures::Stream<Item = Result<types::Image, Error<types::Error>>> + Unpin + '_ {
2022-01-05 20:02:46 +00:00
use futures::StreamExt;
use futures::TryFutureExt;
use futures::TryStreamExt;
2023-05-04 03:53:28 +00:00
let final_stream_limit = limit
.clone()
.and_then(|x| std::num::NonZeroUsize::try_from(x).ok())
.map(std::num::NonZeroUsize::get)
.unwrap_or(usize::MAX);
2023-02-01 05:28:12 +00:00
self.image_list(organization_name, project_name, limit, None, sort_by)
2022-01-05 20:02:46 +00:00
.map_ok(move |page| {
2022-02-08 16:59:38 +00:00
let page = page.into_inner();
2023-05-08 03:43:45 +00:00
let first = futures::stream::iter(page.items).map(Ok);
2022-01-05 20:02:46 +00:00
let rest = futures::stream::try_unfold(page.next_page, move |state| async move {
if state.is_none() {
Ok(None)
} else {
2023-02-01 05:28:12 +00:00
self.image_list(
organization_name,
project_name,
None,
state.as_deref(),
None,
)
.map_ok(|page| {
let page = page.into_inner();
2023-05-08 03:43:45 +00:00
Some((futures::stream::iter(page.items).map(Ok), page.next_page))
2023-02-01 05:28:12 +00:00
})
.await
2022-01-05 20:02:46 +00:00
}
})
.try_flatten();
first.chain(rest)
})
.try_flatten_stream()
2023-05-04 03:53:28 +00:00
.take(final_stream_limit)
2022-01-05 20:02:46 +00:00
.boxed()
}
2023-02-01 05:28:12 +00:00
///Create an image
2022-07-03 02:09:38 +00:00
///
2023-02-01 05:28:12 +00:00
///Create a new image in a project.
///
///Sends a `POST` request to
/// `/organizations/{organization_name}/projects/{project_name}/images`
///
///Arguments:
/// - `organization_name`: The organization's unique name.
/// - `project_name`: The project's unique name within the organization.
/// - `body`
pub async fn image_create<'a>(
2022-01-05 20:02:46 +00:00
&'a self,
2023-02-01 05:28:12 +00:00
organization_name: &'a types::Name,
project_name: &'a types::Name,
body: &'a types::ImageCreate,
) -> Result<ResponseValue<types::Image>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!(
2023-02-01 05:28:12 +00:00
"{}/organizations/{}/projects/{}/images",
self.baseurl,
encode_path(&organization_name.to_string()),
encode_path(&project_name.to_string()),
);
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.post(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
.json(&body)
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
201u16 => ResponseValue::from_response(response).await,
2022-02-08 16:59:38 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-02-08 16:59:38 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-02-08 16:59:38 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2022-02-08 16:59:38 +00:00
}
2021-12-10 02:15:24 +00:00
}
2023-02-01 05:28:12 +00:00
///Fetch an image
2022-07-03 02:09:38 +00:00
///
2023-02-01 05:28:12 +00:00
///Fetch the details for a specific image in a project.
2022-07-03 02:09:38 +00:00
///
2023-02-01 05:28:12 +00:00
///Sends a `GET` request to
/// `/organizations/{organization_name}/projects/{project_name}/images/
/// {image_name}`
pub async fn image_view<'a>(
2022-01-05 20:02:46 +00:00
&'a self,
organization_name: &'a types::Name,
2023-02-01 05:28:12 +00:00
project_name: &'a types::Name,
image_name: &'a types::Name,
) -> Result<ResponseValue<types::Image>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!(
2023-02-01 05:28:12 +00:00
"{}/organizations/{}/projects/{}/images/{}",
2021-12-10 02:15:24 +00:00
self.baseurl,
2022-07-03 02:09:38 +00:00
encode_path(&organization_name.to_string()),
2023-02-01 05:28:12 +00:00
encode_path(&project_name.to_string()),
encode_path(&image_name.to_string()),
2021-12-10 02:15:24 +00:00
);
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.get(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
200u16 => ResponseValue::from_response(response).await,
2022-02-08 16:59:38 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-02-08 16:59:38 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-02-08 16:59:38 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2022-02-08 16:59:38 +00:00
}
2021-12-10 02:15:24 +00:00
}
2023-02-01 05:28:12 +00:00
///Delete an image
2022-07-03 02:09:38 +00:00
///
2023-02-01 05:28:12 +00:00
///Permanently delete an image from a project. This operation cannot be
/// undone. Any instances in the project using the image will continue to
/// run, however new instances can not be created with this image.
2022-07-03 02:09:38 +00:00
///
2023-02-01 05:28:12 +00:00
///Sends a `DELETE` request to
/// `/organizations/{organization_name}/projects/{project_name}/images/
/// {image_name}`
pub async fn image_delete<'a>(
2022-01-05 20:02:46 +00:00
&'a self,
organization_name: &'a types::Name,
2023-02-01 05:28:12 +00:00
project_name: &'a types::Name,
image_name: &'a types::Name,
) -> Result<ResponseValue<()>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!(
2023-02-01 05:28:12 +00:00
"{}/organizations/{}/projects/{}/images/{}",
2021-12-10 02:15:24 +00:00
self.baseurl,
2022-07-03 02:09:38 +00:00
encode_path(&organization_name.to_string()),
2023-02-01 05:28:12 +00:00
encode_path(&project_name.to_string()),
encode_path(&image_name.to_string()),
2021-12-10 02:15:24 +00:00
);
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.delete(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
204u16 => Ok(ResponseValue::empty(response)),
2022-02-08 16:59:38 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-02-08 16:59:38 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-02-08 16:59:38 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2022-02-08 16:59:38 +00:00
}
2021-12-10 02:15:24 +00:00
}
2023-02-01 05:28:12 +00:00
///List instances
2022-07-03 02:09:38 +00:00
///
2023-02-01 05:28:12 +00:00
///Sends a `GET` request to
/// `/organizations/{organization_name}/projects/{project_name}/instances`
2022-07-03 02:09:38 +00:00
///
///Arguments:
/// - `organization_name`: The organization's unique name.
2023-02-01 05:28:12 +00:00
/// - `project_name`: The project's unique name within the organization.
2022-07-03 02:09:38 +00:00
/// - `limit`: Maximum number of items returned by a single call
2022-07-08 01:35:36 +00:00
/// - `page_token`: Token returned by previous call to retrieve the
2022-07-03 02:09:38 +00:00
/// subsequent page
/// - `sort_by`
2023-02-01 05:28:12 +00:00
pub async fn instance_list<'a>(
2022-01-05 20:02:46 +00:00
&'a self,
organization_name: &'a types::Name,
2023-02-01 05:28:12 +00:00
project_name: &'a types::Name,
2021-12-10 02:15:24 +00:00
limit: Option<std::num::NonZeroU32>,
2022-01-05 20:02:46 +00:00
page_token: Option<&'a str>,
2023-02-01 05:28:12 +00:00
sort_by: Option<types::NameSortMode>,
) -> Result<ResponseValue<types::InstanceResultsPage>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!(
2023-02-01 05:28:12 +00:00
"{}/organizations/{}/projects/{}/instances",
2021-12-10 02:15:24 +00:00
self.baseurl,
2022-07-03 02:09:38 +00:00
encode_path(&organization_name.to_string()),
2023-02-01 05:28:12 +00:00
encode_path(&project_name.to_string()),
2021-12-10 02:15:24 +00:00
);
2023-10-16 18:44:24 +00:00
let mut query = Vec::with_capacity(3usize);
2021-12-10 02:15:24 +00:00
if let Some(v) = &limit {
2023-10-16 18:44:24 +00:00
query.push(("limit", v.to_string()));
2021-12-10 02:15:24 +00:00
}
if let Some(v) = &page_token {
2023-10-16 18:44:24 +00:00
query.push(("page_token", v.to_string()));
2021-12-10 02:15:24 +00:00
}
if let Some(v) = &sort_by {
2023-10-16 18:44:24 +00:00
query.push(("sort_by", v.to_string()));
2021-12-10 02:15:24 +00:00
}
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.get(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
2023-10-16 18:44:24 +00:00
.query(&query)
2023-04-25 00:42:22 +00:00
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
200u16 => ResponseValue::from_response(response).await,
2022-02-08 16:59:38 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-02-08 16:59:38 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-02-08 16:59:38 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2022-02-08 16:59:38 +00:00
}
2021-12-10 02:15:24 +00:00
}
2023-02-01 05:28:12 +00:00
///List instances as a Stream
2022-07-03 02:09:38 +00:00
///
///Sends repeated `GET` requests to
2023-02-01 05:28:12 +00:00
/// `/organizations/{organization_name}/projects/{project_name}/instances`
/// until there are no more results.
2022-07-03 02:09:38 +00:00
///
///Arguments:
/// - `organization_name`: The organization's unique name.
2023-02-01 05:28:12 +00:00
/// - `project_name`: The project's unique name within the organization.
2022-07-03 02:09:38 +00:00
/// - `limit`: Maximum number of items returned by a single call
/// - `sort_by`
2023-02-01 05:28:12 +00:00
pub fn instance_list_stream<'a>(
2022-01-05 20:02:46 +00:00
&'a self,
organization_name: &'a types::Name,
2023-02-01 05:28:12 +00:00
project_name: &'a types::Name,
2022-01-05 20:02:46 +00:00
limit: Option<std::num::NonZeroU32>,
2023-02-01 05:28:12 +00:00
sort_by: Option<types::NameSortMode>,
) -> impl futures::Stream<Item = Result<types::Instance, Error<types::Error>>> + Unpin + '_
{
2022-01-05 20:02:46 +00:00
use futures::StreamExt;
use futures::TryFutureExt;
use futures::TryStreamExt;
2023-05-04 03:53:28 +00:00
let final_stream_limit = limit
.clone()
.and_then(|x| std::num::NonZeroUsize::try_from(x).ok())
.map(std::num::NonZeroUsize::get)
.unwrap_or(usize::MAX);
2023-02-01 05:28:12 +00:00
self.instance_list(organization_name, project_name, limit, None, sort_by)
2022-01-05 20:02:46 +00:00
.map_ok(move |page| {
2022-02-08 16:59:38 +00:00
let page = page.into_inner();
2023-05-08 03:43:45 +00:00
let first = futures::stream::iter(page.items).map(Ok);
2022-01-05 20:02:46 +00:00
let rest = futures::stream::try_unfold(page.next_page, move |state| async move {
if state.is_none() {
Ok(None)
} else {
2023-02-01 05:28:12 +00:00
self.instance_list(
organization_name,
project_name,
None,
state.as_deref(),
None,
)
.map_ok(|page| {
let page = page.into_inner();
2023-05-08 03:43:45 +00:00
Some((futures::stream::iter(page.items).map(Ok), page.next_page))
2023-02-01 05:28:12 +00:00
})
.await
2022-01-05 20:02:46 +00:00
}
})
.try_flatten();
first.chain(rest)
})
.try_flatten_stream()
2023-05-04 03:53:28 +00:00
.take(final_stream_limit)
2022-01-05 20:02:46 +00:00
.boxed()
}
2023-02-01 05:28:12 +00:00
///Create an instance
2022-07-03 02:09:38 +00:00
///
2023-02-01 05:28:12 +00:00
///Use `POST /v1/instances` instead
2022-07-03 02:09:38 +00:00
///
2023-02-01 05:28:12 +00:00
///Sends a `POST` request to
/// `/organizations/{organization_name}/projects/{project_name}/instances`
2022-07-03 02:09:38 +00:00
///
///Arguments:
/// - `organization_name`: The organization's unique name.
/// - `project_name`: The project's unique name within the organization.
2023-02-01 05:28:12 +00:00
/// - `body`
pub async fn instance_create<'a>(
2022-01-05 20:02:46 +00:00
&'a self,
organization_name: &'a types::Name,
project_name: &'a types::Name,
2023-02-01 05:28:12 +00:00
body: &'a types::InstanceCreate,
) -> Result<ResponseValue<types::Instance>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!(
2023-02-01 05:28:12 +00:00
"{}/organizations/{}/projects/{}/instances",
2021-12-10 02:15:24 +00:00
self.baseurl,
2022-07-03 02:09:38 +00:00
encode_path(&organization_name.to_string()),
encode_path(&project_name.to_string()),
2021-12-10 02:15:24 +00:00
);
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.post(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
.json(&body)
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
201u16 => ResponseValue::from_response(response).await,
2022-02-08 16:59:38 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-02-08 16:59:38 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-02-08 16:59:38 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2022-02-08 16:59:38 +00:00
}
2021-12-10 02:15:24 +00:00
}
2023-02-01 05:28:12 +00:00
///Fetch an instance
2022-07-03 02:09:38 +00:00
///
2023-02-01 05:28:12 +00:00
///Use `GET /v1/instances/{instance}` instead
2022-07-03 02:09:38 +00:00
///
2023-02-01 05:28:12 +00:00
///Sends a `GET` request to
/// `/organizations/{organization_name}/projects/{project_name}/instances/
/// {instance_name}`
pub async fn instance_view<'a>(
2022-01-05 20:02:46 +00:00
&'a self,
organization_name: &'a types::Name,
project_name: &'a types::Name,
2023-02-01 05:28:12 +00:00
instance_name: &'a types::Name,
) -> Result<ResponseValue<types::Instance>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!(
2023-02-01 05:28:12 +00:00
"{}/organizations/{}/projects/{}/instances/{}",
2021-12-10 02:15:24 +00:00
self.baseurl,
2022-07-03 02:09:38 +00:00
encode_path(&organization_name.to_string()),
encode_path(&project_name.to_string()),
2023-02-01 05:28:12 +00:00
encode_path(&instance_name.to_string()),
2021-12-10 02:15:24 +00:00
);
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.get(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
200u16 => ResponseValue::from_response(response).await,
2022-02-08 16:59:38 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-02-08 16:59:38 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-02-08 16:59:38 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2022-02-08 16:59:38 +00:00
}
2021-12-10 02:15:24 +00:00
}
2023-02-01 05:28:12 +00:00
///Delete an instance
2022-07-03 02:09:38 +00:00
///
///Sends a `DELETE` request to
2023-02-01 05:28:12 +00:00
/// `/organizations/{organization_name}/projects/{project_name}/instances/
/// {instance_name}`
pub async fn instance_delete<'a>(
2022-01-05 20:02:46 +00:00
&'a self,
organization_name: &'a types::Name,
project_name: &'a types::Name,
2023-02-01 05:28:12 +00:00
instance_name: &'a types::Name,
2022-02-08 16:59:38 +00:00
) -> Result<ResponseValue<()>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!(
2023-02-01 05:28:12 +00:00
"{}/organizations/{}/projects/{}/instances/{}",
2021-12-10 02:15:24 +00:00
self.baseurl,
2022-07-03 02:09:38 +00:00
encode_path(&organization_name.to_string()),
encode_path(&project_name.to_string()),
2023-02-01 05:28:12 +00:00
encode_path(&instance_name.to_string()),
2021-12-10 02:15:24 +00:00
);
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.delete(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
204u16 => Ok(ResponseValue::empty(response)),
2022-02-08 16:59:38 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-02-08 16:59:38 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-02-08 16:59:38 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2022-02-08 16:59:38 +00:00
}
2021-12-10 02:15:24 +00:00
}
2023-02-01 05:28:12 +00:00
///List an instance's disks
///
///Use `GET /v1/instances/{instance}/disks` instead
2022-07-03 02:09:38 +00:00
///
///Sends a `GET` request to
2023-02-01 05:28:12 +00:00
/// `/organizations/{organization_name}/projects/{project_name}/instances/
/// {instance_name}/disks`
2022-07-03 02:09:38 +00:00
///
///Arguments:
2023-02-01 05:28:12 +00:00
/// - `organization_name`
/// - `project_name`
/// - `instance_name`
2022-07-03 02:09:38 +00:00
/// - `limit`: Maximum number of items returned by a single call
2022-07-08 01:35:36 +00:00
/// - `page_token`: Token returned by previous call to retrieve the
2022-07-03 02:09:38 +00:00
/// subsequent page
/// - `sort_by`
2023-02-01 05:28:12 +00:00
pub async fn instance_disk_list<'a>(
2022-01-05 20:02:46 +00:00
&'a self,
organization_name: &'a types::Name,
project_name: &'a types::Name,
2023-02-01 05:28:12 +00:00
instance_name: &'a types::Name,
2021-12-10 02:15:24 +00:00
limit: Option<std::num::NonZeroU32>,
2022-01-05 20:02:46 +00:00
page_token: Option<&'a str>,
2021-12-10 02:15:24 +00:00
sort_by: Option<types::NameSortMode>,
2022-02-08 16:59:38 +00:00
) -> Result<ResponseValue<types::DiskResultsPage>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!(
2023-02-01 05:28:12 +00:00
"{}/organizations/{}/projects/{}/instances/{}/disks",
2021-12-10 02:15:24 +00:00
self.baseurl,
2022-07-03 02:09:38 +00:00
encode_path(&organization_name.to_string()),
encode_path(&project_name.to_string()),
2023-02-01 05:28:12 +00:00
encode_path(&instance_name.to_string()),
2021-12-10 02:15:24 +00:00
);
2023-10-16 18:44:24 +00:00
let mut query = Vec::with_capacity(3usize);
2021-12-10 02:15:24 +00:00
if let Some(v) = &limit {
2023-10-16 18:44:24 +00:00
query.push(("limit", v.to_string()));
2021-12-10 02:15:24 +00:00
}
if let Some(v) = &page_token {
2023-10-16 18:44:24 +00:00
query.push(("page_token", v.to_string()));
2021-12-10 02:15:24 +00:00
}
if let Some(v) = &sort_by {
2023-10-16 18:44:24 +00:00
query.push(("sort_by", v.to_string()));
2021-12-10 02:15:24 +00:00
}
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.get(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
2023-10-16 18:44:24 +00:00
.query(&query)
2023-04-25 00:42:22 +00:00
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
200u16 => ResponseValue::from_response(response).await,
2022-02-08 16:59:38 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-02-08 16:59:38 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-02-08 16:59:38 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2022-02-08 16:59:38 +00:00
}
2021-12-10 02:15:24 +00:00
}
2023-02-01 05:28:12 +00:00
///List an instance's disks as a Stream
///
///Use `GET /v1/instances/{instance}/disks` instead
2022-07-03 02:09:38 +00:00
///
///Sends repeated `GET` requests to
2023-02-01 05:28:12 +00:00
/// `/organizations/{organization_name}/projects/{project_name}/instances/
/// {instance_name}/disks` until there are no more results.
2022-07-03 02:09:38 +00:00
///
///Arguments:
2023-02-01 05:28:12 +00:00
/// - `organization_name`
/// - `project_name`
/// - `instance_name`
2022-07-03 02:09:38 +00:00
/// - `limit`: Maximum number of items returned by a single call
/// - `sort_by`
2023-02-01 05:28:12 +00:00
pub fn instance_disk_list_stream<'a>(
2022-01-05 20:02:46 +00:00
&'a self,
organization_name: &'a types::Name,
project_name: &'a types::Name,
2023-02-01 05:28:12 +00:00
instance_name: &'a types::Name,
2022-01-05 20:02:46 +00:00
limit: Option<std::num::NonZeroU32>,
sort_by: Option<types::NameSortMode>,
2022-02-08 16:59:38 +00:00
) -> impl futures::Stream<Item = Result<types::Disk, Error<types::Error>>> + Unpin + '_ {
2022-01-05 20:02:46 +00:00
use futures::StreamExt;
use futures::TryFutureExt;
use futures::TryStreamExt;
2023-05-04 03:53:28 +00:00
let final_stream_limit = limit
.clone()
.and_then(|x| std::num::NonZeroUsize::try_from(x).ok())
.map(std::num::NonZeroUsize::get)
.unwrap_or(usize::MAX);
2023-02-01 05:28:12 +00:00
self.instance_disk_list(
organization_name,
project_name,
instance_name,
limit,
None,
sort_by,
)
.map_ok(move |page| {
let page = page.into_inner();
2023-05-08 03:43:45 +00:00
let first = futures::stream::iter(page.items).map(Ok);
2023-02-01 05:28:12 +00:00
let rest = futures::stream::try_unfold(page.next_page, move |state| async move {
if state.is_none() {
Ok(None)
} else {
self.instance_disk_list(
organization_name,
project_name,
instance_name,
None,
state.as_deref(),
None,
)
.map_ok(|page| {
let page = page.into_inner();
2023-05-08 03:43:45 +00:00
Some((futures::stream::iter(page.items).map(Ok), page.next_page))
2023-02-01 05:28:12 +00:00
})
.await
}
2022-01-05 20:02:46 +00:00
})
2023-02-01 05:28:12 +00:00
.try_flatten();
first.chain(rest)
})
.try_flatten_stream()
2023-05-04 03:53:28 +00:00
.take(final_stream_limit)
2023-02-01 05:28:12 +00:00
.boxed()
2022-01-05 20:02:46 +00:00
}
2023-02-01 05:28:12 +00:00
///Attach a disk to an instance
///
///Use `POST /v1/instances/{instance}/disks/attach` instead
2022-07-03 02:09:38 +00:00
///
///Sends a `POST` request to
2023-02-01 05:28:12 +00:00
/// `/organizations/{organization_name}/projects/{project_name}/instances/
/// {instance_name}/disks/attach`
pub async fn instance_disk_attach<'a>(
&'a self,
organization_name: &'a types::Name,
project_name: &'a types::Name,
instance_name: &'a types::Name,
body: &'a types::DiskIdentifier,
) -> Result<ResponseValue<types::Disk>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!(
2023-02-01 05:28:12 +00:00
"{}/organizations/{}/projects/{}/instances/{}/disks/attach",
self.baseurl,
encode_path(&organization_name.to_string()),
encode_path(&project_name.to_string()),
encode_path(&instance_name.to_string()),
);
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.post(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
.json(&body)
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
202u16 => ResponseValue::from_response(response).await,
2023-02-01 05:28:12 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2023-02-01 05:28:12 +00:00
}
}
///Detach a disk from an instance
2022-07-03 02:09:38 +00:00
///
2023-02-01 05:28:12 +00:00
///Use `POST /v1/disks/{disk}/detach` instead
///
///Sends a `POST` request to
/// `/organizations/{organization_name}/projects/{project_name}/instances/
/// {instance_name}/disks/detach`
pub async fn instance_disk_detach<'a>(
2022-01-05 20:02:46 +00:00
&'a self,
organization_name: &'a types::Name,
project_name: &'a types::Name,
2023-02-01 05:28:12 +00:00
instance_name: &'a types::Name,
body: &'a types::DiskIdentifier,
2022-02-08 16:59:38 +00:00
) -> Result<ResponseValue<types::Disk>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!(
2023-02-01 05:28:12 +00:00
"{}/organizations/{}/projects/{}/instances/{}/disks/detach",
2021-12-10 02:15:24 +00:00
self.baseurl,
2022-07-03 02:09:38 +00:00
encode_path(&organization_name.to_string()),
encode_path(&project_name.to_string()),
2023-02-01 05:28:12 +00:00
encode_path(&instance_name.to_string()),
2021-12-10 02:15:24 +00:00
);
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.post(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
.json(&body)
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
202u16 => ResponseValue::from_response(response).await,
2022-02-08 16:59:38 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-02-08 16:59:38 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-02-08 16:59:38 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2022-02-08 16:59:38 +00:00
}
2021-12-10 02:15:24 +00:00
}
2023-02-01 05:28:12 +00:00
///List external IP addresses
2022-07-03 02:09:38 +00:00
///
///Sends a `GET` request to
2023-02-01 05:28:12 +00:00
/// `/organizations/{organization_name}/projects/{project_name}/instances/
/// {instance_name}/external-ips`
pub async fn instance_external_ip_list<'a>(
2022-01-05 20:02:46 +00:00
&'a self,
organization_name: &'a types::Name,
project_name: &'a types::Name,
2023-02-01 05:28:12 +00:00
instance_name: &'a types::Name,
) -> Result<ResponseValue<types::ExternalIpResultsPage>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!(
2023-02-01 05:28:12 +00:00
"{}/organizations/{}/projects/{}/instances/{}/external-ips",
2021-12-10 02:15:24 +00:00
self.baseurl,
2022-07-03 02:09:38 +00:00
encode_path(&organization_name.to_string()),
encode_path(&project_name.to_string()),
2023-02-01 05:28:12 +00:00
encode_path(&instance_name.to_string()),
2021-12-10 02:15:24 +00:00
);
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.get(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
200u16 => ResponseValue::from_response(response).await,
2022-02-08 16:59:38 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-02-08 16:59:38 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-02-08 16:59:38 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2022-02-08 16:59:38 +00:00
}
2021-12-10 02:15:24 +00:00
}
2023-02-01 05:28:12 +00:00
///Migrate an instance
2022-07-03 02:09:38 +00:00
///
2023-02-01 05:28:12 +00:00
///Use `POST /v1/instances/{instance}/migrate` instead
///
///Sends a `POST` request to
/// `/organizations/{organization_name}/projects/{project_name}/instances/
/// {instance_name}/migrate`
pub async fn instance_migrate<'a>(
2022-01-05 20:02:46 +00:00
&'a self,
organization_name: &'a types::Name,
project_name: &'a types::Name,
2023-02-01 05:28:12 +00:00
instance_name: &'a types::Name,
body: &'a types::InstanceMigrate,
) -> Result<ResponseValue<types::Instance>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!(
2023-02-01 05:28:12 +00:00
"{}/organizations/{}/projects/{}/instances/{}/migrate",
2021-12-10 02:15:24 +00:00
self.baseurl,
2022-07-03 02:09:38 +00:00
encode_path(&organization_name.to_string()),
encode_path(&project_name.to_string()),
2023-02-01 05:28:12 +00:00
encode_path(&instance_name.to_string()),
2021-12-10 02:15:24 +00:00
);
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.post(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
.json(&body)
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
200u16 => ResponseValue::from_response(response).await,
2022-02-08 16:59:38 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-02-08 16:59:38 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-02-08 16:59:38 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2022-02-08 16:59:38 +00:00
}
2021-12-10 02:15:24 +00:00
}
2023-02-01 05:28:12 +00:00
///List network interfaces
2022-07-27 04:23:01 +00:00
///
///Sends a `GET` request to
2023-02-01 05:28:12 +00:00
/// `/organizations/{organization_name}/projects/{project_name}/instances/
/// {instance_name}/network-interfaces`
2022-07-27 04:23:01 +00:00
///
///Arguments:
/// - `organization_name`
/// - `project_name`
2023-02-01 05:28:12 +00:00
/// - `instance_name`
2022-07-27 04:23:01 +00:00
/// - `limit`: Maximum number of items returned by a single call
/// - `page_token`: Token returned by previous call to retrieve the
/// subsequent page
2023-02-01 05:28:12 +00:00
/// - `sort_by`
pub async fn instance_network_interface_list<'a>(
2022-07-27 04:23:01 +00:00
&'a self,
organization_name: &'a types::Name,
project_name: &'a types::Name,
2023-02-01 05:28:12 +00:00
instance_name: &'a types::Name,
2022-07-27 04:23:01 +00:00
limit: Option<std::num::NonZeroU32>,
page_token: Option<&'a str>,
2023-02-01 05:28:12 +00:00
sort_by: Option<types::NameSortMode>,
) -> Result<ResponseValue<types::NetworkInterfaceResultsPage>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!(
2023-02-01 05:28:12 +00:00
"{}/organizations/{}/projects/{}/instances/{}/network-interfaces",
2022-07-27 04:23:01 +00:00
self.baseurl,
encode_path(&organization_name.to_string()),
encode_path(&project_name.to_string()),
2023-02-01 05:28:12 +00:00
encode_path(&instance_name.to_string()),
2022-07-27 04:23:01 +00:00
);
2023-10-16 18:44:24 +00:00
let mut query = Vec::with_capacity(3usize);
2022-07-27 04:23:01 +00:00
if let Some(v) = &limit {
2023-10-16 18:44:24 +00:00
query.push(("limit", v.to_string()));
2022-07-27 04:23:01 +00:00
}
if let Some(v) = &page_token {
2023-10-16 18:44:24 +00:00
query.push(("page_token", v.to_string()));
2022-07-27 04:23:01 +00:00
}
2023-02-01 05:28:12 +00:00
if let Some(v) = &sort_by {
2023-10-16 18:44:24 +00:00
query.push(("sort_by", v.to_string()));
2022-07-27 04:23:01 +00:00
}
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.get(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
2023-10-16 18:44:24 +00:00
.query(&query)
2023-04-25 00:42:22 +00:00
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
200u16 => ResponseValue::from_response(response).await,
2022-07-27 04:23:01 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-07-27 04:23:01 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-07-27 04:23:01 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2022-07-27 04:23:01 +00:00
}
}
2023-02-01 05:28:12 +00:00
///List network interfaces as a Stream
2022-07-27 04:23:01 +00:00
///
///Sends repeated `GET` requests to
2023-02-01 05:28:12 +00:00
/// `/organizations/{organization_name}/projects/{project_name}/instances/
/// {instance_name}/network-interfaces` until there are no more results.
2022-07-27 04:23:01 +00:00
///
///Arguments:
/// - `organization_name`
/// - `project_name`
2023-02-01 05:28:12 +00:00
/// - `instance_name`
2022-07-27 04:23:01 +00:00
/// - `limit`: Maximum number of items returned by a single call
2023-02-01 05:28:12 +00:00
/// - `sort_by`
pub fn instance_network_interface_list_stream<'a>(
2022-07-27 04:23:01 +00:00
&'a self,
organization_name: &'a types::Name,
project_name: &'a types::Name,
2023-02-01 05:28:12 +00:00
instance_name: &'a types::Name,
2022-07-27 04:23:01 +00:00
limit: Option<std::num::NonZeroU32>,
2023-02-01 05:28:12 +00:00
sort_by: Option<types::NameSortMode>,
) -> impl futures::Stream<Item = Result<types::NetworkInterface, Error<types::Error>>> + Unpin + '_
2022-07-27 04:23:01 +00:00
{
use futures::StreamExt;
use futures::TryFutureExt;
use futures::TryStreamExt;
2023-05-04 03:53:28 +00:00
let final_stream_limit = limit
.clone()
.and_then(|x| std::num::NonZeroUsize::try_from(x).ok())
.map(std::num::NonZeroUsize::get)
.unwrap_or(usize::MAX);
2023-02-01 05:28:12 +00:00
self.instance_network_interface_list(
2022-07-27 04:23:01 +00:00
organization_name,
project_name,
2023-02-01 05:28:12 +00:00
instance_name,
2022-07-27 04:23:01 +00:00
limit,
None,
2023-02-01 05:28:12 +00:00
sort_by,
2022-07-27 04:23:01 +00:00
)
.map_ok(move |page| {
let page = page.into_inner();
2023-05-08 03:43:45 +00:00
let first = futures::stream::iter(page.items).map(Ok);
2022-07-27 04:23:01 +00:00
let rest = futures::stream::try_unfold(page.next_page, move |state| async move {
if state.is_none() {
Ok(None)
} else {
2023-02-01 05:28:12 +00:00
self.instance_network_interface_list(
2022-07-27 04:23:01 +00:00
organization_name,
project_name,
2023-02-01 05:28:12 +00:00
instance_name,
2022-07-27 04:23:01 +00:00
None,
state.as_deref(),
None,
)
.map_ok(|page| {
let page = page.into_inner();
2023-05-08 03:43:45 +00:00
Some((futures::stream::iter(page.items).map(Ok), page.next_page))
2022-07-27 04:23:01 +00:00
})
.await
}
})
.try_flatten();
first.chain(rest)
})
.try_flatten_stream()
2023-05-04 03:53:28 +00:00
.take(final_stream_limit)
2022-07-27 04:23:01 +00:00
.boxed()
}
2023-02-01 05:28:12 +00:00
///Create a network interface
2022-07-03 02:09:38 +00:00
///
2023-02-01 05:28:12 +00:00
///Sends a `POST` request to
/// `/organizations/{organization_name}/projects/{project_name}/instances/
/// {instance_name}/network-interfaces`
pub async fn instance_network_interface_create<'a>(
2022-01-05 20:02:46 +00:00
&'a self,
organization_name: &'a types::Name,
project_name: &'a types::Name,
2023-02-01 05:28:12 +00:00
instance_name: &'a types::Name,
body: &'a types::NetworkInterfaceCreate,
) -> Result<ResponseValue<types::NetworkInterface>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!(
2023-02-01 05:28:12 +00:00
"{}/organizations/{}/projects/{}/instances/{}/network-interfaces",
2021-12-10 02:15:24 +00:00
self.baseurl,
2022-07-03 02:09:38 +00:00
encode_path(&organization_name.to_string()),
encode_path(&project_name.to_string()),
2023-02-01 05:28:12 +00:00
encode_path(&instance_name.to_string()),
2021-12-10 02:15:24 +00:00
);
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.post(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
.json(&body)
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
201u16 => ResponseValue::from_response(response).await,
2022-02-08 16:59:38 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-02-08 16:59:38 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-02-08 16:59:38 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2022-02-08 16:59:38 +00:00
}
2021-12-10 02:15:24 +00:00
}
2023-02-01 05:28:12 +00:00
///Fetch a network interface
2022-07-03 02:09:38 +00:00
///
2023-02-01 05:28:12 +00:00
///Sends a `GET` request to
/// `/organizations/{organization_name}/projects/{project_name}/instances/
/// {instance_name}/network-interfaces/{interface_name}`
pub async fn instance_network_interface_view<'a>(
2022-01-05 20:02:46 +00:00
&'a self,
organization_name: &'a types::Name,
project_name: &'a types::Name,
2023-02-01 05:28:12 +00:00
instance_name: &'a types::Name,
interface_name: &'a types::Name,
) -> Result<ResponseValue<types::NetworkInterface>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!(
2023-02-01 05:28:12 +00:00
"{}/organizations/{}/projects/{}/instances/{}/network-interfaces/{}",
self.baseurl,
encode_path(&organization_name.to_string()),
encode_path(&project_name.to_string()),
encode_path(&instance_name.to_string()),
encode_path(&interface_name.to_string()),
);
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.get(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
200u16 => ResponseValue::from_response(response).await,
2023-02-01 05:28:12 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2023-02-01 05:28:12 +00:00
}
2022-01-05 20:02:46 +00:00
}
2023-02-01 05:28:12 +00:00
///Update a network interface
2022-07-03 02:09:38 +00:00
///
2023-02-01 05:28:12 +00:00
///Sends a `PUT` request to
/// `/organizations/{organization_name}/projects/{project_name}/instances/
/// {instance_name}/network-interfaces/{interface_name}`
pub async fn instance_network_interface_update<'a>(
2022-01-05 20:02:46 +00:00
&'a self,
organization_name: &'a types::Name,
project_name: &'a types::Name,
2023-02-01 05:28:12 +00:00
instance_name: &'a types::Name,
interface_name: &'a types::Name,
body: &'a types::NetworkInterfaceUpdate,
) -> Result<ResponseValue<types::NetworkInterface>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!(
2023-02-01 05:28:12 +00:00
"{}/organizations/{}/projects/{}/instances/{}/network-interfaces/{}",
2021-12-10 02:15:24 +00:00
self.baseurl,
2022-07-03 02:09:38 +00:00
encode_path(&organization_name.to_string()),
encode_path(&project_name.to_string()),
2023-02-01 05:28:12 +00:00
encode_path(&instance_name.to_string()),
encode_path(&interface_name.to_string()),
2021-12-10 02:15:24 +00:00
);
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.put(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
.json(&body)
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
200u16 => ResponseValue::from_response(response).await,
2022-02-08 16:59:38 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-02-08 16:59:38 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-02-08 16:59:38 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2022-02-08 16:59:38 +00:00
}
2021-12-10 02:15:24 +00:00
}
2023-02-01 05:28:12 +00:00
///Delete a network interface
2022-07-03 02:09:38 +00:00
///
2023-02-01 05:28:12 +00:00
///Note that the primary interface for an instance cannot be deleted if
/// there are any secondary interfaces. A new primary interface must be
/// designated first. The primary interface can be deleted if there are no
/// secondary interfaces.
2022-07-03 02:09:38 +00:00
///
2023-02-01 05:28:12 +00:00
///Sends a `DELETE` request to
/// `/organizations/{organization_name}/projects/{project_name}/instances/
/// {instance_name}/network-interfaces/{interface_name}`
pub async fn instance_network_interface_delete<'a>(
2022-01-05 20:02:46 +00:00
&'a self,
organization_name: &'a types::Name,
project_name: &'a types::Name,
2023-02-01 05:28:12 +00:00
instance_name: &'a types::Name,
interface_name: &'a types::Name,
) -> Result<ResponseValue<()>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!(
2023-02-01 05:28:12 +00:00
"{}/organizations/{}/projects/{}/instances/{}/network-interfaces/{}",
2021-12-10 02:15:24 +00:00
self.baseurl,
2022-07-03 02:09:38 +00:00
encode_path(&organization_name.to_string()),
encode_path(&project_name.to_string()),
2023-02-01 05:28:12 +00:00
encode_path(&instance_name.to_string()),
encode_path(&interface_name.to_string()),
2021-12-10 02:15:24 +00:00
);
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.delete(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
204u16 => Ok(ResponseValue::empty(response)),
2022-02-08 16:59:38 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-02-08 16:59:38 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-02-08 16:59:38 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2022-02-08 16:59:38 +00:00
}
2021-12-10 02:15:24 +00:00
}
2023-02-01 05:28:12 +00:00
///Reboot an instance
2022-07-03 02:09:38 +00:00
///
2023-02-01 05:28:12 +00:00
///Use `POST /v1/instances/{instance}/reboot` instead
2022-07-03 02:09:38 +00:00
///
2023-02-01 05:28:12 +00:00
///Sends a `POST` request to
/// `/organizations/{organization_name}/projects/{project_name}/instances/
/// {instance_name}/reboot`
pub async fn instance_reboot<'a>(
2022-01-05 20:02:46 +00:00
&'a self,
organization_name: &'a types::Name,
project_name: &'a types::Name,
2023-02-01 05:28:12 +00:00
instance_name: &'a types::Name,
) -> Result<ResponseValue<types::Instance>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!(
2023-02-01 05:28:12 +00:00
"{}/organizations/{}/projects/{}/instances/{}/reboot",
2021-12-10 02:15:24 +00:00
self.baseurl,
2022-07-03 02:09:38 +00:00
encode_path(&organization_name.to_string()),
encode_path(&project_name.to_string()),
2023-02-01 05:28:12 +00:00
encode_path(&instance_name.to_string()),
2021-12-10 02:15:24 +00:00
);
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.post(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
202u16 => ResponseValue::from_response(response).await,
2022-02-08 16:59:38 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-02-08 16:59:38 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-02-08 16:59:38 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2022-02-08 16:59:38 +00:00
}
2021-12-10 02:15:24 +00:00
}
2023-02-01 05:28:12 +00:00
///Fetch an instance's serial console
///
///Use `GET /v1/instances/{instance}/serial-console` instead
2022-07-03 02:09:38 +00:00
///
///Sends a `GET` request to
2023-02-01 05:28:12 +00:00
/// `/organizations/{organization_name}/projects/{project_name}/instances/
/// {instance_name}/serial-console`
2022-07-03 02:09:38 +00:00
///
///Arguments:
2023-02-01 05:28:12 +00:00
/// - `organization_name`
/// - `project_name`
/// - `instance_name`
/// - `from_start`: Character index in the serial buffer from which to read,
/// counting the bytes output since instance start. If this is not
/// provided, `most_recent` must be provided, and if this *is* provided,
/// `most_recent` must *not* be provided.
/// - `max_bytes`: Maximum number of bytes of buffered serial console
/// contents to return. If the requested range runs to the end of the
/// available buffer, the data returned will be shorter than `max_bytes`.
/// - `most_recent`: Character index in the serial buffer from which to
/// read, counting *backward* from the most recently buffered data
/// retrieved from the instance. (See note on `from_start` about mutual
/// exclusivity)
pub async fn instance_serial_console<'a>(
2022-01-05 20:02:46 +00:00
&'a self,
organization_name: &'a types::Name,
project_name: &'a types::Name,
2023-02-01 05:28:12 +00:00
instance_name: &'a types::Name,
from_start: Option<u64>,
max_bytes: Option<u64>,
most_recent: Option<u64>,
) -> Result<ResponseValue<types::InstanceSerialConsoleData>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!(
2023-02-01 05:28:12 +00:00
"{}/organizations/{}/projects/{}/instances/{}/serial-console",
2021-12-10 02:15:24 +00:00
self.baseurl,
2022-07-03 02:09:38 +00:00
encode_path(&organization_name.to_string()),
encode_path(&project_name.to_string()),
2023-02-01 05:28:12 +00:00
encode_path(&instance_name.to_string()),
2021-12-10 02:15:24 +00:00
);
2023-10-16 18:44:24 +00:00
let mut query = Vec::with_capacity(3usize);
2023-02-01 05:28:12 +00:00
if let Some(v) = &from_start {
2023-10-16 18:44:24 +00:00
query.push(("from_start", v.to_string()));
2022-01-05 20:02:46 +00:00
}
2021-12-10 02:15:24 +00:00
2023-02-01 05:28:12 +00:00
if let Some(v) = &max_bytes {
2023-10-16 18:44:24 +00:00
query.push(("max_bytes", v.to_string()));
2022-01-05 20:02:46 +00:00
}
2023-02-01 05:28:12 +00:00
if let Some(v) = &most_recent {
2023-10-16 18:44:24 +00:00
query.push(("most_recent", v.to_string()));
2022-01-05 20:02:46 +00:00
}
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.get(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
2023-10-16 18:44:24 +00:00
.query(&query)
2023-04-25 00:42:22 +00:00
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
200u16 => ResponseValue::from_response(response).await,
2022-02-08 16:59:38 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-02-08 16:59:38 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-02-08 16:59:38 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2022-02-08 16:59:38 +00:00
}
2021-12-10 02:15:24 +00:00
}
2023-02-01 05:28:12 +00:00
///Connect to an instance's serial console
2022-07-03 02:09:38 +00:00
///
2023-02-01 05:28:12 +00:00
///Use `GET /v1/instances/{instance}/serial-console/stream` instead
2022-07-03 02:09:38 +00:00
///
2023-02-01 05:28:12 +00:00
///Sends a `GET` request to
/// `/organizations/{organization_name}/projects/{project_name}/instances/
/// {instance_name}/serial-console/stream`
pub async fn instance_serial_console_stream<'a>(
2022-01-05 20:02:46 +00:00
&'a self,
organization_name: &'a types::Name,
project_name: &'a types::Name,
2023-02-01 05:28:12 +00:00
instance_name: &'a types::Name,
) -> Result<ResponseValue<reqwest::Upgraded>, Error<reqwest::Upgraded>> {
2023-10-16 18:44:24 +00:00
let url = format!(
2023-02-01 05:28:12 +00:00
"{}/organizations/{}/projects/{}/instances/{}/serial-console/stream",
self.baseurl,
encode_path(&organization_name.to_string()),
encode_path(&project_name.to_string()),
encode_path(&instance_name.to_string()),
);
2023-10-16 18:44:24 +00:00
let request = self
2023-02-01 05:28:12 +00:00
.client
2023-10-16 18:44:24 +00:00
.get(url)
2023-02-01 05:28:12 +00:00
.header(reqwest::header::CONNECTION, "Upgrade")
.header(reqwest::header::UPGRADE, "websocket")
.header(reqwest::header::SEC_WEBSOCKET_VERSION, "13")
.header(
reqwest::header::SEC_WEBSOCKET_KEY,
base64::Engine::encode(
&base64::engine::general_purpose::STANDARD,
rand::random::<[u8; 16]>(),
),
)
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
101u16 => ResponseValue::upgrade(response).await,
200..=299 => ResponseValue::upgrade(response).await,
_ => Err(Error::UnexpectedResponse(response)),
2023-02-01 05:28:12 +00:00
}
2022-05-23 15:49:37 +00:00
}
2023-02-01 05:28:12 +00:00
///Boot an instance
2022-07-03 02:09:38 +00:00
///
2023-02-01 05:28:12 +00:00
///Use `POST /v1/instances/{instance}/start` instead
2022-07-03 02:09:38 +00:00
///
2023-02-01 05:28:12 +00:00
///Sends a `POST` request to
/// `/organizations/{organization_name}/projects/{project_name}/instances/
/// {instance_name}/start`
pub async fn instance_start<'a>(
2022-05-23 15:49:37 +00:00
&'a self,
organization_name: &'a types::Name,
project_name: &'a types::Name,
2023-02-01 05:28:12 +00:00
instance_name: &'a types::Name,
2022-05-23 15:49:37 +00:00
) -> Result<ResponseValue<types::Instance>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!(
2023-02-01 05:28:12 +00:00
"{}/organizations/{}/projects/{}/instances/{}/start",
2022-05-23 15:49:37 +00:00
self.baseurl,
2022-07-03 02:09:38 +00:00
encode_path(&organization_name.to_string()),
encode_path(&project_name.to_string()),
2023-02-01 05:28:12 +00:00
encode_path(&instance_name.to_string()),
2022-05-23 15:49:37 +00:00
);
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.post(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
202u16 => ResponseValue::from_response(response).await,
2022-05-23 15:49:37 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-05-23 15:49:37 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-05-23 15:49:37 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2022-05-23 15:49:37 +00:00
}
}
2023-02-01 05:28:12 +00:00
///Halt an instance
2022-07-03 02:09:38 +00:00
///
2023-02-01 05:28:12 +00:00
///Use `POST /v1/instances/{instance}/stop` instead
///
///Sends a `POST` request to
2022-07-03 02:09:38 +00:00
/// `/organizations/{organization_name}/projects/{project_name}/instances/
2023-02-01 05:28:12 +00:00
/// {instance_name}/stop`
pub async fn instance_stop<'a>(
2022-05-23 15:49:37 +00:00
&'a self,
organization_name: &'a types::Name,
project_name: &'a types::Name,
instance_name: &'a types::Name,
) -> Result<ResponseValue<types::Instance>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!(
2023-02-01 05:28:12 +00:00
"{}/organizations/{}/projects/{}/instances/{}/stop",
2022-05-23 15:49:37 +00:00
self.baseurl,
2022-07-03 02:09:38 +00:00
encode_path(&organization_name.to_string()),
encode_path(&project_name.to_string()),
encode_path(&instance_name.to_string()),
2022-05-23 15:49:37 +00:00
);
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.post(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
202u16 => ResponseValue::from_response(response).await,
2023-02-01 05:28:12 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2023-02-01 05:28:12 +00:00
}
}
///Fetch a project's IAM policy
///
///Use `GET /v1/projects/{project}/policy` instead
///
///Sends a `GET` request to
/// `/organizations/{organization_name}/projects/{project_name}/policy`
///
///Arguments:
/// - `organization_name`: The organization's unique name.
/// - `project_name`: The project's unique name within the organization.
pub async fn project_policy_view<'a>(
&'a self,
organization_name: &'a types::Name,
project_name: &'a types::Name,
) -> Result<ResponseValue<types::ProjectRolePolicy>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!(
2023-02-01 05:28:12 +00:00
"{}/organizations/{}/projects/{}/policy",
self.baseurl,
encode_path(&organization_name.to_string()),
encode_path(&project_name.to_string()),
);
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.get(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
200u16 => ResponseValue::from_response(response).await,
2022-05-23 15:49:37 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-05-23 15:49:37 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-05-23 15:49:37 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2022-05-23 15:49:37 +00:00
}
}
2023-02-01 05:28:12 +00:00
///Update a project's IAM policy
2022-07-03 02:09:38 +00:00
///
2023-02-01 05:28:12 +00:00
///Sends a `PUT` request to
/// `/organizations/{organization_name}/projects/{project_name}/policy`
///
///Arguments:
/// - `organization_name`: The organization's unique name.
/// - `project_name`: The project's unique name within the organization.
/// - `body`
pub async fn project_policy_update<'a>(
2022-05-23 15:49:37 +00:00
&'a self,
organization_name: &'a types::Name,
project_name: &'a types::Name,
2023-02-01 05:28:12 +00:00
body: &'a types::ProjectRolePolicy,
) -> Result<ResponseValue<types::ProjectRolePolicy>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!(
2023-02-01 05:28:12 +00:00
"{}/organizations/{}/projects/{}/policy",
2022-05-23 15:49:37 +00:00
self.baseurl,
2022-07-03 02:09:38 +00:00
encode_path(&organization_name.to_string()),
encode_path(&project_name.to_string()),
2022-05-23 15:49:37 +00:00
);
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.put(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
.json(&body)
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
200u16 => ResponseValue::from_response(response).await,
2022-05-23 15:49:37 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-05-23 15:49:37 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-05-23 15:49:37 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2022-05-23 15:49:37 +00:00
}
}
2023-02-01 05:28:12 +00:00
///List snapshots
2022-07-03 02:09:38 +00:00
///
///Sends a `GET` request to
2023-02-01 05:28:12 +00:00
/// `/organizations/{organization_name}/projects/{project_name}/snapshots`
2022-07-03 02:09:38 +00:00
///
///Arguments:
2023-02-01 05:28:12 +00:00
/// - `organization_name`: The organization's unique name.
/// - `project_name`: The project's unique name within the organization.
2022-07-03 02:09:38 +00:00
/// - `limit`: Maximum number of items returned by a single call
2022-07-08 01:35:36 +00:00
/// - `page_token`: Token returned by previous call to retrieve the
2022-07-03 02:09:38 +00:00
/// subsequent page
/// - `sort_by`
2023-02-01 05:28:12 +00:00
pub async fn snapshot_list<'a>(
2022-05-23 15:49:37 +00:00
&'a self,
organization_name: &'a types::Name,
project_name: &'a types::Name,
limit: Option<std::num::NonZeroU32>,
page_token: Option<&'a str>,
sort_by: Option<types::NameSortMode>,
2023-02-01 05:28:12 +00:00
) -> Result<ResponseValue<types::SnapshotResultsPage>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!(
2023-02-01 05:28:12 +00:00
"{}/organizations/{}/projects/{}/snapshots",
2022-05-23 15:49:37 +00:00
self.baseurl,
2022-07-03 02:09:38 +00:00
encode_path(&organization_name.to_string()),
encode_path(&project_name.to_string()),
2022-05-23 15:49:37 +00:00
);
2023-10-16 18:44:24 +00:00
let mut query = Vec::with_capacity(3usize);
2022-05-23 15:49:37 +00:00
if let Some(v) = &limit {
2023-10-16 18:44:24 +00:00
query.push(("limit", v.to_string()));
2022-05-23 15:49:37 +00:00
}
if let Some(v) = &page_token {
2023-10-16 18:44:24 +00:00
query.push(("page_token", v.to_string()));
2022-05-23 15:49:37 +00:00
}
if let Some(v) = &sort_by {
2023-10-16 18:44:24 +00:00
query.push(("sort_by", v.to_string()));
2022-05-23 15:49:37 +00:00
}
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.get(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
2023-10-16 18:44:24 +00:00
.query(&query)
2023-04-25 00:42:22 +00:00
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
200u16 => ResponseValue::from_response(response).await,
2022-05-23 15:49:37 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-05-23 15:49:37 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-05-23 15:49:37 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2022-05-23 15:49:37 +00:00
}
}
2023-02-01 05:28:12 +00:00
///List snapshots as a Stream
2022-07-03 02:09:38 +00:00
///
///Sends repeated `GET` requests to
2023-02-01 05:28:12 +00:00
/// `/organizations/{organization_name}/projects/{project_name}/snapshots`
/// until there are no more results.
2022-07-03 02:09:38 +00:00
///
///Arguments:
2023-02-01 05:28:12 +00:00
/// - `organization_name`: The organization's unique name.
/// - `project_name`: The project's unique name within the organization.
2022-07-03 02:09:38 +00:00
/// - `limit`: Maximum number of items returned by a single call
/// - `sort_by`
2023-02-01 05:28:12 +00:00
pub fn snapshot_list_stream<'a>(
2022-05-23 15:49:37 +00:00
&'a self,
organization_name: &'a types::Name,
project_name: &'a types::Name,
limit: Option<std::num::NonZeroU32>,
sort_by: Option<types::NameSortMode>,
2023-02-01 05:28:12 +00:00
) -> impl futures::Stream<Item = Result<types::Snapshot, Error<types::Error>>> + Unpin + '_
{
2022-05-23 15:49:37 +00:00
use futures::StreamExt;
use futures::TryFutureExt;
use futures::TryStreamExt;
2023-05-04 03:53:28 +00:00
let final_stream_limit = limit
.clone()
.and_then(|x| std::num::NonZeroUsize::try_from(x).ok())
.map(std::num::NonZeroUsize::get)
.unwrap_or(usize::MAX);
2023-02-01 05:28:12 +00:00
self.snapshot_list(organization_name, project_name, limit, None, sort_by)
.map_ok(move |page| {
let page = page.into_inner();
2023-05-08 03:43:45 +00:00
let first = futures::stream::iter(page.items).map(Ok);
2023-02-01 05:28:12 +00:00
let rest = futures::stream::try_unfold(page.next_page, move |state| async move {
if state.is_none() {
Ok(None)
} else {
self.snapshot_list(
organization_name,
project_name,
None,
state.as_deref(),
None,
)
.map_ok(|page| {
let page = page.into_inner();
2023-05-08 03:43:45 +00:00
Some((futures::stream::iter(page.items).map(Ok), page.next_page))
2023-02-01 05:28:12 +00:00
})
.await
}
})
.try_flatten();
first.chain(rest)
2022-05-23 15:49:37 +00:00
})
2023-02-01 05:28:12 +00:00
.try_flatten_stream()
2023-05-04 03:53:28 +00:00
.take(final_stream_limit)
2023-02-01 05:28:12 +00:00
.boxed()
2022-05-23 15:49:37 +00:00
}
2023-02-01 05:28:12 +00:00
///Create a snapshot
///
///Creates a point-in-time snapshot from a disk.
///
2022-07-03 02:09:38 +00:00
///Sends a `POST` request to
2023-02-01 05:28:12 +00:00
/// `/organizations/{organization_name}/projects/{project_name}/snapshots`
///
///Arguments:
/// - `organization_name`: The organization's unique name.
/// - `project_name`: The project's unique name within the organization.
/// - `body`
pub async fn snapshot_create<'a>(
2022-05-23 15:49:37 +00:00
&'a self,
organization_name: &'a types::Name,
project_name: &'a types::Name,
2023-02-01 05:28:12 +00:00
body: &'a types::SnapshotCreate,
) -> Result<ResponseValue<types::Snapshot>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!(
2023-02-01 05:28:12 +00:00
"{}/organizations/{}/projects/{}/snapshots",
2022-05-23 15:49:37 +00:00
self.baseurl,
2022-07-03 02:09:38 +00:00
encode_path(&organization_name.to_string()),
encode_path(&project_name.to_string()),
2022-05-23 15:49:37 +00:00
);
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.post(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
.json(&body)
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
201u16 => ResponseValue::from_response(response).await,
2022-02-08 16:59:38 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-02-08 16:59:38 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-02-08 16:59:38 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2022-02-08 16:59:38 +00:00
}
2021-12-10 02:15:24 +00:00
}
2023-02-01 05:28:12 +00:00
///Fetch a snapshot
///
///Sends a `GET` request to
/// `/organizations/{organization_name}/projects/{project_name}/snapshots/
/// {snapshot_name}`
pub async fn snapshot_view<'a>(
2022-01-05 20:02:46 +00:00
&'a self,
organization_name: &'a types::Name,
project_name: &'a types::Name,
2023-02-01 05:28:12 +00:00
snapshot_name: &'a types::Name,
) -> Result<ResponseValue<types::Snapshot>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!(
2023-02-01 05:28:12 +00:00
"{}/organizations/{}/projects/{}/snapshots/{}",
2021-12-10 02:15:24 +00:00
self.baseurl,
2022-07-03 02:09:38 +00:00
encode_path(&organization_name.to_string()),
encode_path(&project_name.to_string()),
2023-02-01 05:28:12 +00:00
encode_path(&snapshot_name.to_string()),
2022-02-08 16:59:38 +00:00
);
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.get(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
200u16 => ResponseValue::from_response(response).await,
2022-02-08 16:59:38 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-02-08 16:59:38 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-02-08 16:59:38 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2022-07-27 04:23:01 +00:00
}
}
2023-02-01 05:28:12 +00:00
///Delete a snapshot
2022-07-27 04:23:01 +00:00
///
2023-02-01 05:28:12 +00:00
///Sends a `DELETE` request to
/// `/organizations/{organization_name}/projects/{project_name}/snapshots/
/// {snapshot_name}`
pub async fn snapshot_delete<'a>(
2022-02-08 16:59:38 +00:00
&'a self,
organization_name: &'a types::Name,
project_name: &'a types::Name,
2023-02-01 05:28:12 +00:00
snapshot_name: &'a types::Name,
) -> Result<ResponseValue<()>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!(
2023-02-01 05:28:12 +00:00
"{}/organizations/{}/projects/{}/snapshots/{}",
2022-02-08 16:59:38 +00:00
self.baseurl,
2022-07-03 02:09:38 +00:00
encode_path(&organization_name.to_string()),
encode_path(&project_name.to_string()),
2023-02-01 05:28:12 +00:00
encode_path(&snapshot_name.to_string()),
2021-12-10 02:15:24 +00:00
);
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.delete(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
204u16 => Ok(ResponseValue::empty(response)),
2022-02-08 16:59:38 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-02-08 16:59:38 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-02-08 16:59:38 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2022-02-08 16:59:38 +00:00
}
2021-12-10 02:15:24 +00:00
}
2023-02-01 05:28:12 +00:00
///List VPCs
2022-07-03 02:09:38 +00:00
///
///Sends a `GET` request to
2023-02-01 05:28:12 +00:00
/// `/organizations/{organization_name}/projects/{project_name}/vpcs`
2022-07-03 02:09:38 +00:00
///
///Arguments:
2023-02-01 05:28:12 +00:00
/// - `organization_name`: The organization's unique name.
/// - `project_name`: The project's unique name within the organization.
2022-07-03 02:09:38 +00:00
/// - `limit`: Maximum number of items returned by a single call
2022-07-08 01:35:36 +00:00
/// - `page_token`: Token returned by previous call to retrieve the
2022-07-03 02:09:38 +00:00
/// subsequent page
/// - `sort_by`
2023-02-01 05:28:12 +00:00
pub async fn vpc_list<'a>(
2022-03-18 06:54:10 +00:00
&'a self,
organization_name: &'a types::Name,
project_name: &'a types::Name,
limit: Option<std::num::NonZeroU32>,
page_token: Option<&'a str>,
sort_by: Option<types::NameSortMode>,
2023-02-01 05:28:12 +00:00
) -> Result<ResponseValue<types::VpcResultsPage>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!(
2023-02-01 05:28:12 +00:00
"{}/organizations/{}/projects/{}/vpcs",
2022-03-18 06:54:10 +00:00
self.baseurl,
2022-07-03 02:09:38 +00:00
encode_path(&organization_name.to_string()),
encode_path(&project_name.to_string()),
2022-03-18 06:54:10 +00:00
);
2023-10-16 18:44:24 +00:00
let mut query = Vec::with_capacity(3usize);
2022-03-18 06:54:10 +00:00
if let Some(v) = &limit {
2023-10-16 18:44:24 +00:00
query.push(("limit", v.to_string()));
2022-03-18 06:54:10 +00:00
}
if let Some(v) = &page_token {
2023-10-16 18:44:24 +00:00
query.push(("page_token", v.to_string()));
2022-03-18 06:54:10 +00:00
}
if let Some(v) = &sort_by {
2023-10-16 18:44:24 +00:00
query.push(("sort_by", v.to_string()));
2022-03-18 06:54:10 +00:00
}
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.get(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
2023-10-16 18:44:24 +00:00
.query(&query)
2023-04-25 00:42:22 +00:00
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
200u16 => ResponseValue::from_response(response).await,
2022-03-18 06:54:10 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-03-18 06:54:10 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-03-18 06:54:10 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2022-03-18 06:54:10 +00:00
}
}
2023-02-01 05:28:12 +00:00
///List VPCs as a Stream
2022-07-03 02:09:38 +00:00
///
///Sends repeated `GET` requests to
2023-02-01 05:28:12 +00:00
/// `/organizations/{organization_name}/projects/{project_name}/vpcs` until
/// there are no more results.
2022-07-03 02:09:38 +00:00
///
///Arguments:
2023-02-01 05:28:12 +00:00
/// - `organization_name`: The organization's unique name.
/// - `project_name`: The project's unique name within the organization.
2022-07-03 02:09:38 +00:00
/// - `limit`: Maximum number of items returned by a single call
/// - `sort_by`
2023-02-01 05:28:12 +00:00
pub fn vpc_list_stream<'a>(
2022-03-18 06:54:10 +00:00
&'a self,
organization_name: &'a types::Name,
project_name: &'a types::Name,
limit: Option<std::num::NonZeroU32>,
sort_by: Option<types::NameSortMode>,
2023-02-01 05:28:12 +00:00
) -> impl futures::Stream<Item = Result<types::Vpc, Error<types::Error>>> + Unpin + '_ {
2022-03-18 06:54:10 +00:00
use futures::StreamExt;
use futures::TryFutureExt;
use futures::TryStreamExt;
2023-05-04 03:53:28 +00:00
let final_stream_limit = limit
.clone()
.and_then(|x| std::num::NonZeroUsize::try_from(x).ok())
.map(std::num::NonZeroUsize::get)
.unwrap_or(usize::MAX);
2023-02-01 05:28:12 +00:00
self.vpc_list(organization_name, project_name, limit, None, sort_by)
.map_ok(move |page| {
let page = page.into_inner();
2023-05-08 03:43:45 +00:00
let first = futures::stream::iter(page.items).map(Ok);
2023-02-01 05:28:12 +00:00
let rest = futures::stream::try_unfold(page.next_page, move |state| async move {
if state.is_none() {
Ok(None)
} else {
self.vpc_list(
organization_name,
project_name,
None,
state.as_deref(),
None,
)
.map_ok(|page| {
let page = page.into_inner();
2023-05-08 03:43:45 +00:00
Some((futures::stream::iter(page.items).map(Ok), page.next_page))
2023-02-01 05:28:12 +00:00
})
.await
}
})
.try_flatten();
first.chain(rest)
2022-03-18 06:54:10 +00:00
})
2023-02-01 05:28:12 +00:00
.try_flatten_stream()
2023-05-04 03:53:28 +00:00
.take(final_stream_limit)
2023-02-01 05:28:12 +00:00
.boxed()
2022-03-18 06:54:10 +00:00
}
2023-02-01 05:28:12 +00:00
///Create a VPC
2022-07-03 02:09:38 +00:00
///
///Sends a `POST` request to
2023-02-01 05:28:12 +00:00
/// `/organizations/{organization_name}/projects/{project_name}/vpcs`
///
///Arguments:
/// - `organization_name`: The organization's unique name.
/// - `project_name`: The project's unique name within the organization.
/// - `body`
pub async fn vpc_create<'a>(
2022-03-18 06:54:10 +00:00
&'a self,
organization_name: &'a types::Name,
project_name: &'a types::Name,
2023-02-01 05:28:12 +00:00
body: &'a types::VpcCreate,
) -> Result<ResponseValue<types::Vpc>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!(
2023-02-01 05:28:12 +00:00
"{}/organizations/{}/projects/{}/vpcs",
2022-03-18 06:54:10 +00:00
self.baseurl,
2022-07-03 02:09:38 +00:00
encode_path(&organization_name.to_string()),
encode_path(&project_name.to_string()),
2022-03-18 06:54:10 +00:00
);
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.post(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
.json(&body)
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
201u16 => ResponseValue::from_response(response).await,
2022-03-18 06:54:10 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-03-18 06:54:10 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-03-18 06:54:10 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2022-03-18 06:54:10 +00:00
}
}
2023-02-01 05:28:12 +00:00
///Fetch a VPC
2022-07-03 02:09:38 +00:00
///
///Sends a `GET` request to
2023-02-01 05:28:12 +00:00
/// `/organizations/{organization_name}/projects/{project_name}/vpcs/
/// {vpc_name}`
pub async fn vpc_view<'a>(
2022-03-18 06:54:10 +00:00
&'a self,
organization_name: &'a types::Name,
project_name: &'a types::Name,
2023-02-01 05:28:12 +00:00
vpc_name: &'a types::Name,
) -> Result<ResponseValue<types::Vpc>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!(
2023-02-01 05:28:12 +00:00
"{}/organizations/{}/projects/{}/vpcs/{}",
2022-03-18 06:54:10 +00:00
self.baseurl,
2022-07-03 02:09:38 +00:00
encode_path(&organization_name.to_string()),
encode_path(&project_name.to_string()),
2023-02-01 05:28:12 +00:00
encode_path(&vpc_name.to_string()),
2022-03-18 06:54:10 +00:00
);
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.get(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
200u16 => ResponseValue::from_response(response).await,
2022-03-18 06:54:10 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-03-18 06:54:10 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-03-18 06:54:10 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2022-03-18 06:54:10 +00:00
}
}
2023-02-01 05:28:12 +00:00
///Update a VPC
2022-07-08 01:35:36 +00:00
///
///Sends a `PUT` request to
2023-02-01 05:28:12 +00:00
/// `/organizations/{organization_name}/projects/{project_name}/vpcs/
/// {vpc_name}`
pub async fn vpc_update<'a>(
2022-07-08 01:35:36 +00:00
&'a self,
organization_name: &'a types::Name,
project_name: &'a types::Name,
2023-02-01 05:28:12 +00:00
vpc_name: &'a types::Name,
body: &'a types::VpcUpdate,
) -> Result<ResponseValue<types::Vpc>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!(
2023-02-01 05:28:12 +00:00
"{}/organizations/{}/projects/{}/vpcs/{}",
2022-07-08 01:35:36 +00:00
self.baseurl,
encode_path(&organization_name.to_string()),
encode_path(&project_name.to_string()),
2023-02-01 05:28:12 +00:00
encode_path(&vpc_name.to_string()),
2022-07-08 01:35:36 +00:00
);
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.put(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
.json(&body)
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
200u16 => ResponseValue::from_response(response).await,
2022-07-08 01:35:36 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-07-08 01:35:36 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-07-08 01:35:36 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2022-07-08 01:35:36 +00:00
}
}
2023-02-01 05:28:12 +00:00
///Delete a VPC
2022-07-08 01:35:36 +00:00
///
2022-07-03 02:09:38 +00:00
///Sends a `DELETE` request to
2023-02-01 05:28:12 +00:00
/// `/organizations/{organization_name}/projects/{project_name}/vpcs/
/// {vpc_name}`
pub async fn vpc_delete<'a>(
2022-03-18 06:54:10 +00:00
&'a self,
organization_name: &'a types::Name,
project_name: &'a types::Name,
2023-02-01 05:28:12 +00:00
vpc_name: &'a types::Name,
2022-03-18 06:54:10 +00:00
) -> Result<ResponseValue<()>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!(
2023-02-01 05:28:12 +00:00
"{}/organizations/{}/projects/{}/vpcs/{}",
2022-03-18 06:54:10 +00:00
self.baseurl,
2022-07-03 02:09:38 +00:00
encode_path(&organization_name.to_string()),
encode_path(&project_name.to_string()),
2023-02-01 05:28:12 +00:00
encode_path(&vpc_name.to_string()),
2022-03-18 06:54:10 +00:00
);
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.delete(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
204u16 => Ok(ResponseValue::empty(response)),
2022-03-18 06:54:10 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-03-18 06:54:10 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-03-18 06:54:10 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2022-03-18 06:54:10 +00:00
}
}
2023-02-01 05:28:12 +00:00
///List firewall rules
2022-07-03 02:09:38 +00:00
///
2023-02-01 05:28:12 +00:00
///Sends a `GET` request to
/// `/organizations/{organization_name}/projects/{project_name}/vpcs/
/// {vpc_name}/firewall/rules`
pub async fn vpc_firewall_rules_view<'a>(
2022-01-05 20:02:46 +00:00
&'a self,
organization_name: &'a types::Name,
project_name: &'a types::Name,
2023-02-01 05:28:12 +00:00
vpc_name: &'a types::Name,
) -> Result<ResponseValue<types::VpcFirewallRules>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!(
2023-02-01 05:28:12 +00:00
"{}/organizations/{}/projects/{}/vpcs/{}/firewall/rules",
2021-12-10 02:15:24 +00:00
self.baseurl,
2022-07-03 02:09:38 +00:00
encode_path(&organization_name.to_string()),
encode_path(&project_name.to_string()),
2023-02-01 05:28:12 +00:00
encode_path(&vpc_name.to_string()),
2021-12-10 02:15:24 +00:00
);
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.get(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
200u16 => ResponseValue::from_response(response).await,
2022-02-08 16:59:38 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-02-08 16:59:38 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-02-08 16:59:38 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2022-02-08 16:59:38 +00:00
}
2021-12-10 02:15:24 +00:00
}
2023-02-01 05:28:12 +00:00
///Replace firewall rules
2022-07-08 01:35:36 +00:00
///
2023-02-01 05:28:12 +00:00
///Sends a `PUT` request to
/// `/organizations/{organization_name}/projects/{project_name}/vpcs/
/// {vpc_name}/firewall/rules`
pub async fn vpc_firewall_rules_update<'a>(
2022-07-08 01:35:36 +00:00
&'a self,
organization_name: &'a types::Name,
project_name: &'a types::Name,
2023-02-01 05:28:12 +00:00
vpc_name: &'a types::Name,
body: &'a types::VpcFirewallRuleUpdateParams,
) -> Result<ResponseValue<types::VpcFirewallRules>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!(
2023-02-01 05:28:12 +00:00
"{}/organizations/{}/projects/{}/vpcs/{}/firewall/rules",
2022-07-08 01:35:36 +00:00
self.baseurl,
encode_path(&organization_name.to_string()),
encode_path(&project_name.to_string()),
2023-02-01 05:28:12 +00:00
encode_path(&vpc_name.to_string()),
);
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.put(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
.json(&body)
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
200u16 => ResponseValue::from_response(response).await,
2023-02-01 05:28:12 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2023-02-01 05:28:12 +00:00
}
}
///List routers
///
///Sends a `GET` request to
/// `/organizations/{organization_name}/projects/{project_name}/vpcs/
/// {vpc_name}/routers`
///
///Arguments:
/// - `organization_name`
/// - `project_name`
/// - `vpc_name`
/// - `limit`: Maximum number of items returned by a single call
/// - `page_token`: Token returned by previous call to retrieve the
/// subsequent page
/// - `sort_by`
pub async fn vpc_router_list<'a>(
&'a self,
organization_name: &'a types::Name,
project_name: &'a types::Name,
vpc_name: &'a types::Name,
limit: Option<std::num::NonZeroU32>,
page_token: Option<&'a str>,
sort_by: Option<types::NameSortMode>,
) -> Result<ResponseValue<types::VpcRouterResultsPage>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!(
2023-02-01 05:28:12 +00:00
"{}/organizations/{}/projects/{}/vpcs/{}/routers",
self.baseurl,
encode_path(&organization_name.to_string()),
encode_path(&project_name.to_string()),
encode_path(&vpc_name.to_string()),
2022-07-08 01:35:36 +00:00
);
2023-10-16 18:44:24 +00:00
let mut query = Vec::with_capacity(3usize);
2023-02-01 05:28:12 +00:00
if let Some(v) = &limit {
2023-10-16 18:44:24 +00:00
query.push(("limit", v.to_string()));
2022-07-08 01:35:36 +00:00
}
2023-02-01 05:28:12 +00:00
if let Some(v) = &page_token {
2023-10-16 18:44:24 +00:00
query.push(("page_token", v.to_string()));
2022-07-08 01:35:36 +00:00
}
2023-02-01 05:28:12 +00:00
if let Some(v) = &sort_by {
2023-10-16 18:44:24 +00:00
query.push(("sort_by", v.to_string()));
2022-07-08 01:35:36 +00:00
}
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.get(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
2023-10-16 18:44:24 +00:00
.query(&query)
2023-04-25 00:42:22 +00:00
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
200u16 => ResponseValue::from_response(response).await,
2022-07-08 01:35:36 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-07-08 01:35:36 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-07-08 01:35:36 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2022-07-08 01:35:36 +00:00
}
}
2023-02-01 05:28:12 +00:00
///List routers as a Stream
///
///Sends repeated `GET` requests to
/// `/organizations/{organization_name}/projects/{project_name}/vpcs/
/// {vpc_name}/routers` until there are no more results.
///
///Arguments:
/// - `organization_name`
/// - `project_name`
/// - `vpc_name`
/// - `limit`: Maximum number of items returned by a single call
/// - `sort_by`
pub fn vpc_router_list_stream<'a>(
&'a self,
organization_name: &'a types::Name,
project_name: &'a types::Name,
vpc_name: &'a types::Name,
limit: Option<std::num::NonZeroU32>,
sort_by: Option<types::NameSortMode>,
) -> impl futures::Stream<Item = Result<types::VpcRouter, Error<types::Error>>> + Unpin + '_
{
use futures::StreamExt;
use futures::TryFutureExt;
use futures::TryStreamExt;
2023-05-04 03:53:28 +00:00
let final_stream_limit = limit
.clone()
.and_then(|x| std::num::NonZeroUsize::try_from(x).ok())
.map(std::num::NonZeroUsize::get)
.unwrap_or(usize::MAX);
2023-02-01 05:28:12 +00:00
self.vpc_router_list(
organization_name,
project_name,
vpc_name,
limit,
None,
sort_by,
)
.map_ok(move |page| {
let page = page.into_inner();
2023-05-08 03:43:45 +00:00
let first = futures::stream::iter(page.items).map(Ok);
2023-02-01 05:28:12 +00:00
let rest = futures::stream::try_unfold(page.next_page, move |state| async move {
if state.is_none() {
Ok(None)
} else {
self.vpc_router_list(
organization_name,
project_name,
vpc_name,
None,
state.as_deref(),
None,
)
.map_ok(|page| {
let page = page.into_inner();
2023-05-08 03:43:45 +00:00
Some((futures::stream::iter(page.items).map(Ok), page.next_page))
2023-02-01 05:28:12 +00:00
})
.await
}
})
.try_flatten();
first.chain(rest)
})
.try_flatten_stream()
2023-05-04 03:53:28 +00:00
.take(final_stream_limit)
2023-02-01 05:28:12 +00:00
.boxed()
}
///Create a router
2022-07-03 02:09:38 +00:00
///
///Sends a `POST` request to
2023-02-01 05:28:12 +00:00
/// `/organizations/{organization_name}/projects/{project_name}/vpcs/
/// {vpc_name}/routers`
pub async fn vpc_router_create<'a>(
2022-01-05 20:02:46 +00:00
&'a self,
organization_name: &'a types::Name,
project_name: &'a types::Name,
2023-02-01 05:28:12 +00:00
vpc_name: &'a types::Name,
body: &'a types::VpcRouterCreate,
) -> Result<ResponseValue<types::VpcRouter>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!(
2023-02-01 05:28:12 +00:00
"{}/organizations/{}/projects/{}/vpcs/{}/routers",
2021-12-10 02:15:24 +00:00
self.baseurl,
2022-07-03 02:09:38 +00:00
encode_path(&organization_name.to_string()),
encode_path(&project_name.to_string()),
2023-02-01 05:28:12 +00:00
encode_path(&vpc_name.to_string()),
2021-12-10 02:15:24 +00:00
);
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.post(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
.json(&body)
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
201u16 => ResponseValue::from_response(response).await,
2022-02-08 16:59:38 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-02-08 16:59:38 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-02-08 16:59:38 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2022-02-08 16:59:38 +00:00
}
2021-12-10 02:15:24 +00:00
}
2023-02-01 05:28:12 +00:00
///Get a router
2022-07-03 02:09:38 +00:00
///
2023-02-01 05:28:12 +00:00
///Sends a `GET` request to
/// `/organizations/{organization_name}/projects/{project_name}/vpcs/
/// {vpc_name}/routers/{router_name}`
pub async fn vpc_router_view<'a>(
2022-01-05 20:02:46 +00:00
&'a self,
organization_name: &'a types::Name,
project_name: &'a types::Name,
2023-02-01 05:28:12 +00:00
vpc_name: &'a types::Name,
router_name: &'a types::Name,
) -> Result<ResponseValue<types::VpcRouter>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!(
2023-02-01 05:28:12 +00:00
"{}/organizations/{}/projects/{}/vpcs/{}/routers/{}",
2021-12-10 02:15:24 +00:00
self.baseurl,
2022-07-03 02:09:38 +00:00
encode_path(&organization_name.to_string()),
encode_path(&project_name.to_string()),
2023-02-01 05:28:12 +00:00
encode_path(&vpc_name.to_string()),
encode_path(&router_name.to_string()),
2021-12-10 02:15:24 +00:00
);
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.get(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
200u16 => ResponseValue::from_response(response).await,
2022-02-08 16:59:38 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-02-08 16:59:38 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-02-08 16:59:38 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2022-02-08 16:59:38 +00:00
}
2021-12-10 02:15:24 +00:00
}
2023-02-01 05:28:12 +00:00
///Update a router
2022-07-03 02:09:38 +00:00
///
2023-02-01 05:28:12 +00:00
///Sends a `PUT` request to
/// `/organizations/{organization_name}/projects/{project_name}/vpcs/
/// {vpc_name}/routers/{router_name}`
pub async fn vpc_router_update<'a>(
2022-03-18 06:54:10 +00:00
&'a self,
organization_name: &'a types::Name,
project_name: &'a types::Name,
2023-02-01 05:28:12 +00:00
vpc_name: &'a types::Name,
router_name: &'a types::Name,
body: &'a types::VpcRouterUpdate,
) -> Result<ResponseValue<types::VpcRouter>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!(
2023-02-01 05:28:12 +00:00
"{}/organizations/{}/projects/{}/vpcs/{}/routers/{}",
2022-03-18 06:54:10 +00:00
self.baseurl,
2022-07-03 02:09:38 +00:00
encode_path(&organization_name.to_string()),
encode_path(&project_name.to_string()),
2023-02-01 05:28:12 +00:00
encode_path(&vpc_name.to_string()),
encode_path(&router_name.to_string()),
2022-03-18 06:54:10 +00:00
);
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.put(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
.json(&body)
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
200u16 => ResponseValue::from_response(response).await,
2022-03-18 06:54:10 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-03-18 06:54:10 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-03-18 06:54:10 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2022-03-18 06:54:10 +00:00
}
}
2023-02-01 05:28:12 +00:00
///Delete a router
2022-07-03 02:09:38 +00:00
///
2023-02-01 05:28:12 +00:00
///Sends a `DELETE` request to
/// `/organizations/{organization_name}/projects/{project_name}/vpcs/
/// {vpc_name}/routers/{router_name}`
pub async fn vpc_router_delete<'a>(
2022-05-23 15:49:37 +00:00
&'a self,
organization_name: &'a types::Name,
project_name: &'a types::Name,
2023-02-01 05:28:12 +00:00
vpc_name: &'a types::Name,
router_name: &'a types::Name,
) -> Result<ResponseValue<()>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!(
2023-02-01 05:28:12 +00:00
"{}/organizations/{}/projects/{}/vpcs/{}/routers/{}",
2022-05-23 15:49:37 +00:00
self.baseurl,
2022-07-03 02:09:38 +00:00
encode_path(&organization_name.to_string()),
encode_path(&project_name.to_string()),
2023-02-01 05:28:12 +00:00
encode_path(&vpc_name.to_string()),
encode_path(&router_name.to_string()),
2022-05-23 15:49:37 +00:00
);
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.delete(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
204u16 => Ok(ResponseValue::empty(response)),
2022-05-23 15:49:37 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-05-23 15:49:37 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-05-23 15:49:37 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2022-05-23 15:49:37 +00:00
}
}
2023-02-01 05:28:12 +00:00
///List routes
///
///List the routes associated with a router in a particular VPC.
2022-07-03 02:09:38 +00:00
///
///Sends a `GET` request to
2023-02-01 05:28:12 +00:00
/// `/organizations/{organization_name}/projects/{project_name}/vpcs/
/// {vpc_name}/routers/{router_name}/routes`
2022-07-03 02:09:38 +00:00
///
///Arguments:
2023-02-01 05:28:12 +00:00
/// - `organization_name`
/// - `project_name`
/// - `vpc_name`
/// - `router_name`
2022-07-03 02:09:38 +00:00
/// - `limit`: Maximum number of items returned by a single call
2022-07-08 01:35:36 +00:00
/// - `page_token`: Token returned by previous call to retrieve the
2022-07-03 02:09:38 +00:00
/// subsequent page
/// - `sort_by`
2023-02-01 05:28:12 +00:00
pub async fn vpc_router_route_list<'a>(
2022-05-23 15:49:37 +00:00
&'a self,
organization_name: &'a types::Name,
project_name: &'a types::Name,
2023-02-01 05:28:12 +00:00
vpc_name: &'a types::Name,
router_name: &'a types::Name,
2022-05-23 15:49:37 +00:00
limit: Option<std::num::NonZeroU32>,
page_token: Option<&'a str>,
sort_by: Option<types::NameSortMode>,
2023-02-01 05:28:12 +00:00
) -> Result<ResponseValue<types::RouterRouteResultsPage>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!(
2023-02-01 05:28:12 +00:00
"{}/organizations/{}/projects/{}/vpcs/{}/routers/{}/routes",
2022-05-23 15:49:37 +00:00
self.baseurl,
2022-07-03 02:09:38 +00:00
encode_path(&organization_name.to_string()),
encode_path(&project_name.to_string()),
2023-02-01 05:28:12 +00:00
encode_path(&vpc_name.to_string()),
encode_path(&router_name.to_string()),
2022-05-23 15:49:37 +00:00
);
2023-10-16 18:44:24 +00:00
let mut query = Vec::with_capacity(3usize);
2022-05-23 15:49:37 +00:00
if let Some(v) = &limit {
2023-10-16 18:44:24 +00:00
query.push(("limit", v.to_string()));
2022-05-23 15:49:37 +00:00
}
if let Some(v) = &page_token {
2023-10-16 18:44:24 +00:00
query.push(("page_token", v.to_string()));
2022-05-23 15:49:37 +00:00
}
if let Some(v) = &sort_by {
2023-10-16 18:44:24 +00:00
query.push(("sort_by", v.to_string()));
2022-05-23 15:49:37 +00:00
}
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.get(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
2023-10-16 18:44:24 +00:00
.query(&query)
2023-04-25 00:42:22 +00:00
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
200u16 => ResponseValue::from_response(response).await,
2022-05-23 15:49:37 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-05-23 15:49:37 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-05-23 15:49:37 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2022-05-23 15:49:37 +00:00
}
}
2023-02-01 05:28:12 +00:00
///List routes as a Stream
///
///List the routes associated with a router in a particular VPC.
2022-07-03 02:09:38 +00:00
///
///Sends repeated `GET` requests to
2023-02-01 05:28:12 +00:00
/// `/organizations/{organization_name}/projects/{project_name}/vpcs/
/// {vpc_name}/routers/{router_name}/routes` until there are no more
/// results.
2022-07-03 02:09:38 +00:00
///
///Arguments:
2023-02-01 05:28:12 +00:00
/// - `organization_name`
/// - `project_name`
/// - `vpc_name`
/// - `router_name`
/// - `limit`: Maximum number of items returned by a single call
/// - `sort_by`
pub fn vpc_router_route_list_stream<'a>(
2022-03-18 06:54:10 +00:00
&'a self,
organization_name: &'a types::Name,
project_name: &'a types::Name,
2023-02-01 05:28:12 +00:00
vpc_name: &'a types::Name,
router_name: &'a types::Name,
2022-03-18 06:54:10 +00:00
limit: Option<std::num::NonZeroU32>,
sort_by: Option<types::NameSortMode>,
2023-02-01 05:28:12 +00:00
) -> impl futures::Stream<Item = Result<types::RouterRoute, Error<types::Error>>> + Unpin + '_
2022-03-18 06:54:10 +00:00
{
use futures::StreamExt;
use futures::TryFutureExt;
use futures::TryStreamExt;
2023-05-04 03:53:28 +00:00
let final_stream_limit = limit
.clone()
.and_then(|x| std::num::NonZeroUsize::try_from(x).ok())
.map(std::num::NonZeroUsize::get)
.unwrap_or(usize::MAX);
2023-02-01 05:28:12 +00:00
self.vpc_router_route_list(
organization_name,
project_name,
vpc_name,
router_name,
limit,
None,
sort_by,
)
.map_ok(move |page| {
let page = page.into_inner();
2023-05-08 03:43:45 +00:00
let first = futures::stream::iter(page.items).map(Ok);
2023-02-01 05:28:12 +00:00
let rest = futures::stream::try_unfold(page.next_page, move |state| async move {
if state.is_none() {
Ok(None)
} else {
self.vpc_router_route_list(
organization_name,
project_name,
vpc_name,
router_name,
None,
state.as_deref(),
None,
)
.map_ok(|page| {
let page = page.into_inner();
2023-05-08 03:43:45 +00:00
Some((futures::stream::iter(page.items).map(Ok), page.next_page))
2023-02-01 05:28:12 +00:00
})
.await
}
2022-03-18 06:54:10 +00:00
})
2023-02-01 05:28:12 +00:00
.try_flatten();
first.chain(rest)
})
.try_flatten_stream()
2023-05-04 03:53:28 +00:00
.take(final_stream_limit)
2023-02-01 05:28:12 +00:00
.boxed()
2022-03-18 06:54:10 +00:00
}
2023-02-01 05:28:12 +00:00
///Create a router
2022-07-03 02:09:38 +00:00
///
///Sends a `POST` request to
2023-02-01 05:28:12 +00:00
/// `/organizations/{organization_name}/projects/{project_name}/vpcs/
/// {vpc_name}/routers/{router_name}/routes`
pub async fn vpc_router_route_create<'a>(
2022-03-18 06:54:10 +00:00
&'a self,
organization_name: &'a types::Name,
project_name: &'a types::Name,
2023-02-01 05:28:12 +00:00
vpc_name: &'a types::Name,
router_name: &'a types::Name,
body: &'a types::RouterRouteCreateParams,
) -> Result<ResponseValue<types::RouterRoute>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!(
2023-02-01 05:28:12 +00:00
"{}/organizations/{}/projects/{}/vpcs/{}/routers/{}/routes",
2022-03-18 06:54:10 +00:00
self.baseurl,
2022-07-03 02:09:38 +00:00
encode_path(&organization_name.to_string()),
encode_path(&project_name.to_string()),
2023-02-01 05:28:12 +00:00
encode_path(&vpc_name.to_string()),
encode_path(&router_name.to_string()),
2022-03-18 06:54:10 +00:00
);
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.post(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
.json(&body)
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
201u16 => ResponseValue::from_response(response).await,
2022-03-18 06:54:10 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-03-18 06:54:10 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-03-18 06:54:10 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2022-03-18 06:54:10 +00:00
}
}
2023-02-01 05:28:12 +00:00
///Fetch a route
2022-07-03 02:09:38 +00:00
///
///Sends a `GET` request to
2023-02-01 05:28:12 +00:00
/// `/organizations/{organization_name}/projects/{project_name}/vpcs/
/// {vpc_name}/routers/{router_name}/routes/{route_name}`
pub async fn vpc_router_route_view<'a>(
2022-03-18 06:54:10 +00:00
&'a self,
organization_name: &'a types::Name,
project_name: &'a types::Name,
2023-02-01 05:28:12 +00:00
vpc_name: &'a types::Name,
router_name: &'a types::Name,
route_name: &'a types::Name,
) -> Result<ResponseValue<types::RouterRoute>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!(
2023-02-01 05:28:12 +00:00
"{}/organizations/{}/projects/{}/vpcs/{}/routers/{}/routes/{}",
2022-03-18 06:54:10 +00:00
self.baseurl,
2022-07-03 02:09:38 +00:00
encode_path(&organization_name.to_string()),
encode_path(&project_name.to_string()),
2023-02-01 05:28:12 +00:00
encode_path(&vpc_name.to_string()),
encode_path(&router_name.to_string()),
encode_path(&route_name.to_string()),
2022-03-18 06:54:10 +00:00
);
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.get(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
200u16 => ResponseValue::from_response(response).await,
2022-03-18 06:54:10 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-03-18 06:54:10 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-03-18 06:54:10 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2022-03-18 06:54:10 +00:00
}
}
2023-02-01 05:28:12 +00:00
///Update a route
///
///Sends a `PUT` request to
/// `/organizations/{organization_name}/projects/{project_name}/vpcs/
/// {vpc_name}/routers/{router_name}/routes/{route_name}`
pub async fn vpc_router_route_update<'a>(
&'a self,
organization_name: &'a types::Name,
project_name: &'a types::Name,
vpc_name: &'a types::Name,
router_name: &'a types::Name,
route_name: &'a types::Name,
body: &'a types::RouterRouteUpdateParams,
) -> Result<ResponseValue<types::RouterRoute>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!(
2023-02-01 05:28:12 +00:00
"{}/organizations/{}/projects/{}/vpcs/{}/routers/{}/routes/{}",
self.baseurl,
encode_path(&organization_name.to_string()),
encode_path(&project_name.to_string()),
encode_path(&vpc_name.to_string()),
encode_path(&router_name.to_string()),
encode_path(&route_name.to_string()),
);
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.put(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
.json(&body)
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
200u16 => ResponseValue::from_response(response).await,
2023-02-01 05:28:12 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2023-02-01 05:28:12 +00:00
}
}
///Delete a route
2022-07-03 02:09:38 +00:00
///
///Sends a `DELETE` request to
2023-02-01 05:28:12 +00:00
/// `/organizations/{organization_name}/projects/{project_name}/vpcs/
/// {vpc_name}/routers/{router_name}/routes/{route_name}`
pub async fn vpc_router_route_delete<'a>(
2022-03-18 06:54:10 +00:00
&'a self,
organization_name: &'a types::Name,
project_name: &'a types::Name,
2023-02-01 05:28:12 +00:00
vpc_name: &'a types::Name,
router_name: &'a types::Name,
route_name: &'a types::Name,
2022-03-18 06:54:10 +00:00
) -> Result<ResponseValue<()>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!(
2023-02-01 05:28:12 +00:00
"{}/organizations/{}/projects/{}/vpcs/{}/routers/{}/routes/{}",
2022-03-18 06:54:10 +00:00
self.baseurl,
2022-07-03 02:09:38 +00:00
encode_path(&organization_name.to_string()),
encode_path(&project_name.to_string()),
2023-02-01 05:28:12 +00:00
encode_path(&vpc_name.to_string()),
encode_path(&router_name.to_string()),
encode_path(&route_name.to_string()),
2022-03-18 06:54:10 +00:00
);
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.delete(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
204u16 => Ok(ResponseValue::empty(response)),
2022-03-18 06:54:10 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-03-18 06:54:10 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-03-18 06:54:10 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2022-03-18 06:54:10 +00:00
}
}
2023-02-01 05:28:12 +00:00
///List subnets
2022-07-03 02:09:38 +00:00
///
///Sends a `GET` request to
2023-02-01 05:28:12 +00:00
/// `/organizations/{organization_name}/projects/{project_name}/vpcs/
/// {vpc_name}/subnets`
2022-07-03 02:09:38 +00:00
///
///Arguments:
2023-02-01 05:28:12 +00:00
/// - `organization_name`
/// - `project_name`
/// - `vpc_name`
2022-07-03 02:09:38 +00:00
/// - `limit`: Maximum number of items returned by a single call
2022-07-08 01:35:36 +00:00
/// - `page_token`: Token returned by previous call to retrieve the
2022-07-03 02:09:38 +00:00
/// subsequent page
/// - `sort_by`
2023-02-01 05:28:12 +00:00
pub async fn vpc_subnet_list<'a>(
2022-01-05 20:02:46 +00:00
&'a self,
organization_name: &'a types::Name,
project_name: &'a types::Name,
2023-02-01 05:28:12 +00:00
vpc_name: &'a types::Name,
2021-12-10 02:15:24 +00:00
limit: Option<std::num::NonZeroU32>,
2022-01-05 20:02:46 +00:00
page_token: Option<&'a str>,
2021-12-10 02:15:24 +00:00
sort_by: Option<types::NameSortMode>,
2023-02-01 05:28:12 +00:00
) -> Result<ResponseValue<types::VpcSubnetResultsPage>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!(
2023-02-01 05:28:12 +00:00
"{}/organizations/{}/projects/{}/vpcs/{}/subnets",
2021-12-10 02:15:24 +00:00
self.baseurl,
2022-07-03 02:09:38 +00:00
encode_path(&organization_name.to_string()),
encode_path(&project_name.to_string()),
2023-02-01 05:28:12 +00:00
encode_path(&vpc_name.to_string()),
2021-12-10 02:15:24 +00:00
);
2023-10-16 18:44:24 +00:00
let mut query = Vec::with_capacity(3usize);
2021-12-10 02:15:24 +00:00
if let Some(v) = &limit {
2023-10-16 18:44:24 +00:00
query.push(("limit", v.to_string()));
2021-12-10 02:15:24 +00:00
}
if let Some(v) = &page_token {
2023-10-16 18:44:24 +00:00
query.push(("page_token", v.to_string()));
2021-12-10 02:15:24 +00:00
}
if let Some(v) = &sort_by {
2023-10-16 18:44:24 +00:00
query.push(("sort_by", v.to_string()));
2021-12-10 02:15:24 +00:00
}
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.get(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
2023-10-16 18:44:24 +00:00
.query(&query)
2023-04-25 00:42:22 +00:00
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
200u16 => ResponseValue::from_response(response).await,
2022-02-08 16:59:38 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-02-08 16:59:38 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-02-08 16:59:38 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2022-02-08 16:59:38 +00:00
}
2021-12-10 02:15:24 +00:00
}
2023-02-01 05:28:12 +00:00
///List subnets as a Stream
2022-07-03 02:09:38 +00:00
///
///Sends repeated `GET` requests to
2023-02-01 05:28:12 +00:00
/// `/organizations/{organization_name}/projects/{project_name}/vpcs/
/// {vpc_name}/subnets` until there are no more results.
2022-07-03 02:09:38 +00:00
///
///Arguments:
2023-02-01 05:28:12 +00:00
/// - `organization_name`
/// - `project_name`
/// - `vpc_name`
2022-07-03 02:09:38 +00:00
/// - `limit`: Maximum number of items returned by a single call
/// - `sort_by`
2023-02-01 05:28:12 +00:00
pub fn vpc_subnet_list_stream<'a>(
2022-01-05 20:02:46 +00:00
&'a self,
organization_name: &'a types::Name,
project_name: &'a types::Name,
2023-02-01 05:28:12 +00:00
vpc_name: &'a types::Name,
2022-01-05 20:02:46 +00:00
limit: Option<std::num::NonZeroU32>,
sort_by: Option<types::NameSortMode>,
2023-02-01 05:28:12 +00:00
) -> impl futures::Stream<Item = Result<types::VpcSubnet, Error<types::Error>>> + Unpin + '_
{
2022-01-05 20:02:46 +00:00
use futures::StreamExt;
use futures::TryFutureExt;
use futures::TryStreamExt;
2023-05-04 03:53:28 +00:00
let final_stream_limit = limit
.clone()
.and_then(|x| std::num::NonZeroUsize::try_from(x).ok())
.map(std::num::NonZeroUsize::get)
.unwrap_or(usize::MAX);
2023-02-01 05:28:12 +00:00
self.vpc_subnet_list(
organization_name,
project_name,
vpc_name,
limit,
None,
sort_by,
)
.map_ok(move |page| {
let page = page.into_inner();
2023-05-08 03:43:45 +00:00
let first = futures::stream::iter(page.items).map(Ok);
2023-02-01 05:28:12 +00:00
let rest = futures::stream::try_unfold(page.next_page, move |state| async move {
if state.is_none() {
Ok(None)
} else {
self.vpc_subnet_list(
organization_name,
project_name,
vpc_name,
None,
state.as_deref(),
None,
)
.map_ok(|page| {
let page = page.into_inner();
2023-05-08 03:43:45 +00:00
Some((futures::stream::iter(page.items).map(Ok), page.next_page))
2023-02-01 05:28:12 +00:00
})
.await
}
})
.try_flatten();
first.chain(rest)
})
.try_flatten_stream()
2023-05-04 03:53:28 +00:00
.take(final_stream_limit)
2023-02-01 05:28:12 +00:00
.boxed()
2021-12-10 02:15:24 +00:00
}
2023-02-01 05:28:12 +00:00
///Create a subnet
2022-07-03 02:09:38 +00:00
///
2023-02-01 05:28:12 +00:00
///Sends a `POST` request to
2022-07-03 02:09:38 +00:00
/// `/organizations/{organization_name}/projects/{project_name}/vpcs/
2023-02-01 05:28:12 +00:00
/// {vpc_name}/subnets`
pub async fn vpc_subnet_create<'a>(
2022-01-05 20:02:46 +00:00
&'a self,
organization_name: &'a types::Name,
project_name: &'a types::Name,
vpc_name: &'a types::Name,
2023-02-01 05:28:12 +00:00
body: &'a types::VpcSubnetCreate,
) -> Result<ResponseValue<types::VpcSubnet>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!(
2023-02-01 05:28:12 +00:00
"{}/organizations/{}/projects/{}/vpcs/{}/subnets",
2021-12-10 02:15:24 +00:00
self.baseurl,
2022-07-03 02:09:38 +00:00
encode_path(&organization_name.to_string()),
encode_path(&project_name.to_string()),
encode_path(&vpc_name.to_string()),
2021-12-10 02:15:24 +00:00
);
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.post(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
.json(&body)
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
201u16 => ResponseValue::from_response(response).await,
2022-02-08 16:59:38 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-02-08 16:59:38 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-02-08 16:59:38 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2022-02-08 16:59:38 +00:00
}
2021-12-10 02:15:24 +00:00
}
2023-02-01 05:28:12 +00:00
///Fetch a subnet
2022-07-03 02:09:38 +00:00
///
2023-02-01 05:28:12 +00:00
///Sends a `GET` request to
2022-07-03 02:09:38 +00:00
/// `/organizations/{organization_name}/projects/{project_name}/vpcs/
2023-02-01 05:28:12 +00:00
/// {vpc_name}/subnets/{subnet_name}`
pub async fn vpc_subnet_view<'a>(
2022-01-05 20:02:46 +00:00
&'a self,
organization_name: &'a types::Name,
project_name: &'a types::Name,
vpc_name: &'a types::Name,
2023-02-01 05:28:12 +00:00
subnet_name: &'a types::Name,
) -> Result<ResponseValue<types::VpcSubnet>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!(
2023-02-01 05:28:12 +00:00
"{}/organizations/{}/projects/{}/vpcs/{}/subnets/{}",
2021-12-10 02:15:24 +00:00
self.baseurl,
2022-07-03 02:09:38 +00:00
encode_path(&organization_name.to_string()),
encode_path(&project_name.to_string()),
encode_path(&vpc_name.to_string()),
2023-02-01 05:28:12 +00:00
encode_path(&subnet_name.to_string()),
2021-12-10 02:15:24 +00:00
);
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.get(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
200u16 => ResponseValue::from_response(response).await,
2022-02-08 16:59:38 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-02-08 16:59:38 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-02-08 16:59:38 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2022-02-08 16:59:38 +00:00
}
2021-12-10 02:15:24 +00:00
}
2023-02-01 05:28:12 +00:00
///Update a subnet
2022-07-03 02:09:38 +00:00
///
2023-02-01 05:28:12 +00:00
///Sends a `PUT` request to
2022-07-03 02:09:38 +00:00
/// `/organizations/{organization_name}/projects/{project_name}/vpcs/
2023-02-01 05:28:12 +00:00
/// {vpc_name}/subnets/{subnet_name}`
pub async fn vpc_subnet_update<'a>(
2022-01-05 20:02:46 +00:00
&'a self,
organization_name: &'a types::Name,
project_name: &'a types::Name,
vpc_name: &'a types::Name,
2023-02-01 05:28:12 +00:00
subnet_name: &'a types::Name,
body: &'a types::VpcSubnetUpdate,
) -> Result<ResponseValue<types::VpcSubnet>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!(
2023-02-01 05:28:12 +00:00
"{}/organizations/{}/projects/{}/vpcs/{}/subnets/{}",
2021-12-10 02:15:24 +00:00
self.baseurl,
2022-07-03 02:09:38 +00:00
encode_path(&organization_name.to_string()),
encode_path(&project_name.to_string()),
encode_path(&vpc_name.to_string()),
2023-02-01 05:28:12 +00:00
encode_path(&subnet_name.to_string()),
2021-12-10 02:15:24 +00:00
);
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.put(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
.json(&body)
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
200u16 => ResponseValue::from_response(response).await,
2022-02-08 16:59:38 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-02-08 16:59:38 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-02-08 16:59:38 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2022-02-08 16:59:38 +00:00
}
2021-12-10 02:15:24 +00:00
}
2023-02-01 05:28:12 +00:00
///Delete a subnet
2022-07-03 02:09:38 +00:00
///
2023-02-01 05:28:12 +00:00
///Sends a `DELETE` request to
2022-07-03 02:09:38 +00:00
/// `/organizations/{organization_name}/projects/{project_name}/vpcs/
2023-02-01 05:28:12 +00:00
/// {vpc_name}/subnets/{subnet_name}`
pub async fn vpc_subnet_delete<'a>(
2022-01-05 20:02:46 +00:00
&'a self,
organization_name: &'a types::Name,
project_name: &'a types::Name,
vpc_name: &'a types::Name,
2023-02-01 05:28:12 +00:00
subnet_name: &'a types::Name,
) -> Result<ResponseValue<()>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!(
2023-02-01 05:28:12 +00:00
"{}/organizations/{}/projects/{}/vpcs/{}/subnets/{}",
2021-12-10 02:15:24 +00:00
self.baseurl,
2022-07-03 02:09:38 +00:00
encode_path(&organization_name.to_string()),
encode_path(&project_name.to_string()),
encode_path(&vpc_name.to_string()),
2023-02-01 05:28:12 +00:00
encode_path(&subnet_name.to_string()),
2021-12-10 02:15:24 +00:00
);
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.delete(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
204u16 => Ok(ResponseValue::empty(response)),
2022-02-08 16:59:38 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-02-08 16:59:38 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-02-08 16:59:38 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2022-02-08 16:59:38 +00:00
}
2021-12-10 02:15:24 +00:00
}
2023-02-01 05:28:12 +00:00
///List network interfaces
2022-07-03 02:09:38 +00:00
///
///Sends a `GET` request to
/// `/organizations/{organization_name}/projects/{project_name}/vpcs/
2023-02-01 05:28:12 +00:00
/// {vpc_name}/subnets/{subnet_name}/network-interfaces`
2022-07-03 02:09:38 +00:00
///
///Arguments:
/// - `organization_name`
/// - `project_name`
/// - `vpc_name`
2023-02-01 05:28:12 +00:00
/// - `subnet_name`
2022-07-03 02:09:38 +00:00
/// - `limit`: Maximum number of items returned by a single call
2022-07-08 01:35:36 +00:00
/// - `page_token`: Token returned by previous call to retrieve the
2022-07-03 02:09:38 +00:00
/// subsequent page
/// - `sort_by`
2023-02-01 05:28:12 +00:00
pub async fn vpc_subnet_list_network_interfaces<'a>(
2022-01-05 20:02:46 +00:00
&'a self,
organization_name: &'a types::Name,
project_name: &'a types::Name,
vpc_name: &'a types::Name,
2023-02-01 05:28:12 +00:00
subnet_name: &'a types::Name,
2021-12-10 02:15:24 +00:00
limit: Option<std::num::NonZeroU32>,
2022-01-05 20:02:46 +00:00
page_token: Option<&'a str>,
2021-12-10 02:15:24 +00:00
sort_by: Option<types::NameSortMode>,
2023-02-01 05:28:12 +00:00
) -> Result<ResponseValue<types::NetworkInterfaceResultsPage>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!(
2023-02-01 05:28:12 +00:00
"{}/organizations/{}/projects/{}/vpcs/{}/subnets/{}/network-interfaces",
2021-12-10 02:15:24 +00:00
self.baseurl,
2022-07-03 02:09:38 +00:00
encode_path(&organization_name.to_string()),
encode_path(&project_name.to_string()),
encode_path(&vpc_name.to_string()),
2023-02-01 05:28:12 +00:00
encode_path(&subnet_name.to_string()),
2021-12-10 02:15:24 +00:00
);
2023-10-16 18:44:24 +00:00
let mut query = Vec::with_capacity(3usize);
2021-12-10 02:15:24 +00:00
if let Some(v) = &limit {
2023-10-16 18:44:24 +00:00
query.push(("limit", v.to_string()));
2021-12-10 02:15:24 +00:00
}
if let Some(v) = &page_token {
2023-10-16 18:44:24 +00:00
query.push(("page_token", v.to_string()));
2021-12-10 02:15:24 +00:00
}
if let Some(v) = &sort_by {
2023-10-16 18:44:24 +00:00
query.push(("sort_by", v.to_string()));
2021-12-10 02:15:24 +00:00
}
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.get(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
2023-10-16 18:44:24 +00:00
.query(&query)
2023-04-25 00:42:22 +00:00
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
200u16 => ResponseValue::from_response(response).await,
2022-02-08 16:59:38 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-02-08 16:59:38 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-02-08 16:59:38 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2022-02-08 16:59:38 +00:00
}
2021-12-10 02:15:24 +00:00
}
2023-02-01 05:28:12 +00:00
///List network interfaces as a Stream
2022-07-03 02:09:38 +00:00
///
///Sends repeated `GET` requests to
/// `/organizations/{organization_name}/projects/{project_name}/vpcs/
2023-02-01 05:28:12 +00:00
/// {vpc_name}/subnets/{subnet_name}/network-interfaces` until there are no
/// more results.
2022-07-03 02:09:38 +00:00
///
///Arguments:
/// - `organization_name`
/// - `project_name`
/// - `vpc_name`
2023-02-01 05:28:12 +00:00
/// - `subnet_name`
2022-07-03 02:09:38 +00:00
/// - `limit`: Maximum number of items returned by a single call
/// - `sort_by`
2023-02-01 05:28:12 +00:00
pub fn vpc_subnet_list_network_interfaces_stream<'a>(
2022-01-05 20:02:46 +00:00
&'a self,
organization_name: &'a types::Name,
project_name: &'a types::Name,
vpc_name: &'a types::Name,
2023-02-01 05:28:12 +00:00
subnet_name: &'a types::Name,
2022-01-05 20:02:46 +00:00
limit: Option<std::num::NonZeroU32>,
sort_by: Option<types::NameSortMode>,
2023-02-01 05:28:12 +00:00
) -> impl futures::Stream<Item = Result<types::NetworkInterface, Error<types::Error>>> + Unpin + '_
2022-02-08 16:59:38 +00:00
{
2022-01-05 20:02:46 +00:00
use futures::StreamExt;
use futures::TryFutureExt;
use futures::TryStreamExt;
2023-05-04 03:53:28 +00:00
let final_stream_limit = limit
.clone()
.and_then(|x| std::num::NonZeroUsize::try_from(x).ok())
.map(std::num::NonZeroUsize::get)
.unwrap_or(usize::MAX);
2023-02-01 05:28:12 +00:00
self.vpc_subnet_list_network_interfaces(
2022-01-05 20:02:46 +00:00
organization_name,
project_name,
vpc_name,
2023-02-01 05:28:12 +00:00
subnet_name,
2022-01-05 20:02:46 +00:00
limit,
None,
sort_by,
)
.map_ok(move |page| {
2022-02-08 16:59:38 +00:00
let page = page.into_inner();
2023-05-08 03:43:45 +00:00
let first = futures::stream::iter(page.items).map(Ok);
2022-01-05 20:02:46 +00:00
let rest = futures::stream::try_unfold(page.next_page, move |state| async move {
if state.is_none() {
Ok(None)
} else {
2023-02-01 05:28:12 +00:00
self.vpc_subnet_list_network_interfaces(
2022-01-05 20:02:46 +00:00
organization_name,
project_name,
vpc_name,
2023-02-01 05:28:12 +00:00
subnet_name,
2022-01-05 20:02:46 +00:00
None,
state.as_deref(),
None,
)
.map_ok(|page| {
2022-02-08 16:59:38 +00:00
let page = page.into_inner();
2023-05-08 03:43:45 +00:00
Some((futures::stream::iter(page.items).map(Ok), page.next_page))
2022-01-05 20:02:46 +00:00
})
.await
}
})
.try_flatten();
first.chain(rest)
})
.try_flatten_stream()
2023-05-04 03:53:28 +00:00
.take(final_stream_limit)
2022-01-05 20:02:46 +00:00
.boxed()
}
2023-02-01 05:28:12 +00:00
///Fetch the current silo's IAM policy
2022-07-03 02:09:38 +00:00
///
2023-02-01 05:28:12 +00:00
///Sends a `GET` request to `/policy`
pub async fn policy_view<'a>(
2022-01-05 20:02:46 +00:00
&'a self,
2023-02-01 05:28:12 +00:00
) -> Result<ResponseValue<types::SiloRolePolicy>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!("{}/policy", self.baseurl,);
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.get(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
200u16 => ResponseValue::from_response(response).await,
2022-02-08 16:59:38 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-02-08 16:59:38 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-02-08 16:59:38 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2022-02-08 16:59:38 +00:00
}
2021-12-10 02:15:24 +00:00
}
2023-02-01 05:28:12 +00:00
///Update the current silo's IAM policy
2022-07-03 02:09:38 +00:00
///
2023-02-01 05:28:12 +00:00
///Sends a `PUT` request to `/policy`
pub async fn policy_update<'a>(
2022-01-05 20:02:46 +00:00
&'a self,
2023-02-01 05:28:12 +00:00
body: &'a types::SiloRolePolicy,
) -> Result<ResponseValue<types::SiloRolePolicy>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!("{}/policy", self.baseurl,);
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.put(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
.json(&body)
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
200u16 => ResponseValue::from_response(response).await,
2022-02-08 16:59:38 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-02-08 16:59:38 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-02-08 16:59:38 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2022-02-08 16:59:38 +00:00
}
2021-12-10 02:15:24 +00:00
}
2023-02-01 05:28:12 +00:00
///List built-in roles
2022-07-03 02:09:38 +00:00
///
2023-02-01 05:28:12 +00:00
///Sends a `GET` request to `/roles`
2022-07-03 02:09:38 +00:00
///
///Arguments:
/// - `limit`: Maximum number of items returned by a single call
2022-07-08 01:35:36 +00:00
/// - `page_token`: Token returned by previous call to retrieve the
2022-07-03 02:09:38 +00:00
/// subsequent page
2023-02-01 05:28:12 +00:00
pub async fn role_list<'a>(
2022-01-05 20:02:46 +00:00
&'a self,
2021-12-10 02:15:24 +00:00
limit: Option<std::num::NonZeroU32>,
2022-01-05 20:02:46 +00:00
page_token: Option<&'a str>,
2023-02-01 05:28:12 +00:00
) -> Result<ResponseValue<types::RoleResultsPage>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!("{}/roles", self.baseurl,);
let mut query = Vec::with_capacity(2usize);
2021-12-10 02:15:24 +00:00
if let Some(v) = &limit {
2023-10-16 18:44:24 +00:00
query.push(("limit", v.to_string()));
2021-12-10 02:15:24 +00:00
}
if let Some(v) = &page_token {
2023-10-16 18:44:24 +00:00
query.push(("page_token", v.to_string()));
2021-12-10 02:15:24 +00:00
}
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.get(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
2023-10-16 18:44:24 +00:00
.query(&query)
2023-04-25 00:42:22 +00:00
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
200u16 => ResponseValue::from_response(response).await,
2022-02-08 16:59:38 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-02-08 16:59:38 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-02-08 16:59:38 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2022-02-08 16:59:38 +00:00
}
2021-12-10 02:15:24 +00:00
}
2023-02-01 05:28:12 +00:00
///List built-in roles as a Stream
2022-07-03 02:09:38 +00:00
///
2023-02-01 05:28:12 +00:00
///Sends repeated `GET` requests to `/roles` until there are no more
2022-07-03 02:09:38 +00:00
/// results.
///
///Arguments:
/// - `limit`: Maximum number of items returned by a single call
2023-02-01 05:28:12 +00:00
pub fn role_list_stream<'a>(
2022-01-05 20:02:46 +00:00
&'a self,
limit: Option<std::num::NonZeroU32>,
2023-02-01 05:28:12 +00:00
) -> impl futures::Stream<Item = Result<types::Role, Error<types::Error>>> + Unpin + '_ {
2022-01-05 20:02:46 +00:00
use futures::StreamExt;
use futures::TryFutureExt;
use futures::TryStreamExt;
2023-05-04 03:53:28 +00:00
let final_stream_limit = limit
.clone()
.and_then(|x| std::num::NonZeroUsize::try_from(x).ok())
.map(std::num::NonZeroUsize::get)
.unwrap_or(usize::MAX);
2023-02-01 05:28:12 +00:00
self.role_list(limit, None)
.map_ok(move |page| {
let page = page.into_inner();
2023-05-08 03:43:45 +00:00
let first = futures::stream::iter(page.items).map(Ok);
2023-02-01 05:28:12 +00:00
let rest = futures::stream::try_unfold(page.next_page, move |state| async move {
if state.is_none() {
Ok(None)
} else {
self.role_list(None, state.as_deref())
.map_ok(|page| {
let page = page.into_inner();
2023-05-08 03:43:45 +00:00
Some((futures::stream::iter(page.items).map(Ok), page.next_page))
2023-02-01 05:28:12 +00:00
})
.await
}
})
.try_flatten();
first.chain(rest)
2022-01-05 20:02:46 +00:00
})
2023-02-01 05:28:12 +00:00
.try_flatten_stream()
2023-05-04 03:53:28 +00:00
.take(final_stream_limit)
2023-02-01 05:28:12 +00:00
.boxed()
2022-01-05 20:02:46 +00:00
}
2023-02-01 05:28:12 +00:00
///Fetch a built-in role
2022-07-03 02:09:38 +00:00
///
2023-02-01 05:28:12 +00:00
///Sends a `GET` request to `/roles/{role_name}`
///
///Arguments:
/// - `role_name`: The built-in role's unique name.
pub async fn role_view<'a>(
2022-01-05 20:02:46 +00:00
&'a self,
2023-02-01 05:28:12 +00:00
role_name: &'a str,
) -> Result<ResponseValue<types::Role>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!(
2023-02-01 05:28:12 +00:00
"{}/roles/{}",
2021-12-10 02:15:24 +00:00
self.baseurl,
2023-02-01 05:28:12 +00:00
encode_path(&role_name.to_string()),
2021-12-10 02:15:24 +00:00
);
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.get(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
200u16 => ResponseValue::from_response(response).await,
2022-02-08 16:59:38 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-02-08 16:59:38 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-02-08 16:59:38 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2022-02-08 16:59:38 +00:00
}
2021-12-10 02:15:24 +00:00
}
2023-02-01 05:28:12 +00:00
///Fetch the user associated with the current session
2022-07-03 02:09:38 +00:00
///
2023-02-01 05:28:12 +00:00
///Sends a `GET` request to `/session/me`
pub async fn session_me<'a>(
2022-01-05 20:02:46 +00:00
&'a self,
2023-02-01 05:28:12 +00:00
) -> Result<ResponseValue<types::User>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!("{}/session/me", self.baseurl,);
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.get(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
200u16 => ResponseValue::from_response(response).await,
2022-02-08 16:59:38 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-02-08 16:59:38 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-02-08 16:59:38 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2022-02-08 16:59:38 +00:00
}
2021-12-10 02:15:24 +00:00
}
2023-02-01 05:28:12 +00:00
///Fetch the silo
2022-07-03 02:09:38 +00:00
///
2023-02-01 05:28:12 +00:00
///Sends a `GET` request to `/session/me/groups`
///
///Arguments:
/// - `limit`: Maximum number of items returned by a single call
/// - `page_token`: Token returned by previous call to retrieve the
/// subsequent page
/// - `sort_by`
pub async fn session_me_groups<'a>(
2022-01-05 20:02:46 +00:00
&'a self,
2023-02-01 05:28:12 +00:00
limit: Option<std::num::NonZeroU32>,
page_token: Option<&'a str>,
sort_by: Option<types::IdSortMode>,
) -> Result<ResponseValue<types::GroupResultsPage>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!("{}/session/me/groups", self.baseurl,);
let mut query = Vec::with_capacity(3usize);
2023-02-01 05:28:12 +00:00
if let Some(v) = &limit {
2023-10-16 18:44:24 +00:00
query.push(("limit", v.to_string()));
2023-02-01 05:28:12 +00:00
}
if let Some(v) = &page_token {
2023-10-16 18:44:24 +00:00
query.push(("page_token", v.to_string()));
2023-02-01 05:28:12 +00:00
}
if let Some(v) = &sort_by {
2023-10-16 18:44:24 +00:00
query.push(("sort_by", v.to_string()));
2023-02-01 05:28:12 +00:00
}
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.get(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
2023-10-16 18:44:24 +00:00
.query(&query)
2023-04-25 00:42:22 +00:00
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
200u16 => ResponseValue::from_response(response).await,
2022-02-08 16:59:38 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-02-08 16:59:38 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-02-08 16:59:38 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2022-02-08 16:59:38 +00:00
}
2021-12-10 02:15:24 +00:00
}
2023-02-01 05:28:12 +00:00
///Fetch the silo
2022-07-03 02:09:38 +00:00
///
2023-02-01 05:28:12 +00:00
///Sends repeated `GET` requests to `/session/me/groups` until there are no
/// more results.
///
///Arguments:
/// - `limit`: Maximum number of items returned by a single call
/// - `sort_by`
pub fn session_me_groups_stream<'a>(
2022-01-05 20:02:46 +00:00
&'a self,
2023-02-01 05:28:12 +00:00
limit: Option<std::num::NonZeroU32>,
sort_by: Option<types::IdSortMode>,
) -> impl futures::Stream<Item = Result<types::Group, Error<types::Error>>> + Unpin + '_ {
use futures::StreamExt;
use futures::TryFutureExt;
use futures::TryStreamExt;
2023-05-04 03:53:28 +00:00
let final_stream_limit = limit
.clone()
.and_then(|x| std::num::NonZeroUsize::try_from(x).ok())
.map(std::num::NonZeroUsize::get)
.unwrap_or(usize::MAX);
2023-02-01 05:28:12 +00:00
self.session_me_groups(limit, None, sort_by)
.map_ok(move |page| {
let page = page.into_inner();
2023-05-08 03:43:45 +00:00
let first = futures::stream::iter(page.items).map(Ok);
2023-02-01 05:28:12 +00:00
let rest = futures::stream::try_unfold(page.next_page, move |state| async move {
if state.is_none() {
Ok(None)
} else {
self.session_me_groups(None, state.as_deref(), None)
.map_ok(|page| {
let page = page.into_inner();
2023-05-08 03:43:45 +00:00
Some((futures::stream::iter(page.items).map(Ok), page.next_page))
2023-02-01 05:28:12 +00:00
})
.await
}
})
.try_flatten();
first.chain(rest)
})
.try_flatten_stream()
2023-05-04 03:53:28 +00:00
.take(final_stream_limit)
2023-02-01 05:28:12 +00:00
.boxed()
}
///List SSH public keys
///
///Lists SSH public keys for the currently authenticated user.
///
///Sends a `GET` request to `/session/me/sshkeys`
///
///Arguments:
/// - `limit`: Maximum number of items returned by a single call
/// - `page_token`: Token returned by previous call to retrieve the
/// subsequent page
/// - `sort_by`
pub async fn session_sshkey_list<'a>(
&'a self,
limit: Option<std::num::NonZeroU32>,
page_token: Option<&'a str>,
sort_by: Option<types::NameSortMode>,
) -> Result<ResponseValue<types::SshKeyResultsPage>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!("{}/session/me/sshkeys", self.baseurl,);
let mut query = Vec::with_capacity(3usize);
2023-02-01 05:28:12 +00:00
if let Some(v) = &limit {
2023-10-16 18:44:24 +00:00
query.push(("limit", v.to_string()));
2023-02-01 05:28:12 +00:00
}
if let Some(v) = &page_token {
2023-10-16 18:44:24 +00:00
query.push(("page_token", v.to_string()));
2023-02-01 05:28:12 +00:00
}
if let Some(v) = &sort_by {
2023-10-16 18:44:24 +00:00
query.push(("sort_by", v.to_string()));
2023-02-01 05:28:12 +00:00
}
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.get(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
2023-10-16 18:44:24 +00:00
.query(&query)
2023-04-25 00:42:22 +00:00
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
200u16 => ResponseValue::from_response(response).await,
2023-02-01 05:28:12 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2023-02-01 05:28:12 +00:00
}
}
///List SSH public keys as a Stream
///
///Lists SSH public keys for the currently authenticated user.
///
///Sends repeated `GET` requests to `/session/me/sshkeys` until there are
/// no more results.
///
///Arguments:
/// - `limit`: Maximum number of items returned by a single call
/// - `sort_by`
pub fn session_sshkey_list_stream<'a>(
&'a self,
limit: Option<std::num::NonZeroU32>,
sort_by: Option<types::NameSortMode>,
) -> impl futures::Stream<Item = Result<types::SshKey, Error<types::Error>>> + Unpin + '_ {
use futures::StreamExt;
use futures::TryFutureExt;
use futures::TryStreamExt;
2023-05-04 03:53:28 +00:00
let final_stream_limit = limit
.clone()
.and_then(|x| std::num::NonZeroUsize::try_from(x).ok())
.map(std::num::NonZeroUsize::get)
.unwrap_or(usize::MAX);
2023-02-01 05:28:12 +00:00
self.session_sshkey_list(limit, None, sort_by)
.map_ok(move |page| {
let page = page.into_inner();
2023-05-08 03:43:45 +00:00
let first = futures::stream::iter(page.items).map(Ok);
2023-02-01 05:28:12 +00:00
let rest = futures::stream::try_unfold(page.next_page, move |state| async move {
if state.is_none() {
Ok(None)
} else {
self.session_sshkey_list(None, state.as_deref(), None)
.map_ok(|page| {
let page = page.into_inner();
2023-05-08 03:43:45 +00:00
Some((futures::stream::iter(page.items).map(Ok), page.next_page))
2023-02-01 05:28:12 +00:00
})
.await
}
})
.try_flatten();
first.chain(rest)
})
.try_flatten_stream()
2023-05-04 03:53:28 +00:00
.take(final_stream_limit)
2023-02-01 05:28:12 +00:00
.boxed()
}
///Create an SSH public key
///
///Create an SSH public key for the currently authenticated user.
///
///Sends a `POST` request to `/session/me/sshkeys`
pub async fn session_sshkey_create<'a>(
&'a self,
body: &'a types::SshKeyCreate,
) -> Result<ResponseValue<types::SshKey>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!("{}/session/me/sshkeys", self.baseurl,);
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.post(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
.json(&body)
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
201u16 => ResponseValue::from_response(response).await,
2023-02-01 05:28:12 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2023-02-01 05:28:12 +00:00
}
}
///Fetch an SSH public key
///
///Fetch an SSH public key associated with the currently authenticated
/// user.
///
///Sends a `GET` request to `/session/me/sshkeys/{ssh_key_name}`
pub async fn session_sshkey_view<'a>(
&'a self,
ssh_key_name: &'a types::Name,
) -> Result<ResponseValue<types::SshKey>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!(
2023-02-01 05:28:12 +00:00
"{}/session/me/sshkeys/{}",
self.baseurl,
encode_path(&ssh_key_name.to_string()),
);
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.get(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
200u16 => ResponseValue::from_response(response).await,
2023-02-01 05:28:12 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2023-02-01 05:28:12 +00:00
}
}
///Delete an SSH public key
///
///Delete an SSH public key associated with the currently authenticated
/// user.
///
///Sends a `DELETE` request to `/session/me/sshkeys/{ssh_key_name}`
pub async fn session_sshkey_delete<'a>(
&'a self,
ssh_key_name: &'a types::Name,
) -> Result<ResponseValue<()>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!(
2023-02-01 05:28:12 +00:00
"{}/session/me/sshkeys/{}",
self.baseurl,
encode_path(&ssh_key_name.to_string()),
);
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.delete(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
204u16 => Ok(ResponseValue::empty(response)),
2023-02-01 05:28:12 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2023-02-01 05:28:12 +00:00
}
}
///Fetch a system-wide image by id
///
///Sends a `GET` request to `/system/by-id/images/{id}`
pub async fn system_image_view_by_id<'a>(
&'a self,
id: &'a uuid::Uuid,
) -> Result<ResponseValue<types::GlobalImage>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!(
2023-02-01 05:28:12 +00:00
"{}/system/by-id/images/{}",
self.baseurl,
encode_path(&id.to_string()),
);
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.get(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
200u16 => ResponseValue::from_response(response).await,
2023-02-01 05:28:12 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2023-02-01 05:28:12 +00:00
}
}
///Fetch an IP pool by id
///
///Sends a `GET` request to `/system/by-id/ip-pools/{id}`
pub async fn ip_pool_view_by_id<'a>(
&'a self,
id: &'a uuid::Uuid,
) -> Result<ResponseValue<types::IpPool>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!(
2023-02-01 05:28:12 +00:00
"{}/system/by-id/ip-pools/{}",
self.baseurl,
encode_path(&id.to_string()),
);
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.get(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
200u16 => ResponseValue::from_response(response).await,
2023-02-01 05:28:12 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2023-02-01 05:28:12 +00:00
}
}
///Fetch a silo by id
///
///Sends a `GET` request to `/system/by-id/silos/{id}`
pub async fn silo_view_by_id<'a>(
&'a self,
id: &'a uuid::Uuid,
) -> Result<ResponseValue<types::Silo>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!(
2023-02-01 05:28:12 +00:00
"{}/system/by-id/silos/{}",
self.baseurl,
encode_path(&id.to_string()),
);
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.get(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
200u16 => ResponseValue::from_response(response).await,
2023-02-01 05:28:12 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2023-02-01 05:28:12 +00:00
}
}
///List system-wide certificates
///
///Returns a list of all the system-wide certificates. System-wide
/// certificates are returned sorted by creation date, with the most recent
/// certificates appearing first.
///
///Sends a `GET` request to `/system/certificates`
///
///Arguments:
/// - `limit`: Maximum number of items returned by a single call
/// - `page_token`: Token returned by previous call to retrieve the
/// subsequent page
/// - `sort_by`
pub async fn certificate_list<'a>(
&'a self,
limit: Option<std::num::NonZeroU32>,
page_token: Option<&'a str>,
sort_by: Option<types::NameSortMode>,
) -> Result<ResponseValue<types::CertificateResultsPage>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!("{}/system/certificates", self.baseurl,);
let mut query = Vec::with_capacity(3usize);
2023-02-01 05:28:12 +00:00
if let Some(v) = &limit {
2023-10-16 18:44:24 +00:00
query.push(("limit", v.to_string()));
2023-02-01 05:28:12 +00:00
}
if let Some(v) = &page_token {
2023-10-16 18:44:24 +00:00
query.push(("page_token", v.to_string()));
2023-02-01 05:28:12 +00:00
}
if let Some(v) = &sort_by {
2023-10-16 18:44:24 +00:00
query.push(("sort_by", v.to_string()));
2023-02-01 05:28:12 +00:00
}
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.get(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
2023-10-16 18:44:24 +00:00
.query(&query)
2023-04-25 00:42:22 +00:00
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
200u16 => ResponseValue::from_response(response).await,
2023-02-01 05:28:12 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2023-02-01 05:28:12 +00:00
}
}
///List system-wide certificates as a Stream
///
///Returns a list of all the system-wide certificates. System-wide
/// certificates are returned sorted by creation date, with the most recent
/// certificates appearing first.
///
///Sends repeated `GET` requests to `/system/certificates` until there are
/// no more results.
///
///Arguments:
/// - `limit`: Maximum number of items returned by a single call
/// - `sort_by`
pub fn certificate_list_stream<'a>(
&'a self,
limit: Option<std::num::NonZeroU32>,
sort_by: Option<types::NameSortMode>,
) -> impl futures::Stream<Item = Result<types::Certificate, Error<types::Error>>> + Unpin + '_
{
use futures::StreamExt;
use futures::TryFutureExt;
use futures::TryStreamExt;
2023-05-04 03:53:28 +00:00
let final_stream_limit = limit
.clone()
.and_then(|x| std::num::NonZeroUsize::try_from(x).ok())
.map(std::num::NonZeroUsize::get)
.unwrap_or(usize::MAX);
2023-02-01 05:28:12 +00:00
self.certificate_list(limit, None, sort_by)
.map_ok(move |page| {
let page = page.into_inner();
2023-05-08 03:43:45 +00:00
let first = futures::stream::iter(page.items).map(Ok);
2023-02-01 05:28:12 +00:00
let rest = futures::stream::try_unfold(page.next_page, move |state| async move {
if state.is_none() {
Ok(None)
} else {
self.certificate_list(None, state.as_deref(), None)
.map_ok(|page| {
let page = page.into_inner();
2023-05-08 03:43:45 +00:00
Some((futures::stream::iter(page.items).map(Ok), page.next_page))
2023-02-01 05:28:12 +00:00
})
.await
}
})
.try_flatten();
first.chain(rest)
})
.try_flatten_stream()
2023-05-04 03:53:28 +00:00
.take(final_stream_limit)
2023-02-01 05:28:12 +00:00
.boxed()
}
///Create a new system-wide x.509 certificate
///
///This certificate is automatically used by the Oxide Control plane to
/// serve external connections.
///
///Sends a `POST` request to `/system/certificates`
pub async fn certificate_create<'a>(
&'a self,
body: &'a types::CertificateCreate,
) -> Result<ResponseValue<types::Certificate>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!("{}/system/certificates", self.baseurl,);
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.post(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
.json(&body)
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
201u16 => ResponseValue::from_response(response).await,
2023-02-01 05:28:12 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2023-02-01 05:28:12 +00:00
}
}
///Fetch a certificate
///
///Returns the details of a specific certificate
///
///Sends a `GET` request to `/system/certificates/{certificate}`
pub async fn certificate_view<'a>(
&'a self,
certificate: &'a types::NameOrId,
) -> Result<ResponseValue<types::Certificate>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!(
2023-02-01 05:28:12 +00:00
"{}/system/certificates/{}",
self.baseurl,
encode_path(&certificate.to_string()),
);
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.get(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
200u16 => ResponseValue::from_response(response).await,
2023-02-01 05:28:12 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2023-02-01 05:28:12 +00:00
}
}
///Delete a certificate
///
///Permanently delete a certificate. This operation cannot be undone.
///
///Sends a `DELETE` request to `/system/certificates/{certificate}`
pub async fn certificate_delete<'a>(
&'a self,
certificate: &'a types::NameOrId,
) -> Result<ResponseValue<()>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!(
2023-02-01 05:28:12 +00:00
"{}/system/certificates/{}",
self.baseurl,
encode_path(&certificate.to_string()),
);
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.delete(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
204u16 => Ok(ResponseValue::empty(response)),
2023-02-01 05:28:12 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2023-02-01 05:28:12 +00:00
}
}
///List physical disks
///
///Sends a `GET` request to `/system/hardware/disks`
///
///Arguments:
/// - `limit`: Maximum number of items returned by a single call
/// - `page_token`: Token returned by previous call to retrieve the
/// subsequent page
/// - `sort_by`
pub async fn physical_disk_list<'a>(
&'a self,
limit: Option<std::num::NonZeroU32>,
page_token: Option<&'a str>,
sort_by: Option<types::IdSortMode>,
) -> Result<ResponseValue<types::PhysicalDiskResultsPage>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!("{}/system/hardware/disks", self.baseurl,);
let mut query = Vec::with_capacity(3usize);
2023-02-01 05:28:12 +00:00
if let Some(v) = &limit {
2023-10-16 18:44:24 +00:00
query.push(("limit", v.to_string()));
2023-02-01 05:28:12 +00:00
}
if let Some(v) = &page_token {
2023-10-16 18:44:24 +00:00
query.push(("page_token", v.to_string()));
2023-02-01 05:28:12 +00:00
}
if let Some(v) = &sort_by {
2023-10-16 18:44:24 +00:00
query.push(("sort_by", v.to_string()));
2023-02-01 05:28:12 +00:00
}
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.get(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
2023-10-16 18:44:24 +00:00
.query(&query)
2023-04-25 00:42:22 +00:00
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
200u16 => ResponseValue::from_response(response).await,
2023-02-01 05:28:12 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2023-02-01 05:28:12 +00:00
}
}
///List physical disks as a Stream
///
///Sends repeated `GET` requests to `/system/hardware/disks` until there
/// are no more results.
///
///Arguments:
/// - `limit`: Maximum number of items returned by a single call
/// - `sort_by`
pub fn physical_disk_list_stream<'a>(
&'a self,
limit: Option<std::num::NonZeroU32>,
sort_by: Option<types::IdSortMode>,
) -> impl futures::Stream<Item = Result<types::PhysicalDisk, Error<types::Error>>> + Unpin + '_
{
use futures::StreamExt;
use futures::TryFutureExt;
use futures::TryStreamExt;
2023-05-04 03:53:28 +00:00
let final_stream_limit = limit
.clone()
.and_then(|x| std::num::NonZeroUsize::try_from(x).ok())
.map(std::num::NonZeroUsize::get)
.unwrap_or(usize::MAX);
2023-02-01 05:28:12 +00:00
self.physical_disk_list(limit, None, sort_by)
.map_ok(move |page| {
let page = page.into_inner();
2023-05-08 03:43:45 +00:00
let first = futures::stream::iter(page.items).map(Ok);
2023-02-01 05:28:12 +00:00
let rest = futures::stream::try_unfold(page.next_page, move |state| async move {
if state.is_none() {
Ok(None)
} else {
self.physical_disk_list(None, state.as_deref(), None)
.map_ok(|page| {
let page = page.into_inner();
2023-05-08 03:43:45 +00:00
Some((futures::stream::iter(page.items).map(Ok), page.next_page))
2023-02-01 05:28:12 +00:00
})
.await
}
})
.try_flatten();
first.chain(rest)
})
.try_flatten_stream()
2023-05-04 03:53:28 +00:00
.take(final_stream_limit)
2023-02-01 05:28:12 +00:00
.boxed()
}
///List racks
///
///Sends a `GET` request to `/system/hardware/racks`
///
///Arguments:
/// - `limit`: Maximum number of items returned by a single call
/// - `page_token`: Token returned by previous call to retrieve the
/// subsequent page
/// - `sort_by`
pub async fn rack_list<'a>(
&'a self,
limit: Option<std::num::NonZeroU32>,
page_token: Option<&'a str>,
sort_by: Option<types::IdSortMode>,
) -> Result<ResponseValue<types::RackResultsPage>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!("{}/system/hardware/racks", self.baseurl,);
let mut query = Vec::with_capacity(3usize);
2023-02-01 05:28:12 +00:00
if let Some(v) = &limit {
2023-10-16 18:44:24 +00:00
query.push(("limit", v.to_string()));
2023-02-01 05:28:12 +00:00
}
if let Some(v) = &page_token {
2023-10-16 18:44:24 +00:00
query.push(("page_token", v.to_string()));
2023-02-01 05:28:12 +00:00
}
if let Some(v) = &sort_by {
2023-10-16 18:44:24 +00:00
query.push(("sort_by", v.to_string()));
2023-02-01 05:28:12 +00:00
}
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.get(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
2023-10-16 18:44:24 +00:00
.query(&query)
2023-04-25 00:42:22 +00:00
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
200u16 => ResponseValue::from_response(response).await,
2023-02-01 05:28:12 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2023-02-01 05:28:12 +00:00
}
}
///List racks as a Stream
///
///Sends repeated `GET` requests to `/system/hardware/racks` until there
/// are no more results.
///
///Arguments:
/// - `limit`: Maximum number of items returned by a single call
/// - `sort_by`
pub fn rack_list_stream<'a>(
&'a self,
limit: Option<std::num::NonZeroU32>,
sort_by: Option<types::IdSortMode>,
) -> impl futures::Stream<Item = Result<types::Rack, Error<types::Error>>> + Unpin + '_ {
use futures::StreamExt;
use futures::TryFutureExt;
use futures::TryStreamExt;
2023-05-04 03:53:28 +00:00
let final_stream_limit = limit
.clone()
.and_then(|x| std::num::NonZeroUsize::try_from(x).ok())
.map(std::num::NonZeroUsize::get)
.unwrap_or(usize::MAX);
2023-02-01 05:28:12 +00:00
self.rack_list(limit, None, sort_by)
.map_ok(move |page| {
let page = page.into_inner();
2023-05-08 03:43:45 +00:00
let first = futures::stream::iter(page.items).map(Ok);
2023-02-01 05:28:12 +00:00
let rest = futures::stream::try_unfold(page.next_page, move |state| async move {
if state.is_none() {
Ok(None)
} else {
self.rack_list(None, state.as_deref(), None)
.map_ok(|page| {
let page = page.into_inner();
2023-05-08 03:43:45 +00:00
Some((futures::stream::iter(page.items).map(Ok), page.next_page))
2023-02-01 05:28:12 +00:00
})
.await
}
})
.try_flatten();
first.chain(rest)
})
.try_flatten_stream()
2023-05-04 03:53:28 +00:00
.take(final_stream_limit)
2023-02-01 05:28:12 +00:00
.boxed()
}
///Fetch a rack
///
///Sends a `GET` request to `/system/hardware/racks/{rack_id}`
///
///Arguments:
/// - `rack_id`: The rack's unique ID.
pub async fn rack_view<'a>(
&'a self,
rack_id: &'a uuid::Uuid,
) -> Result<ResponseValue<types::Rack>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!(
2023-02-01 05:28:12 +00:00
"{}/system/hardware/racks/{}",
self.baseurl,
encode_path(&rack_id.to_string()),
);
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.get(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
200u16 => ResponseValue::from_response(response).await,
2023-02-01 05:28:12 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2023-02-01 05:28:12 +00:00
}
}
///List sleds
///
///Sends a `GET` request to `/system/hardware/sleds`
///
///Arguments:
/// - `limit`: Maximum number of items returned by a single call
/// - `page_token`: Token returned by previous call to retrieve the
/// subsequent page
/// - `sort_by`
pub async fn sled_list<'a>(
&'a self,
limit: Option<std::num::NonZeroU32>,
page_token: Option<&'a str>,
sort_by: Option<types::IdSortMode>,
) -> Result<ResponseValue<types::SledResultsPage>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!("{}/system/hardware/sleds", self.baseurl,);
let mut query = Vec::with_capacity(3usize);
2023-02-01 05:28:12 +00:00
if let Some(v) = &limit {
2023-10-16 18:44:24 +00:00
query.push(("limit", v.to_string()));
2023-02-01 05:28:12 +00:00
}
if let Some(v) = &page_token {
2023-10-16 18:44:24 +00:00
query.push(("page_token", v.to_string()));
2023-02-01 05:28:12 +00:00
}
if let Some(v) = &sort_by {
2023-10-16 18:44:24 +00:00
query.push(("sort_by", v.to_string()));
2023-02-01 05:28:12 +00:00
}
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.get(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
2023-10-16 18:44:24 +00:00
.query(&query)
2023-04-25 00:42:22 +00:00
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
200u16 => ResponseValue::from_response(response).await,
2023-02-01 05:28:12 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2023-02-01 05:28:12 +00:00
}
}
///List sleds as a Stream
///
///Sends repeated `GET` requests to `/system/hardware/sleds` until there
/// are no more results.
///
///Arguments:
/// - `limit`: Maximum number of items returned by a single call
/// - `sort_by`
pub fn sled_list_stream<'a>(
&'a self,
limit: Option<std::num::NonZeroU32>,
sort_by: Option<types::IdSortMode>,
) -> impl futures::Stream<Item = Result<types::Sled, Error<types::Error>>> + Unpin + '_ {
use futures::StreamExt;
use futures::TryFutureExt;
use futures::TryStreamExt;
2023-05-04 03:53:28 +00:00
let final_stream_limit = limit
.clone()
.and_then(|x| std::num::NonZeroUsize::try_from(x).ok())
.map(std::num::NonZeroUsize::get)
.unwrap_or(usize::MAX);
2023-02-01 05:28:12 +00:00
self.sled_list(limit, None, sort_by)
.map_ok(move |page| {
let page = page.into_inner();
2023-05-08 03:43:45 +00:00
let first = futures::stream::iter(page.items).map(Ok);
2023-02-01 05:28:12 +00:00
let rest = futures::stream::try_unfold(page.next_page, move |state| async move {
if state.is_none() {
Ok(None)
} else {
self.sled_list(None, state.as_deref(), None)
.map_ok(|page| {
let page = page.into_inner();
2023-05-08 03:43:45 +00:00
Some((futures::stream::iter(page.items).map(Ok), page.next_page))
2023-02-01 05:28:12 +00:00
})
.await
}
})
.try_flatten();
first.chain(rest)
})
.try_flatten_stream()
2023-05-04 03:53:28 +00:00
.take(final_stream_limit)
2023-02-01 05:28:12 +00:00
.boxed()
}
///Fetch a sled
///
///Sends a `GET` request to `/system/hardware/sleds/{sled_id}`
///
///Arguments:
/// - `sled_id`: The sled's unique ID.
pub async fn sled_view<'a>(
&'a self,
sled_id: &'a uuid::Uuid,
) -> Result<ResponseValue<types::Sled>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!(
2023-02-01 05:28:12 +00:00
"{}/system/hardware/sleds/{}",
self.baseurl,
encode_path(&sled_id.to_string()),
);
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.get(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
200u16 => ResponseValue::from_response(response).await,
2023-02-01 05:28:12 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2023-02-01 05:28:12 +00:00
}
}
///List physical disks attached to sleds
///
///Sends a `GET` request to `/system/hardware/sleds/{sled_id}/disks`
///
///Arguments:
/// - `sled_id`: The sled's unique ID.
/// - `limit`: Maximum number of items returned by a single call
/// - `page_token`: Token returned by previous call to retrieve the
/// subsequent page
/// - `sort_by`
pub async fn sled_physical_disk_list<'a>(
&'a self,
sled_id: &'a uuid::Uuid,
limit: Option<std::num::NonZeroU32>,
page_token: Option<&'a str>,
sort_by: Option<types::IdSortMode>,
) -> Result<ResponseValue<types::PhysicalDiskResultsPage>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!(
2023-02-01 05:28:12 +00:00
"{}/system/hardware/sleds/{}/disks",
self.baseurl,
encode_path(&sled_id.to_string()),
);
2023-10-16 18:44:24 +00:00
let mut query = Vec::with_capacity(3usize);
2023-02-01 05:28:12 +00:00
if let Some(v) = &limit {
2023-10-16 18:44:24 +00:00
query.push(("limit", v.to_string()));
2023-02-01 05:28:12 +00:00
}
if let Some(v) = &page_token {
2023-10-16 18:44:24 +00:00
query.push(("page_token", v.to_string()));
2023-02-01 05:28:12 +00:00
}
if let Some(v) = &sort_by {
2023-10-16 18:44:24 +00:00
query.push(("sort_by", v.to_string()));
2023-02-01 05:28:12 +00:00
}
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.get(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
2023-10-16 18:44:24 +00:00
.query(&query)
2023-04-25 00:42:22 +00:00
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
200u16 => ResponseValue::from_response(response).await,
2023-02-01 05:28:12 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2023-02-01 05:28:12 +00:00
}
}
///List physical disks attached to sleds as a Stream
///
///Sends repeated `GET` requests to
/// `/system/hardware/sleds/{sled_id}/disks` until there are no more
/// results.
///
///Arguments:
/// - `sled_id`: The sled's unique ID.
/// - `limit`: Maximum number of items returned by a single call
/// - `sort_by`
pub fn sled_physical_disk_list_stream<'a>(
&'a self,
sled_id: &'a uuid::Uuid,
limit: Option<std::num::NonZeroU32>,
sort_by: Option<types::IdSortMode>,
) -> impl futures::Stream<Item = Result<types::PhysicalDisk, Error<types::Error>>> + Unpin + '_
{
use futures::StreamExt;
use futures::TryFutureExt;
use futures::TryStreamExt;
2023-05-04 03:53:28 +00:00
let final_stream_limit = limit
.clone()
.and_then(|x| std::num::NonZeroUsize::try_from(x).ok())
.map(std::num::NonZeroUsize::get)
.unwrap_or(usize::MAX);
2023-02-01 05:28:12 +00:00
self.sled_physical_disk_list(sled_id, limit, None, sort_by)
.map_ok(move |page| {
let page = page.into_inner();
2023-05-08 03:43:45 +00:00
let first = futures::stream::iter(page.items).map(Ok);
2023-02-01 05:28:12 +00:00
let rest = futures::stream::try_unfold(page.next_page, move |state| async move {
if state.is_none() {
Ok(None)
} else {
self.sled_physical_disk_list(sled_id, None, state.as_deref(), None)
.map_ok(|page| {
let page = page.into_inner();
2023-05-08 03:43:45 +00:00
Some((futures::stream::iter(page.items).map(Ok), page.next_page))
2023-02-01 05:28:12 +00:00
})
.await
}
})
.try_flatten();
first.chain(rest)
})
.try_flatten_stream()
2023-05-04 03:53:28 +00:00
.take(final_stream_limit)
2023-02-01 05:28:12 +00:00
.boxed()
}
///List system-wide images
///
///Returns a list of all the system-wide images. System-wide images are
/// returned sorted by creation date, with the most recent images appearing
/// first.
///
///Sends a `GET` request to `/system/images`
///
///Arguments:
/// - `limit`: Maximum number of items returned by a single call
/// - `page_token`: Token returned by previous call to retrieve the
/// subsequent page
/// - `sort_by`
pub async fn system_image_list<'a>(
&'a self,
limit: Option<std::num::NonZeroU32>,
page_token: Option<&'a str>,
sort_by: Option<types::NameSortMode>,
) -> Result<ResponseValue<types::GlobalImageResultsPage>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!("{}/system/images", self.baseurl,);
let mut query = Vec::with_capacity(3usize);
2023-02-01 05:28:12 +00:00
if let Some(v) = &limit {
2023-10-16 18:44:24 +00:00
query.push(("limit", v.to_string()));
2023-02-01 05:28:12 +00:00
}
if let Some(v) = &page_token {
2023-10-16 18:44:24 +00:00
query.push(("page_token", v.to_string()));
2023-02-01 05:28:12 +00:00
}
if let Some(v) = &sort_by {
2023-10-16 18:44:24 +00:00
query.push(("sort_by", v.to_string()));
2023-02-01 05:28:12 +00:00
}
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.get(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
2023-10-16 18:44:24 +00:00
.query(&query)
2023-04-25 00:42:22 +00:00
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
200u16 => ResponseValue::from_response(response).await,
2023-02-01 05:28:12 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2023-02-01 05:28:12 +00:00
}
}
///List system-wide images as a Stream
///
///Returns a list of all the system-wide images. System-wide images are
/// returned sorted by creation date, with the most recent images appearing
/// first.
///
///Sends repeated `GET` requests to `/system/images` until there are no
/// more results.
///
///Arguments:
/// - `limit`: Maximum number of items returned by a single call
/// - `sort_by`
pub fn system_image_list_stream<'a>(
&'a self,
limit: Option<std::num::NonZeroU32>,
sort_by: Option<types::NameSortMode>,
) -> impl futures::Stream<Item = Result<types::GlobalImage, Error<types::Error>>> + Unpin + '_
{
use futures::StreamExt;
use futures::TryFutureExt;
use futures::TryStreamExt;
2023-05-04 03:53:28 +00:00
let final_stream_limit = limit
.clone()
.and_then(|x| std::num::NonZeroUsize::try_from(x).ok())
.map(std::num::NonZeroUsize::get)
.unwrap_or(usize::MAX);
2023-02-01 05:28:12 +00:00
self.system_image_list(limit, None, sort_by)
.map_ok(move |page| {
let page = page.into_inner();
2023-05-08 03:43:45 +00:00
let first = futures::stream::iter(page.items).map(Ok);
2023-02-01 05:28:12 +00:00
let rest = futures::stream::try_unfold(page.next_page, move |state| async move {
if state.is_none() {
Ok(None)
} else {
self.system_image_list(None, state.as_deref(), None)
.map_ok(|page| {
let page = page.into_inner();
2023-05-08 03:43:45 +00:00
Some((futures::stream::iter(page.items).map(Ok), page.next_page))
2023-02-01 05:28:12 +00:00
})
.await
}
})
.try_flatten();
first.chain(rest)
})
.try_flatten_stream()
2023-05-04 03:53:28 +00:00
.take(final_stream_limit)
2023-02-01 05:28:12 +00:00
.boxed()
}
///Create a system-wide image
///
///Create a new system-wide image. This image can then be used by any user
/// in any silo as a base for instances.
///
///Sends a `POST` request to `/system/images`
pub async fn system_image_create<'a>(
&'a self,
body: &'a types::GlobalImageCreate,
) -> Result<ResponseValue<types::GlobalImage>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!("{}/system/images", self.baseurl,);
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.post(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
.json(&body)
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
201u16 => ResponseValue::from_response(response).await,
2023-02-01 05:28:12 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2023-02-01 05:28:12 +00:00
}
}
///Fetch a system-wide image
///
///Returns the details of a specific system-wide image.
///
///Sends a `GET` request to `/system/images/{image_name}`
pub async fn system_image_view<'a>(
&'a self,
image_name: &'a types::Name,
) -> Result<ResponseValue<types::GlobalImage>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!(
2023-02-01 05:28:12 +00:00
"{}/system/images/{}",
self.baseurl,
encode_path(&image_name.to_string()),
);
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.get(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
200u16 => ResponseValue::from_response(response).await,
2023-02-01 05:28:12 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2023-02-01 05:28:12 +00:00
}
}
///Delete a system-wide image
///
///Permanently delete a system-wide image. This operation cannot be undone.
/// Any instances using the system-wide image will continue to run, however
/// new instances can not be created with this image.
///
///Sends a `DELETE` request to `/system/images/{image_name}`
pub async fn system_image_delete<'a>(
&'a self,
image_name: &'a types::Name,
) -> Result<ResponseValue<()>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!(
2023-02-01 05:28:12 +00:00
"{}/system/images/{}",
self.baseurl,
encode_path(&image_name.to_string()),
);
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.delete(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
204u16 => Ok(ResponseValue::empty(response)),
2023-02-01 05:28:12 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2023-02-01 05:28:12 +00:00
}
}
///List IP pools
///
///Sends a `GET` request to `/system/ip-pools`
///
///Arguments:
/// - `limit`: Maximum number of items returned by a single call
/// - `page_token`: Token returned by previous call to retrieve the
/// subsequent page
/// - `sort_by`
pub async fn ip_pool_list<'a>(
&'a self,
limit: Option<std::num::NonZeroU32>,
page_token: Option<&'a str>,
sort_by: Option<types::NameOrIdSortMode>,
) -> Result<ResponseValue<types::IpPoolResultsPage>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!("{}/system/ip-pools", self.baseurl,);
let mut query = Vec::with_capacity(3usize);
2023-02-01 05:28:12 +00:00
if let Some(v) = &limit {
2023-10-16 18:44:24 +00:00
query.push(("limit", v.to_string()));
2023-02-01 05:28:12 +00:00
}
if let Some(v) = &page_token {
2023-10-16 18:44:24 +00:00
query.push(("page_token", v.to_string()));
2023-02-01 05:28:12 +00:00
}
if let Some(v) = &sort_by {
2023-10-16 18:44:24 +00:00
query.push(("sort_by", v.to_string()));
2023-02-01 05:28:12 +00:00
}
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.get(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
2023-10-16 18:44:24 +00:00
.query(&query)
2023-04-25 00:42:22 +00:00
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
200u16 => ResponseValue::from_response(response).await,
2023-02-01 05:28:12 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2023-02-01 05:28:12 +00:00
}
}
///List IP pools as a Stream
///
///Sends repeated `GET` requests to `/system/ip-pools` until there are no
/// more results.
///
///Arguments:
/// - `limit`: Maximum number of items returned by a single call
/// - `sort_by`
pub fn ip_pool_list_stream<'a>(
&'a self,
limit: Option<std::num::NonZeroU32>,
sort_by: Option<types::NameOrIdSortMode>,
) -> impl futures::Stream<Item = Result<types::IpPool, Error<types::Error>>> + Unpin + '_ {
use futures::StreamExt;
use futures::TryFutureExt;
use futures::TryStreamExt;
2023-05-04 03:53:28 +00:00
let final_stream_limit = limit
.clone()
.and_then(|x| std::num::NonZeroUsize::try_from(x).ok())
.map(std::num::NonZeroUsize::get)
.unwrap_or(usize::MAX);
2023-02-01 05:28:12 +00:00
self.ip_pool_list(limit, None, sort_by)
.map_ok(move |page| {
let page = page.into_inner();
2023-05-08 03:43:45 +00:00
let first = futures::stream::iter(page.items).map(Ok);
2023-02-01 05:28:12 +00:00
let rest = futures::stream::try_unfold(page.next_page, move |state| async move {
if state.is_none() {
Ok(None)
} else {
self.ip_pool_list(None, state.as_deref(), None)
.map_ok(|page| {
let page = page.into_inner();
2023-05-08 03:43:45 +00:00
Some((futures::stream::iter(page.items).map(Ok), page.next_page))
2023-02-01 05:28:12 +00:00
})
.await
}
})
.try_flatten();
first.chain(rest)
})
.try_flatten_stream()
2023-05-04 03:53:28 +00:00
.take(final_stream_limit)
2023-02-01 05:28:12 +00:00
.boxed()
}
///Create an IP pool
///
///Sends a `POST` request to `/system/ip-pools`
pub async fn ip_pool_create<'a>(
&'a self,
body: &'a types::IpPoolCreate,
) -> Result<ResponseValue<types::IpPool>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!("{}/system/ip-pools", self.baseurl,);
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.post(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
.json(&body)
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
201u16 => ResponseValue::from_response(response).await,
2023-02-01 05:28:12 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2023-02-01 05:28:12 +00:00
}
}
///Fetch an IP pool
///
///Sends a `GET` request to `/system/ip-pools/{pool_name}`
pub async fn ip_pool_view<'a>(
&'a self,
pool_name: &'a types::Name,
) -> Result<ResponseValue<types::IpPool>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!(
2023-02-01 05:28:12 +00:00
"{}/system/ip-pools/{}",
self.baseurl,
encode_path(&pool_name.to_string()),
);
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.get(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
200u16 => ResponseValue::from_response(response).await,
2023-02-01 05:28:12 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2023-02-01 05:28:12 +00:00
}
}
///Update an IP Pool
///
///Sends a `PUT` request to `/system/ip-pools/{pool_name}`
pub async fn ip_pool_update<'a>(
&'a self,
pool_name: &'a types::Name,
body: &'a types::IpPoolUpdate,
) -> Result<ResponseValue<types::IpPool>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!(
2023-02-01 05:28:12 +00:00
"{}/system/ip-pools/{}",
self.baseurl,
encode_path(&pool_name.to_string()),
);
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.put(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
.json(&body)
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
200u16 => ResponseValue::from_response(response).await,
2023-02-01 05:28:12 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2023-02-01 05:28:12 +00:00
}
}
///Delete an IP Pool
///
///Sends a `DELETE` request to `/system/ip-pools/{pool_name}`
pub async fn ip_pool_delete<'a>(
&'a self,
pool_name: &'a types::Name,
) -> Result<ResponseValue<()>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!(
2023-02-01 05:28:12 +00:00
"{}/system/ip-pools/{}",
self.baseurl,
encode_path(&pool_name.to_string()),
);
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.delete(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
204u16 => Ok(ResponseValue::empty(response)),
2023-02-01 05:28:12 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2023-02-01 05:28:12 +00:00
}
}
///List ranges for an IP pool
///
///Ranges are ordered by their first address.
///
///Sends a `GET` request to `/system/ip-pools/{pool_name}/ranges`
///
///Arguments:
/// - `pool_name`
/// - `limit`: Maximum number of items returned by a single call
/// - `page_token`: Token returned by previous call to retrieve the
/// subsequent page
pub async fn ip_pool_range_list<'a>(
&'a self,
pool_name: &'a types::Name,
limit: Option<std::num::NonZeroU32>,
page_token: Option<&'a str>,
) -> Result<ResponseValue<types::IpPoolRangeResultsPage>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!(
2023-02-01 05:28:12 +00:00
"{}/system/ip-pools/{}/ranges",
self.baseurl,
encode_path(&pool_name.to_string()),
);
2023-10-16 18:44:24 +00:00
let mut query = Vec::with_capacity(2usize);
2023-02-01 05:28:12 +00:00
if let Some(v) = &limit {
2023-10-16 18:44:24 +00:00
query.push(("limit", v.to_string()));
2023-02-01 05:28:12 +00:00
}
if let Some(v) = &page_token {
2023-10-16 18:44:24 +00:00
query.push(("page_token", v.to_string()));
2023-02-01 05:28:12 +00:00
}
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.get(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
2023-10-16 18:44:24 +00:00
.query(&query)
2023-04-25 00:42:22 +00:00
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
200u16 => ResponseValue::from_response(response).await,
2023-02-01 05:28:12 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2023-02-01 05:28:12 +00:00
}
}
///List ranges for an IP pool as a Stream
///
///Ranges are ordered by their first address.
///
///Sends repeated `GET` requests to `/system/ip-pools/{pool_name}/ranges`
/// until there are no more results.
///
///Arguments:
/// - `pool_name`
/// - `limit`: Maximum number of items returned by a single call
pub fn ip_pool_range_list_stream<'a>(
&'a self,
pool_name: &'a types::Name,
limit: Option<std::num::NonZeroU32>,
) -> impl futures::Stream<Item = Result<types::IpPoolRange, Error<types::Error>>> + Unpin + '_
{
use futures::StreamExt;
use futures::TryFutureExt;
use futures::TryStreamExt;
2023-05-04 03:53:28 +00:00
let final_stream_limit = limit
.clone()
.and_then(|x| std::num::NonZeroUsize::try_from(x).ok())
.map(std::num::NonZeroUsize::get)
.unwrap_or(usize::MAX);
2023-02-01 05:28:12 +00:00
self.ip_pool_range_list(pool_name, limit, None)
.map_ok(move |page| {
let page = page.into_inner();
2023-05-08 03:43:45 +00:00
let first = futures::stream::iter(page.items).map(Ok);
2023-02-01 05:28:12 +00:00
let rest = futures::stream::try_unfold(page.next_page, move |state| async move {
if state.is_none() {
Ok(None)
} else {
self.ip_pool_range_list(pool_name, None, state.as_deref())
.map_ok(|page| {
let page = page.into_inner();
2023-05-08 03:43:45 +00:00
Some((futures::stream::iter(page.items).map(Ok), page.next_page))
2023-02-01 05:28:12 +00:00
})
.await
}
})
.try_flatten();
first.chain(rest)
})
.try_flatten_stream()
2023-05-04 03:53:28 +00:00
.take(final_stream_limit)
2023-02-01 05:28:12 +00:00
.boxed()
}
///Add a range to an IP pool
///
///Sends a `POST` request to `/system/ip-pools/{pool_name}/ranges/add`
pub async fn ip_pool_range_add<'a>(
&'a self,
pool_name: &'a types::Name,
body: &'a types::IpRange,
) -> Result<ResponseValue<types::IpPoolRange>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!(
2023-02-01 05:28:12 +00:00
"{}/system/ip-pools/{}/ranges/add",
self.baseurl,
encode_path(&pool_name.to_string()),
);
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.post(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
.json(&body)
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
201u16 => ResponseValue::from_response(response).await,
2023-04-25 00:42:22 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2023-02-01 05:28:12 +00:00
}
}
///Remove a range from an IP pool
///
///Sends a `POST` request to `/system/ip-pools/{pool_name}/ranges/remove`
pub async fn ip_pool_range_remove<'a>(
&'a self,
pool_name: &'a types::Name,
body: &'a types::IpRange,
) -> Result<ResponseValue<()>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!(
2023-02-01 05:28:12 +00:00
"{}/system/ip-pools/{}/ranges/remove",
self.baseurl,
encode_path(&pool_name.to_string()),
);
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.post(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
.json(&body)
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
204u16 => Ok(ResponseValue::empty(response)),
2023-02-01 05:28:12 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2023-02-01 05:28:12 +00:00
}
}
///Fetch the IP pool used for Oxide services
///
///Sends a `GET` request to `/system/ip-pools-service`
pub async fn ip_pool_service_view<'a>(
&'a self,
) -> Result<ResponseValue<types::IpPool>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!("{}/system/ip-pools-service", self.baseurl,);
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.get(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
200u16 => ResponseValue::from_response(response).await,
2023-02-01 05:28:12 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2023-02-01 05:28:12 +00:00
}
}
///List ranges for the IP pool used for Oxide services
///
///Ranges are ordered by their first address.
///
///Sends a `GET` request to `/system/ip-pools-service/ranges`
///
///Arguments:
/// - `limit`: Maximum number of items returned by a single call
/// - `page_token`: Token returned by previous call to retrieve the
/// subsequent page
pub async fn ip_pool_service_range_list<'a>(
&'a self,
limit: Option<std::num::NonZeroU32>,
page_token: Option<&'a str>,
) -> Result<ResponseValue<types::IpPoolRangeResultsPage>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!("{}/system/ip-pools-service/ranges", self.baseurl,);
let mut query = Vec::with_capacity(2usize);
2023-02-01 05:28:12 +00:00
if let Some(v) = &limit {
2023-10-16 18:44:24 +00:00
query.push(("limit", v.to_string()));
2023-02-01 05:28:12 +00:00
}
if let Some(v) = &page_token {
2023-10-16 18:44:24 +00:00
query.push(("page_token", v.to_string()));
2023-02-01 05:28:12 +00:00
}
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.get(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
2023-10-16 18:44:24 +00:00
.query(&query)
2023-04-25 00:42:22 +00:00
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
200u16 => ResponseValue::from_response(response).await,
2023-02-01 05:28:12 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2023-02-01 05:28:12 +00:00
}
}
///List ranges for the IP pool used for Oxide services as a Stream
///
///Ranges are ordered by their first address.
///
///Sends repeated `GET` requests to `/system/ip-pools-service/ranges` until
/// there are no more results.
///
///Arguments:
/// - `limit`: Maximum number of items returned by a single call
pub fn ip_pool_service_range_list_stream<'a>(
&'a self,
limit: Option<std::num::NonZeroU32>,
) -> impl futures::Stream<Item = Result<types::IpPoolRange, Error<types::Error>>> + Unpin + '_
{
use futures::StreamExt;
use futures::TryFutureExt;
use futures::TryStreamExt;
2023-05-04 03:53:28 +00:00
let final_stream_limit = limit
.clone()
.and_then(|x| std::num::NonZeroUsize::try_from(x).ok())
.map(std::num::NonZeroUsize::get)
.unwrap_or(usize::MAX);
2023-02-01 05:28:12 +00:00
self.ip_pool_service_range_list(limit, None)
.map_ok(move |page| {
let page = page.into_inner();
2023-05-08 03:43:45 +00:00
let first = futures::stream::iter(page.items).map(Ok);
2023-02-01 05:28:12 +00:00
let rest = futures::stream::try_unfold(page.next_page, move |state| async move {
if state.is_none() {
Ok(None)
} else {
self.ip_pool_service_range_list(None, state.as_deref())
.map_ok(|page| {
let page = page.into_inner();
2023-05-08 03:43:45 +00:00
Some((futures::stream::iter(page.items).map(Ok), page.next_page))
2023-02-01 05:28:12 +00:00
})
.await
}
})
.try_flatten();
first.chain(rest)
})
.try_flatten_stream()
2023-05-04 03:53:28 +00:00
.take(final_stream_limit)
2023-02-01 05:28:12 +00:00
.boxed()
}
///Add a range to an IP pool used for Oxide services
///
///Sends a `POST` request to `/system/ip-pools-service/ranges/add`
pub async fn ip_pool_service_range_add<'a>(
&'a self,
body: &'a types::IpRange,
) -> Result<ResponseValue<types::IpPoolRange>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!("{}/system/ip-pools-service/ranges/add", self.baseurl,);
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.post(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
.json(&body)
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
201u16 => ResponseValue::from_response(response).await,
2023-02-01 05:28:12 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2023-02-01 05:28:12 +00:00
}
}
///Remove a range from an IP pool used for Oxide services
///
///Sends a `POST` request to `/system/ip-pools-service/ranges/remove`
pub async fn ip_pool_service_range_remove<'a>(
&'a self,
body: &'a types::IpRange,
) -> Result<ResponseValue<()>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!("{}/system/ip-pools-service/ranges/remove", self.baseurl,);
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.post(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
.json(&body)
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
204u16 => Ok(ResponseValue::empty(response)),
2023-02-01 05:28:12 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2023-02-01 05:28:12 +00:00
}
}
///Access metrics data
///
///Sends a `GET` request to `/system/metrics/{metric_name}`
///
///Arguments:
/// - `metric_name`
/// - `end_time`: An exclusive end time of metrics.
/// - `id`: The UUID of the container being queried
/// - `limit`: Maximum number of items returned by a single call
/// - `page_token`: Token returned by previous call to retrieve the
/// subsequent page
/// - `start_time`: An inclusive start time of metrics.
pub async fn system_metric<'a>(
&'a self,
metric_name: types::SystemMetricName,
end_time: Option<&'a chrono::DateTime<chrono::offset::Utc>>,
id: &'a uuid::Uuid,
limit: Option<std::num::NonZeroU32>,
page_token: Option<&'a str>,
start_time: Option<&'a chrono::DateTime<chrono::offset::Utc>>,
) -> Result<ResponseValue<types::MeasurementResultsPage>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!(
2023-02-01 05:28:12 +00:00
"{}/system/metrics/{}",
self.baseurl,
encode_path(&metric_name.to_string()),
);
2023-10-16 18:44:24 +00:00
let mut query = Vec::with_capacity(5usize);
2023-02-01 05:28:12 +00:00
if let Some(v) = &end_time {
2023-10-16 18:44:24 +00:00
query.push(("end_time", v.to_string()));
2023-02-01 05:28:12 +00:00
}
2023-10-16 18:44:24 +00:00
query.push(("id", id.to_string()));
2023-02-01 05:28:12 +00:00
if let Some(v) = &limit {
2023-10-16 18:44:24 +00:00
query.push(("limit", v.to_string()));
2023-02-01 05:28:12 +00:00
}
if let Some(v) = &page_token {
2023-10-16 18:44:24 +00:00
query.push(("page_token", v.to_string()));
2023-02-01 05:28:12 +00:00
}
if let Some(v) = &start_time {
2023-10-16 18:44:24 +00:00
query.push(("start_time", v.to_string()));
2023-02-01 05:28:12 +00:00
}
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.get(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
2023-10-16 18:44:24 +00:00
.query(&query)
2023-04-25 00:42:22 +00:00
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
200u16 => ResponseValue::from_response(response).await,
2023-02-01 05:28:12 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2023-02-01 05:28:12 +00:00
}
}
///Fetch the top-level IAM policy
///
///Sends a `GET` request to `/system/policy`
pub async fn system_policy_view<'a>(
&'a self,
) -> Result<ResponseValue<types::FleetRolePolicy>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!("{}/system/policy", self.baseurl,);
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.get(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
200u16 => ResponseValue::from_response(response).await,
2023-02-01 05:28:12 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2023-02-01 05:28:12 +00:00
}
}
///Update the top-level IAM policy
///
///Sends a `PUT` request to `/system/policy`
pub async fn system_policy_update<'a>(
&'a self,
body: &'a types::FleetRolePolicy,
) -> Result<ResponseValue<types::FleetRolePolicy>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!("{}/system/policy", self.baseurl,);
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.put(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
.json(&body)
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
200u16 => ResponseValue::from_response(response).await,
2023-02-01 05:28:12 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2023-02-01 05:28:12 +00:00
}
}
///List sagas
///
///Sends a `GET` request to `/system/sagas`
///
///Arguments:
/// - `limit`: Maximum number of items returned by a single call
/// - `page_token`: Token returned by previous call to retrieve the
/// subsequent page
/// - `sort_by`
pub async fn saga_list<'a>(
&'a self,
limit: Option<std::num::NonZeroU32>,
page_token: Option<&'a str>,
sort_by: Option<types::IdSortMode>,
) -> Result<ResponseValue<types::SagaResultsPage>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!("{}/system/sagas", self.baseurl,);
let mut query = Vec::with_capacity(3usize);
2023-02-01 05:28:12 +00:00
if let Some(v) = &limit {
2023-10-16 18:44:24 +00:00
query.push(("limit", v.to_string()));
2023-02-01 05:28:12 +00:00
}
if let Some(v) = &page_token {
2023-10-16 18:44:24 +00:00
query.push(("page_token", v.to_string()));
2023-02-01 05:28:12 +00:00
}
if let Some(v) = &sort_by {
2023-10-16 18:44:24 +00:00
query.push(("sort_by", v.to_string()));
2023-02-01 05:28:12 +00:00
}
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.get(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
2023-10-16 18:44:24 +00:00
.query(&query)
2023-04-25 00:42:22 +00:00
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
200u16 => ResponseValue::from_response(response).await,
2023-02-01 05:28:12 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2023-02-01 05:28:12 +00:00
}
}
///List sagas as a Stream
///
///Sends repeated `GET` requests to `/system/sagas` until there are no more
/// results.
///
///Arguments:
/// - `limit`: Maximum number of items returned by a single call
/// - `sort_by`
pub fn saga_list_stream<'a>(
&'a self,
limit: Option<std::num::NonZeroU32>,
sort_by: Option<types::IdSortMode>,
) -> impl futures::Stream<Item = Result<types::Saga, Error<types::Error>>> + Unpin + '_ {
use futures::StreamExt;
use futures::TryFutureExt;
use futures::TryStreamExt;
2023-05-04 03:53:28 +00:00
let final_stream_limit = limit
.clone()
.and_then(|x| std::num::NonZeroUsize::try_from(x).ok())
.map(std::num::NonZeroUsize::get)
.unwrap_or(usize::MAX);
2023-02-01 05:28:12 +00:00
self.saga_list(limit, None, sort_by)
.map_ok(move |page| {
let page = page.into_inner();
2023-05-08 03:43:45 +00:00
let first = futures::stream::iter(page.items).map(Ok);
2023-02-01 05:28:12 +00:00
let rest = futures::stream::try_unfold(page.next_page, move |state| async move {
if state.is_none() {
Ok(None)
} else {
self.saga_list(None, state.as_deref(), None)
.map_ok(|page| {
let page = page.into_inner();
2023-05-08 03:43:45 +00:00
Some((futures::stream::iter(page.items).map(Ok), page.next_page))
2023-02-01 05:28:12 +00:00
})
.await
}
})
.try_flatten();
first.chain(rest)
})
.try_flatten_stream()
2023-05-04 03:53:28 +00:00
.take(final_stream_limit)
2023-02-01 05:28:12 +00:00
.boxed()
}
///Fetch a saga
///
///Sends a `GET` request to `/system/sagas/{saga_id}`
pub async fn saga_view<'a>(
&'a self,
saga_id: &'a uuid::Uuid,
) -> Result<ResponseValue<types::Saga>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!(
2023-02-01 05:28:12 +00:00
"{}/system/sagas/{}",
self.baseurl,
encode_path(&saga_id.to_string()),
);
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.get(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
200u16 => ResponseValue::from_response(response).await,
2023-02-01 05:28:12 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2023-02-01 05:28:12 +00:00
}
}
///List silos
///
///Lists silos that are discoverable based on the current permissions.
///
///Sends a `GET` request to `/system/silos`
///
///Arguments:
/// - `limit`: Maximum number of items returned by a single call
/// - `page_token`: Token returned by previous call to retrieve the
/// subsequent page
/// - `sort_by`
pub async fn silo_list<'a>(
&'a self,
limit: Option<std::num::NonZeroU32>,
page_token: Option<&'a str>,
sort_by: Option<types::NameOrIdSortMode>,
) -> Result<ResponseValue<types::SiloResultsPage>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!("{}/system/silos", self.baseurl,);
let mut query = Vec::with_capacity(3usize);
2023-02-01 05:28:12 +00:00
if let Some(v) = &limit {
2023-10-16 18:44:24 +00:00
query.push(("limit", v.to_string()));
2023-02-01 05:28:12 +00:00
}
if let Some(v) = &page_token {
2023-10-16 18:44:24 +00:00
query.push(("page_token", v.to_string()));
2023-02-01 05:28:12 +00:00
}
if let Some(v) = &sort_by {
2023-10-16 18:44:24 +00:00
query.push(("sort_by", v.to_string()));
2023-02-01 05:28:12 +00:00
}
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.get(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
2023-10-16 18:44:24 +00:00
.query(&query)
2023-04-25 00:42:22 +00:00
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
200u16 => ResponseValue::from_response(response).await,
2023-02-01 05:28:12 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2023-02-01 05:28:12 +00:00
}
}
///List silos as a Stream
///
///Lists silos that are discoverable based on the current permissions.
///
///Sends repeated `GET` requests to `/system/silos` until there are no more
/// results.
///
///Arguments:
/// - `limit`: Maximum number of items returned by a single call
/// - `sort_by`
pub fn silo_list_stream<'a>(
&'a self,
limit: Option<std::num::NonZeroU32>,
sort_by: Option<types::NameOrIdSortMode>,
) -> impl futures::Stream<Item = Result<types::Silo, Error<types::Error>>> + Unpin + '_ {
use futures::StreamExt;
use futures::TryFutureExt;
use futures::TryStreamExt;
2023-05-04 03:53:28 +00:00
let final_stream_limit = limit
.clone()
.and_then(|x| std::num::NonZeroUsize::try_from(x).ok())
.map(std::num::NonZeroUsize::get)
.unwrap_or(usize::MAX);
2023-02-01 05:28:12 +00:00
self.silo_list(limit, None, sort_by)
.map_ok(move |page| {
let page = page.into_inner();
2023-05-08 03:43:45 +00:00
let first = futures::stream::iter(page.items).map(Ok);
2023-02-01 05:28:12 +00:00
let rest = futures::stream::try_unfold(page.next_page, move |state| async move {
if state.is_none() {
Ok(None)
} else {
self.silo_list(None, state.as_deref(), None)
.map_ok(|page| {
let page = page.into_inner();
2023-05-08 03:43:45 +00:00
Some((futures::stream::iter(page.items).map(Ok), page.next_page))
2023-02-01 05:28:12 +00:00
})
.await
}
})
.try_flatten();
first.chain(rest)
})
.try_flatten_stream()
2023-05-04 03:53:28 +00:00
.take(final_stream_limit)
2023-02-01 05:28:12 +00:00
.boxed()
}
///Create a silo
///
///Sends a `POST` request to `/system/silos`
pub async fn silo_create<'a>(
&'a self,
body: &'a types::SiloCreate,
) -> Result<ResponseValue<types::Silo>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!("{}/system/silos", self.baseurl,);
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.post(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
.json(&body)
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
201u16 => ResponseValue::from_response(response).await,
2023-02-01 05:28:12 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2023-02-01 05:28:12 +00:00
}
}
///Fetch a silo
///
///Fetch a silo by name.
///
///Sends a `GET` request to `/system/silos/{silo_name}`
///
///Arguments:
/// - `silo_name`: The silo's unique name.
pub async fn silo_view<'a>(
&'a self,
silo_name: &'a types::Name,
) -> Result<ResponseValue<types::Silo>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!(
2023-02-01 05:28:12 +00:00
"{}/system/silos/{}",
self.baseurl,
encode_path(&silo_name.to_string()),
);
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.get(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
200u16 => ResponseValue::from_response(response).await,
2023-02-01 05:28:12 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2023-02-01 05:28:12 +00:00
}
}
///Delete a silo
///
///Delete a silo by name.
///
///Sends a `DELETE` request to `/system/silos/{silo_name}`
///
///Arguments:
/// - `silo_name`: The silo's unique name.
pub async fn silo_delete<'a>(
&'a self,
silo_name: &'a types::Name,
) -> Result<ResponseValue<()>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!(
2023-02-01 05:28:12 +00:00
"{}/system/silos/{}",
self.baseurl,
encode_path(&silo_name.to_string()),
);
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.delete(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
204u16 => Ok(ResponseValue::empty(response)),
2023-02-01 05:28:12 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2023-02-01 05:28:12 +00:00
}
}
///List a silo's IDPs
///
///Sends a `GET` request to `/system/silos/{silo_name}/identity-providers`
///
///Arguments:
/// - `silo_name`: The silo's unique name.
/// - `limit`: Maximum number of items returned by a single call
/// - `page_token`: Token returned by previous call to retrieve the
/// subsequent page
/// - `sort_by`
pub async fn silo_identity_provider_list<'a>(
&'a self,
silo_name: &'a types::Name,
limit: Option<std::num::NonZeroU32>,
page_token: Option<&'a str>,
sort_by: Option<types::NameSortMode>,
) -> Result<ResponseValue<types::IdentityProviderResultsPage>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!(
2023-02-01 05:28:12 +00:00
"{}/system/silos/{}/identity-providers",
self.baseurl,
encode_path(&silo_name.to_string()),
);
2023-10-16 18:44:24 +00:00
let mut query = Vec::with_capacity(3usize);
2023-02-01 05:28:12 +00:00
if let Some(v) = &limit {
2023-10-16 18:44:24 +00:00
query.push(("limit", v.to_string()));
2023-02-01 05:28:12 +00:00
}
if let Some(v) = &page_token {
2023-10-16 18:44:24 +00:00
query.push(("page_token", v.to_string()));
2023-02-01 05:28:12 +00:00
}
if let Some(v) = &sort_by {
2023-10-16 18:44:24 +00:00
query.push(("sort_by", v.to_string()));
2023-02-01 05:28:12 +00:00
}
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.get(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
2023-10-16 18:44:24 +00:00
.query(&query)
2023-04-25 00:42:22 +00:00
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
200u16 => ResponseValue::from_response(response).await,
2023-02-01 05:28:12 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2023-02-01 05:28:12 +00:00
}
}
///List a silo's IDPs as a Stream
///
///Sends repeated `GET` requests to
/// `/system/silos/{silo_name}/identity-providers` until there are no more
/// results.
///
///Arguments:
/// - `silo_name`: The silo's unique name.
/// - `limit`: Maximum number of items returned by a single call
/// - `sort_by`
pub fn silo_identity_provider_list_stream<'a>(
&'a self,
silo_name: &'a types::Name,
limit: Option<std::num::NonZeroU32>,
sort_by: Option<types::NameSortMode>,
) -> impl futures::Stream<Item = Result<types::IdentityProvider, Error<types::Error>>> + Unpin + '_
{
use futures::StreamExt;
use futures::TryFutureExt;
use futures::TryStreamExt;
2023-05-04 03:53:28 +00:00
let final_stream_limit = limit
.clone()
.and_then(|x| std::num::NonZeroUsize::try_from(x).ok())
.map(std::num::NonZeroUsize::get)
.unwrap_or(usize::MAX);
2023-02-01 05:28:12 +00:00
self.silo_identity_provider_list(silo_name, limit, None, sort_by)
.map_ok(move |page| {
let page = page.into_inner();
2023-05-08 03:43:45 +00:00
let first = futures::stream::iter(page.items).map(Ok);
2023-02-01 05:28:12 +00:00
let rest = futures::stream::try_unfold(page.next_page, move |state| async move {
if state.is_none() {
Ok(None)
} else {
self.silo_identity_provider_list(silo_name, None, state.as_deref(), None)
.map_ok(|page| {
let page = page.into_inner();
2023-05-08 03:43:45 +00:00
Some((futures::stream::iter(page.items).map(Ok), page.next_page))
2023-02-01 05:28:12 +00:00
})
.await
}
})
.try_flatten();
first.chain(rest)
})
.try_flatten_stream()
2023-05-04 03:53:28 +00:00
.take(final_stream_limit)
2023-02-01 05:28:12 +00:00
.boxed()
}
///Create a user
///
///Users can only be created in Silos with `provision_type` == `Fixed`.
/// Otherwise, Silo users are just-in-time (JIT) provisioned when a user
/// first logs in using an external Identity Provider.
///
///Sends a `POST` request to
/// `/system/silos/{silo_name}/identity-providers/local/users`
///
///Arguments:
/// - `silo_name`: The silo's unique name.
/// - `body`
pub async fn local_idp_user_create<'a>(
&'a self,
silo_name: &'a types::Name,
body: &'a types::UserCreate,
) -> Result<ResponseValue<types::User>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!(
2023-02-01 05:28:12 +00:00
"{}/system/silos/{}/identity-providers/local/users",
self.baseurl,
encode_path(&silo_name.to_string()),
);
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.post(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
.json(&body)
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
201u16 => ResponseValue::from_response(response).await,
2023-02-01 05:28:12 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2023-02-01 05:28:12 +00:00
}
}
///Delete a user
///
///Sends a `DELETE` request to
/// `/system/silos/{silo_name}/identity-providers/local/users/{user_id}`
///
///Arguments:
/// - `silo_name`: The silo's unique name.
/// - `user_id`: The user's internal id
pub async fn local_idp_user_delete<'a>(
&'a self,
silo_name: &'a types::Name,
user_id: &'a uuid::Uuid,
) -> Result<ResponseValue<()>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!(
2023-02-01 05:28:12 +00:00
"{}/system/silos/{}/identity-providers/local/users/{}",
self.baseurl,
encode_path(&silo_name.to_string()),
encode_path(&user_id.to_string()),
);
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.delete(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
204u16 => Ok(ResponseValue::empty(response)),
2023-02-01 05:28:12 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2023-02-01 05:28:12 +00:00
}
}
///Set or invalidate a user's password
///
///Passwords can only be updated for users in Silos with identity mode
/// `LocalOnly`.
///
///Sends a `POST` request to
/// `/system/silos/{silo_name}/identity-providers/local/users/{user_id}/
/// set-password`
///
///Arguments:
/// - `silo_name`: The silo's unique name.
/// - `user_id`: The user's internal id
/// - `body`
pub async fn local_idp_user_set_password<'a>(
&'a self,
silo_name: &'a types::Name,
user_id: &'a uuid::Uuid,
body: &'a types::UserPassword,
) -> Result<ResponseValue<()>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!(
2023-02-01 05:28:12 +00:00
"{}/system/silos/{}/identity-providers/local/users/{}/set-password",
self.baseurl,
encode_path(&silo_name.to_string()),
encode_path(&user_id.to_string()),
);
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.post(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
.json(&body)
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
204u16 => Ok(ResponseValue::empty(response)),
2023-02-01 05:28:12 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2023-02-01 05:28:12 +00:00
}
}
///Create a SAML IDP
///
///Sends a `POST` request to
/// `/system/silos/{silo_name}/identity-providers/saml`
///
///Arguments:
/// - `silo_name`: The silo's unique name.
/// - `body`
pub async fn saml_identity_provider_create<'a>(
&'a self,
silo_name: &'a types::Name,
body: &'a types::SamlIdentityProviderCreate,
) -> Result<ResponseValue<types::SamlIdentityProvider>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!(
2023-02-01 05:28:12 +00:00
"{}/system/silos/{}/identity-providers/saml",
self.baseurl,
encode_path(&silo_name.to_string()),
);
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.post(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
.json(&body)
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
201u16 => ResponseValue::from_response(response).await,
2023-02-01 05:28:12 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2023-02-01 05:28:12 +00:00
}
}
///Fetch a SAML IDP
///
///Sends a `GET` request to
/// `/system/silos/{silo_name}/identity-providers/saml/{provider_name}`
///
///Arguments:
/// - `silo_name`: The silo's unique name.
/// - `provider_name`: The SAML identity provider's name
pub async fn saml_identity_provider_view<'a>(
&'a self,
silo_name: &'a types::Name,
provider_name: &'a types::Name,
) -> Result<ResponseValue<types::SamlIdentityProvider>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!(
2023-02-01 05:28:12 +00:00
"{}/system/silos/{}/identity-providers/saml/{}",
self.baseurl,
encode_path(&silo_name.to_string()),
encode_path(&provider_name.to_string()),
);
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.get(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
200u16 => ResponseValue::from_response(response).await,
2023-02-01 05:28:12 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2023-02-01 05:28:12 +00:00
}
}
///Fetch a silo's IAM policy
///
///Sends a `GET` request to `/system/silos/{silo_name}/policy`
///
///Arguments:
/// - `silo_name`: The silo's unique name.
pub async fn silo_policy_view<'a>(
&'a self,
silo_name: &'a types::Name,
) -> Result<ResponseValue<types::SiloRolePolicy>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!(
2023-02-01 05:28:12 +00:00
"{}/system/silos/{}/policy",
self.baseurl,
encode_path(&silo_name.to_string()),
);
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.get(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
200u16 => ResponseValue::from_response(response).await,
2023-02-01 05:28:12 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2023-02-01 05:28:12 +00:00
}
}
///Update a silo's IAM policy
///
///Sends a `PUT` request to `/system/silos/{silo_name}/policy`
///
///Arguments:
/// - `silo_name`: The silo's unique name.
/// - `body`
pub async fn silo_policy_update<'a>(
&'a self,
silo_name: &'a types::Name,
body: &'a types::SiloRolePolicy,
) -> Result<ResponseValue<types::SiloRolePolicy>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!(
2023-02-01 05:28:12 +00:00
"{}/system/silos/{}/policy",
self.baseurl,
encode_path(&silo_name.to_string()),
);
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.put(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
.json(&body)
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
200u16 => ResponseValue::from_response(response).await,
2023-02-01 05:28:12 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2023-02-01 05:28:12 +00:00
}
}
///List users in a silo
///
///Sends a `GET` request to `/system/silos/{silo_name}/users/all`
///
///Arguments:
/// - `silo_name`: The silo's unique name.
/// - `limit`: Maximum number of items returned by a single call
/// - `page_token`: Token returned by previous call to retrieve the
/// subsequent page
/// - `sort_by`
pub async fn silo_users_list<'a>(
&'a self,
silo_name: &'a types::Name,
limit: Option<std::num::NonZeroU32>,
page_token: Option<&'a str>,
sort_by: Option<types::IdSortMode>,
) -> Result<ResponseValue<types::UserResultsPage>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!(
2023-02-01 05:28:12 +00:00
"{}/system/silos/{}/users/all",
self.baseurl,
encode_path(&silo_name.to_string()),
);
2023-10-16 18:44:24 +00:00
let mut query = Vec::with_capacity(3usize);
2023-02-01 05:28:12 +00:00
if let Some(v) = &limit {
2023-10-16 18:44:24 +00:00
query.push(("limit", v.to_string()));
2023-02-01 05:28:12 +00:00
}
if let Some(v) = &page_token {
2023-10-16 18:44:24 +00:00
query.push(("page_token", v.to_string()));
2023-02-01 05:28:12 +00:00
}
if let Some(v) = &sort_by {
2023-10-16 18:44:24 +00:00
query.push(("sort_by", v.to_string()));
2023-02-01 05:28:12 +00:00
}
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.get(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
2023-10-16 18:44:24 +00:00
.query(&query)
2023-04-25 00:42:22 +00:00
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
200u16 => ResponseValue::from_response(response).await,
2023-02-01 05:28:12 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2023-02-01 05:28:12 +00:00
}
}
///List users in a silo as a Stream
///
///Sends repeated `GET` requests to `/system/silos/{silo_name}/users/all`
/// until there are no more results.
///
///Arguments:
/// - `silo_name`: The silo's unique name.
/// - `limit`: Maximum number of items returned by a single call
/// - `sort_by`
pub fn silo_users_list_stream<'a>(
&'a self,
silo_name: &'a types::Name,
limit: Option<std::num::NonZeroU32>,
sort_by: Option<types::IdSortMode>,
) -> impl futures::Stream<Item = Result<types::User, Error<types::Error>>> + Unpin + '_ {
use futures::StreamExt;
use futures::TryFutureExt;
use futures::TryStreamExt;
2023-05-04 03:53:28 +00:00
let final_stream_limit = limit
.clone()
.and_then(|x| std::num::NonZeroUsize::try_from(x).ok())
.map(std::num::NonZeroUsize::get)
.unwrap_or(usize::MAX);
2023-02-01 05:28:12 +00:00
self.silo_users_list(silo_name, limit, None, sort_by)
.map_ok(move |page| {
let page = page.into_inner();
2023-05-08 03:43:45 +00:00
let first = futures::stream::iter(page.items).map(Ok);
2023-02-01 05:28:12 +00:00
let rest = futures::stream::try_unfold(page.next_page, move |state| async move {
if state.is_none() {
Ok(None)
} else {
self.silo_users_list(silo_name, None, state.as_deref(), None)
.map_ok(|page| {
let page = page.into_inner();
2023-05-08 03:43:45 +00:00
Some((futures::stream::iter(page.items).map(Ok), page.next_page))
2023-02-01 05:28:12 +00:00
})
.await
}
})
.try_flatten();
first.chain(rest)
})
.try_flatten_stream()
2023-05-04 03:53:28 +00:00
.take(final_stream_limit)
2023-02-01 05:28:12 +00:00
.boxed()
}
///Fetch a user
///
///Sends a `GET` request to `/system/silos/{silo_name}/users/id/{user_id}`
///
///Arguments:
/// - `silo_name`: The silo's unique name.
/// - `user_id`: The user's internal id
pub async fn silo_user_view<'a>(
&'a self,
silo_name: &'a types::Name,
user_id: &'a uuid::Uuid,
) -> Result<ResponseValue<types::User>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!(
2023-02-01 05:28:12 +00:00
"{}/system/silos/{}/users/id/{}",
self.baseurl,
encode_path(&silo_name.to_string()),
encode_path(&user_id.to_string()),
);
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.get(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
200u16 => ResponseValue::from_response(response).await,
2023-02-01 05:28:12 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2023-02-01 05:28:12 +00:00
}
}
///List built-in users
///
///Sends a `GET` request to `/system/user`
///
///Arguments:
/// - `limit`: Maximum number of items returned by a single call
/// - `page_token`: Token returned by previous call to retrieve the
/// subsequent page
/// - `sort_by`
pub async fn system_user_list<'a>(
&'a self,
limit: Option<std::num::NonZeroU32>,
page_token: Option<&'a str>,
sort_by: Option<types::NameSortMode>,
) -> Result<ResponseValue<types::UserBuiltinResultsPage>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!("{}/system/user", self.baseurl,);
let mut query = Vec::with_capacity(3usize);
2023-02-01 05:28:12 +00:00
if let Some(v) = &limit {
2023-10-16 18:44:24 +00:00
query.push(("limit", v.to_string()));
2023-02-01 05:28:12 +00:00
}
if let Some(v) = &page_token {
2023-10-16 18:44:24 +00:00
query.push(("page_token", v.to_string()));
2023-02-01 05:28:12 +00:00
}
if let Some(v) = &sort_by {
2023-10-16 18:44:24 +00:00
query.push(("sort_by", v.to_string()));
2023-02-01 05:28:12 +00:00
}
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.get(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
2023-10-16 18:44:24 +00:00
.query(&query)
2023-04-25 00:42:22 +00:00
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
200u16 => ResponseValue::from_response(response).await,
2023-02-01 05:28:12 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2023-02-01 05:28:12 +00:00
}
}
///List built-in users as a Stream
///
///Sends repeated `GET` requests to `/system/user` until there are no more
/// results.
///
///Arguments:
/// - `limit`: Maximum number of items returned by a single call
/// - `sort_by`
pub fn system_user_list_stream<'a>(
&'a self,
limit: Option<std::num::NonZeroU32>,
sort_by: Option<types::NameSortMode>,
) -> impl futures::Stream<Item = Result<types::UserBuiltin, Error<types::Error>>> + Unpin + '_
{
use futures::StreamExt;
use futures::TryFutureExt;
use futures::TryStreamExt;
2023-05-04 03:53:28 +00:00
let final_stream_limit = limit
.clone()
.and_then(|x| std::num::NonZeroUsize::try_from(x).ok())
.map(std::num::NonZeroUsize::get)
.unwrap_or(usize::MAX);
2023-02-01 05:28:12 +00:00
self.system_user_list(limit, None, sort_by)
.map_ok(move |page| {
let page = page.into_inner();
2023-05-08 03:43:45 +00:00
let first = futures::stream::iter(page.items).map(Ok);
2023-02-01 05:28:12 +00:00
let rest = futures::stream::try_unfold(page.next_page, move |state| async move {
if state.is_none() {
Ok(None)
} else {
self.system_user_list(None, state.as_deref(), None)
.map_ok(|page| {
let page = page.into_inner();
2023-05-08 03:43:45 +00:00
Some((futures::stream::iter(page.items).map(Ok), page.next_page))
2023-02-01 05:28:12 +00:00
})
.await
}
})
.try_flatten();
first.chain(rest)
})
.try_flatten_stream()
2023-05-04 03:53:28 +00:00
.take(final_stream_limit)
2023-02-01 05:28:12 +00:00
.boxed()
}
///Fetch a built-in user
///
///Sends a `GET` request to `/system/user/{user_name}`
///
///Arguments:
/// - `user_name`: The built-in user's unique name.
pub async fn system_user_view<'a>(
&'a self,
user_name: &'a types::Name,
) -> Result<ResponseValue<types::UserBuiltin>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!(
2023-02-01 05:28:12 +00:00
"{}/system/user/{}",
self.baseurl,
encode_path(&user_name.to_string()),
2021-12-10 02:15:24 +00:00
);
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.get(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
200u16 => ResponseValue::from_response(response).await,
2022-02-08 16:59:38 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-02-08 16:59:38 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-02-08 16:59:38 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2022-02-08 16:59:38 +00:00
}
2021-12-10 02:15:24 +00:00
}
2023-02-01 05:28:12 +00:00
///List timeseries schema
2022-07-03 02:09:38 +00:00
///
2023-02-01 05:28:12 +00:00
///Sends a `GET` request to `/timeseries/schema`
///
///Arguments:
/// - `limit`: Maximum number of items returned by a single call
/// - `page_token`: Token returned by previous call to retrieve the
/// subsequent page
pub async fn timeseries_schema_get<'a>(
&'a self,
limit: Option<std::num::NonZeroU32>,
page_token: Option<&'a str>,
) -> Result<ResponseValue<types::TimeseriesSchemaResultsPage>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!("{}/timeseries/schema", self.baseurl,);
let mut query = Vec::with_capacity(2usize);
2023-02-01 05:28:12 +00:00
if let Some(v) = &limit {
2023-10-16 18:44:24 +00:00
query.push(("limit", v.to_string()));
2023-02-01 05:28:12 +00:00
}
if let Some(v) = &page_token {
2023-10-16 18:44:24 +00:00
query.push(("page_token", v.to_string()));
2023-02-01 05:28:12 +00:00
}
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.get(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
2023-10-16 18:44:24 +00:00
.query(&query)
2023-04-25 00:42:22 +00:00
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
200u16 => ResponseValue::from_response(response).await,
2023-02-01 05:28:12 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2023-02-01 05:28:12 +00:00
}
}
///List timeseries schema as a Stream
///
///Sends repeated `GET` requests to `/timeseries/schema` until there are no
/// more results.
///
///Arguments:
/// - `limit`: Maximum number of items returned by a single call
pub fn timeseries_schema_get_stream<'a>(
&'a self,
limit: Option<std::num::NonZeroU32>,
) -> impl futures::Stream<Item = Result<types::TimeseriesSchema, Error<types::Error>>> + Unpin + '_
{
use futures::StreamExt;
use futures::TryFutureExt;
use futures::TryStreamExt;
2023-05-04 03:53:28 +00:00
let final_stream_limit = limit
.clone()
.and_then(|x| std::num::NonZeroUsize::try_from(x).ok())
.map(std::num::NonZeroUsize::get)
.unwrap_or(usize::MAX);
2023-02-01 05:28:12 +00:00
self.timeseries_schema_get(limit, None)
.map_ok(move |page| {
let page = page.into_inner();
2023-05-08 03:43:45 +00:00
let first = futures::stream::iter(page.items).map(Ok);
2023-02-01 05:28:12 +00:00
let rest = futures::stream::try_unfold(page.next_page, move |state| async move {
if state.is_none() {
Ok(None)
} else {
self.timeseries_schema_get(None, state.as_deref())
.map_ok(|page| {
let page = page.into_inner();
2023-05-08 03:43:45 +00:00
Some((futures::stream::iter(page.items).map(Ok), page.next_page))
2023-02-01 05:28:12 +00:00
})
.await
}
})
.try_flatten();
first.chain(rest)
})
.try_flatten_stream()
2023-05-04 03:53:28 +00:00
.take(final_stream_limit)
2023-02-01 05:28:12 +00:00
.boxed()
}
///List users
///
///Sends a `GET` request to `/users`
2022-07-03 02:09:38 +00:00
///
///Arguments:
/// - `limit`: Maximum number of items returned by a single call
2022-07-08 01:35:36 +00:00
/// - `page_token`: Token returned by previous call to retrieve the
2022-07-03 02:09:38 +00:00
/// subsequent page
/// - `sort_by`
2023-02-01 05:28:12 +00:00
pub async fn user_list<'a>(
2022-01-05 20:02:46 +00:00
&'a self,
2021-12-10 02:15:24 +00:00
limit: Option<std::num::NonZeroU32>,
2022-01-05 20:02:46 +00:00
page_token: Option<&'a str>,
2023-02-01 05:28:12 +00:00
sort_by: Option<types::IdSortMode>,
) -> Result<ResponseValue<types::UserResultsPage>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!("{}/users", self.baseurl,);
let mut query = Vec::with_capacity(3usize);
2021-12-10 02:15:24 +00:00
if let Some(v) = &limit {
2023-10-16 18:44:24 +00:00
query.push(("limit", v.to_string()));
2021-12-10 02:15:24 +00:00
}
if let Some(v) = &page_token {
2023-10-16 18:44:24 +00:00
query.push(("page_token", v.to_string()));
2021-12-10 02:15:24 +00:00
}
if let Some(v) = &sort_by {
2023-10-16 18:44:24 +00:00
query.push(("sort_by", v.to_string()));
2021-12-10 02:15:24 +00:00
}
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.get(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
2023-10-16 18:44:24 +00:00
.query(&query)
2023-04-25 00:42:22 +00:00
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
200u16 => ResponseValue::from_response(response).await,
2022-02-08 16:59:38 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-02-08 16:59:38 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-02-08 16:59:38 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2022-02-08 16:59:38 +00:00
}
2021-12-10 02:15:24 +00:00
}
2023-02-01 05:28:12 +00:00
///List users as a Stream
2022-07-03 02:09:38 +00:00
///
2023-02-01 05:28:12 +00:00
///Sends repeated `GET` requests to `/users` until there are no more
/// results.
2022-07-03 02:09:38 +00:00
///
///Arguments:
/// - `limit`: Maximum number of items returned by a single call
/// - `sort_by`
2023-02-01 05:28:12 +00:00
pub fn user_list_stream<'a>(
2022-01-05 20:02:46 +00:00
&'a self,
limit: Option<std::num::NonZeroU32>,
2023-02-01 05:28:12 +00:00
sort_by: Option<types::IdSortMode>,
) -> impl futures::Stream<Item = Result<types::User, Error<types::Error>>> + Unpin + '_ {
2022-01-05 20:02:46 +00:00
use futures::StreamExt;
use futures::TryFutureExt;
use futures::TryStreamExt;
2023-05-04 03:53:28 +00:00
let final_stream_limit = limit
.clone()
.and_then(|x| std::num::NonZeroUsize::try_from(x).ok())
.map(std::num::NonZeroUsize::get)
.unwrap_or(usize::MAX);
2023-02-01 05:28:12 +00:00
self.user_list(limit, None, sort_by)
.map_ok(move |page| {
let page = page.into_inner();
2023-05-08 03:43:45 +00:00
let first = futures::stream::iter(page.items).map(Ok);
2023-02-01 05:28:12 +00:00
let rest = futures::stream::try_unfold(page.next_page, move |state| async move {
if state.is_none() {
Ok(None)
} else {
self.user_list(None, state.as_deref(), None)
.map_ok(|page| {
let page = page.into_inner();
2023-05-08 03:43:45 +00:00
Some((futures::stream::iter(page.items).map(Ok), page.next_page))
2023-02-01 05:28:12 +00:00
})
.await
}
})
.try_flatten();
first.chain(rest)
2022-01-05 20:02:46 +00:00
})
2023-02-01 05:28:12 +00:00
.try_flatten_stream()
2023-05-04 03:53:28 +00:00
.take(final_stream_limit)
2023-02-01 05:28:12 +00:00
.boxed()
2022-01-05 20:02:46 +00:00
}
2023-02-01 05:28:12 +00:00
///List disks
2022-07-03 02:09:38 +00:00
///
2023-02-01 05:28:12 +00:00
///Sends a `GET` request to `/v1/disks`
///
///Arguments:
/// - `limit`: Maximum number of items returned by a single call
/// - `organization`
/// - `page_token`: Token returned by previous call to retrieve the
/// subsequent page
/// - `project`
/// - `sort_by`
pub async fn disk_list_v1<'a>(
2022-01-05 20:02:46 +00:00
&'a self,
2023-02-01 05:28:12 +00:00
limit: Option<std::num::NonZeroU32>,
organization: Option<&'a types::NameOrId>,
page_token: Option<&'a str>,
project: Option<&'a types::NameOrId>,
sort_by: Option<types::NameOrIdSortMode>,
) -> Result<ResponseValue<types::DiskResultsPage>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!("{}/v1/disks", self.baseurl,);
let mut query = Vec::with_capacity(5usize);
2023-02-01 05:28:12 +00:00
if let Some(v) = &limit {
2023-10-16 18:44:24 +00:00
query.push(("limit", v.to_string()));
2023-02-01 05:28:12 +00:00
}
if let Some(v) = &organization {
2023-10-16 18:44:24 +00:00
query.push(("organization", v.to_string()));
2023-02-01 05:28:12 +00:00
}
if let Some(v) = &page_token {
2023-10-16 18:44:24 +00:00
query.push(("page_token", v.to_string()));
2023-02-01 05:28:12 +00:00
}
if let Some(v) = &project {
2023-10-16 18:44:24 +00:00
query.push(("project", v.to_string()));
2023-02-01 05:28:12 +00:00
}
if let Some(v) = &sort_by {
2023-10-16 18:44:24 +00:00
query.push(("sort_by", v.to_string()));
2023-02-01 05:28:12 +00:00
}
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.get(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
2023-10-16 18:44:24 +00:00
.query(&query)
2023-04-25 00:42:22 +00:00
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
200u16 => ResponseValue::from_response(response).await,
2022-02-08 16:59:38 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-02-08 16:59:38 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-02-08 16:59:38 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2022-02-08 16:59:38 +00:00
}
2021-12-10 02:15:24 +00:00
}
2023-02-01 05:28:12 +00:00
///List disks as a Stream
2022-07-03 02:09:38 +00:00
///
2023-02-01 05:28:12 +00:00
///Sends repeated `GET` requests to `/v1/disks` until there are no more
/// results.
///
///Arguments:
/// - `limit`: Maximum number of items returned by a single call
/// - `organization`
/// - `project`
/// - `sort_by`
pub fn disk_list_v1_stream<'a>(
2022-01-05 20:02:46 +00:00
&'a self,
2023-02-01 05:28:12 +00:00
limit: Option<std::num::NonZeroU32>,
organization: Option<&'a types::NameOrId>,
project: Option<&'a types::NameOrId>,
sort_by: Option<types::NameOrIdSortMode>,
) -> impl futures::Stream<Item = Result<types::Disk, Error<types::Error>>> + Unpin + '_ {
use futures::StreamExt;
use futures::TryFutureExt;
use futures::TryStreamExt;
2023-05-04 03:53:28 +00:00
let final_stream_limit = limit
.clone()
.and_then(|x| std::num::NonZeroUsize::try_from(x).ok())
.map(std::num::NonZeroUsize::get)
.unwrap_or(usize::MAX);
2023-02-01 05:28:12 +00:00
self.disk_list_v1(limit, organization, None, project, sort_by)
.map_ok(move |page| {
let page = page.into_inner();
2023-05-08 03:43:45 +00:00
let first = futures::stream::iter(page.items).map(Ok);
2023-02-01 05:28:12 +00:00
let rest = futures::stream::try_unfold(page.next_page, move |state| async move {
if state.is_none() {
Ok(None)
} else {
self.disk_list_v1(None, None, state.as_deref(), None, None)
.map_ok(|page| {
let page = page.into_inner();
2023-05-08 03:43:45 +00:00
Some((futures::stream::iter(page.items).map(Ok), page.next_page))
2023-02-01 05:28:12 +00:00
})
.await
}
})
.try_flatten();
first.chain(rest)
})
.try_flatten_stream()
2023-05-04 03:53:28 +00:00
.take(final_stream_limit)
2023-02-01 05:28:12 +00:00
.boxed()
}
///Create a disk
///
///Sends a `POST` request to `/v1/disks`
pub async fn disk_create_v1<'a>(
&'a self,
organization: Option<&'a types::NameOrId>,
project: &'a types::NameOrId,
body: &'a types::DiskCreate,
) -> Result<ResponseValue<types::Disk>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!("{}/v1/disks", self.baseurl,);
let mut query = Vec::with_capacity(2usize);
2023-02-01 05:28:12 +00:00
if let Some(v) = &organization {
2023-10-16 18:44:24 +00:00
query.push(("organization", v.to_string()));
2023-02-01 05:28:12 +00:00
}
2023-10-16 18:44:24 +00:00
query.push(("project", project.to_string()));
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.post(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
.json(&body)
2023-10-16 18:44:24 +00:00
.query(&query)
2023-04-25 00:42:22 +00:00
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
201u16 => ResponseValue::from_response(response).await,
2022-02-08 16:59:38 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-02-08 16:59:38 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-02-08 16:59:38 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2022-02-08 16:59:38 +00:00
}
2021-12-10 02:15:24 +00:00
}
2023-02-01 05:28:12 +00:00
///Fetch a disk
2022-07-03 02:09:38 +00:00
///
2023-02-01 05:28:12 +00:00
///Sends a `GET` request to `/v1/disks/{disk}`
pub async fn disk_view_v1<'a>(
2022-01-05 20:02:46 +00:00
&'a self,
2023-02-01 05:28:12 +00:00
disk: &'a types::NameOrId,
organization: Option<&'a types::NameOrId>,
project: Option<&'a types::NameOrId>,
) -> Result<ResponseValue<types::Disk>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!(
2023-02-01 05:28:12 +00:00
"{}/v1/disks/{}",
2021-12-10 02:15:24 +00:00
self.baseurl,
2023-02-01 05:28:12 +00:00
encode_path(&disk.to_string()),
2021-12-10 02:15:24 +00:00
);
2023-10-16 18:44:24 +00:00
let mut query = Vec::with_capacity(2usize);
2023-02-01 05:28:12 +00:00
if let Some(v) = &organization {
2023-10-16 18:44:24 +00:00
query.push(("organization", v.to_string()));
2023-02-01 05:28:12 +00:00
}
if let Some(v) = &project {
2023-10-16 18:44:24 +00:00
query.push(("project", v.to_string()));
2023-02-01 05:28:12 +00:00
}
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.get(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
2023-10-16 18:44:24 +00:00
.query(&query)
2023-04-25 00:42:22 +00:00
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
200u16 => ResponseValue::from_response(response).await,
2022-02-08 16:59:38 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-02-08 16:59:38 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-02-08 16:59:38 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2022-02-08 16:59:38 +00:00
}
2021-12-10 02:15:24 +00:00
}
2023-02-01 05:28:12 +00:00
///Delete a disk
2022-07-03 02:09:38 +00:00
///
2023-02-01 05:28:12 +00:00
///Sends a `DELETE` request to `/v1/disks/{disk}`
pub async fn disk_delete_v1<'a>(
2022-01-05 20:02:46 +00:00
&'a self,
2023-02-01 05:28:12 +00:00
disk: &'a types::NameOrId,
organization: Option<&'a types::NameOrId>,
project: Option<&'a types::NameOrId>,
2022-02-08 16:59:38 +00:00
) -> Result<ResponseValue<()>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!(
2023-02-01 05:28:12 +00:00
"{}/v1/disks/{}",
2021-12-10 02:15:24 +00:00
self.baseurl,
2023-02-01 05:28:12 +00:00
encode_path(&disk.to_string()),
2021-12-10 02:15:24 +00:00
);
2023-10-16 18:44:24 +00:00
let mut query = Vec::with_capacity(2usize);
2023-02-01 05:28:12 +00:00
if let Some(v) = &organization {
2023-10-16 18:44:24 +00:00
query.push(("organization", v.to_string()));
2023-02-01 05:28:12 +00:00
}
if let Some(v) = &project {
2023-10-16 18:44:24 +00:00
query.push(("project", v.to_string()));
2023-02-01 05:28:12 +00:00
}
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.delete(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
2023-10-16 18:44:24 +00:00
.query(&query)
2023-04-25 00:42:22 +00:00
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
204u16 => Ok(ResponseValue::empty(response)),
2022-02-08 16:59:38 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-02-08 16:59:38 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-02-08 16:59:38 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2022-02-08 16:59:38 +00:00
}
2022-01-05 20:02:46 +00:00
}
2023-02-01 05:28:12 +00:00
///List instances
2022-07-03 02:09:38 +00:00
///
2023-02-01 05:28:12 +00:00
///Sends a `GET` request to `/v1/instances`
2022-07-03 02:09:38 +00:00
///
///Arguments:
/// - `limit`: Maximum number of items returned by a single call
2023-02-01 05:28:12 +00:00
/// - `organization`
2022-07-08 01:35:36 +00:00
/// - `page_token`: Token returned by previous call to retrieve the
2022-07-03 02:09:38 +00:00
/// subsequent page
2023-02-01 05:28:12 +00:00
/// - `project`
2022-07-03 02:09:38 +00:00
/// - `sort_by`
2023-02-01 05:28:12 +00:00
pub async fn instance_list_v1<'a>(
2022-01-05 20:02:46 +00:00
&'a self,
limit: Option<std::num::NonZeroU32>,
2023-02-01 05:28:12 +00:00
organization: Option<&'a types::NameOrId>,
2022-01-05 20:02:46 +00:00
page_token: Option<&'a str>,
2023-02-01 05:28:12 +00:00
project: Option<&'a types::NameOrId>,
sort_by: Option<types::NameOrIdSortMode>,
) -> Result<ResponseValue<types::InstanceResultsPage>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!("{}/v1/instances", self.baseurl,);
let mut query = Vec::with_capacity(5usize);
2022-01-05 20:02:46 +00:00
if let Some(v) = &limit {
2023-10-16 18:44:24 +00:00
query.push(("limit", v.to_string()));
2022-01-05 20:02:46 +00:00
}
2023-02-01 05:28:12 +00:00
if let Some(v) = &organization {
2023-10-16 18:44:24 +00:00
query.push(("organization", v.to_string()));
2023-02-01 05:28:12 +00:00
}
2022-01-05 20:02:46 +00:00
if let Some(v) = &page_token {
2023-10-16 18:44:24 +00:00
query.push(("page_token", v.to_string()));
2022-01-05 20:02:46 +00:00
}
2023-02-01 05:28:12 +00:00
if let Some(v) = &project {
2023-10-16 18:44:24 +00:00
query.push(("project", v.to_string()));
2023-02-01 05:28:12 +00:00
}
2022-01-05 20:02:46 +00:00
if let Some(v) = &sort_by {
2023-10-16 18:44:24 +00:00
query.push(("sort_by", v.to_string()));
2022-01-05 20:02:46 +00:00
}
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.get(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
2023-10-16 18:44:24 +00:00
.query(&query)
2023-04-25 00:42:22 +00:00
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
200u16 => ResponseValue::from_response(response).await,
2022-02-08 16:59:38 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-02-08 16:59:38 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-02-08 16:59:38 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2022-02-08 16:59:38 +00:00
}
2022-01-05 20:02:46 +00:00
}
2023-02-01 05:28:12 +00:00
///List instances as a Stream
2022-07-03 02:09:38 +00:00
///
2023-02-01 05:28:12 +00:00
///Sends repeated `GET` requests to `/v1/instances` until there are no more
/// results.
2022-07-03 02:09:38 +00:00
///
///Arguments:
/// - `limit`: Maximum number of items returned by a single call
2023-02-01 05:28:12 +00:00
/// - `organization`
/// - `project`
2022-07-03 02:09:38 +00:00
/// - `sort_by`
2023-02-01 05:28:12 +00:00
pub fn instance_list_v1_stream<'a>(
2022-01-05 20:02:46 +00:00
&'a self,
limit: Option<std::num::NonZeroU32>,
2023-02-01 05:28:12 +00:00
organization: Option<&'a types::NameOrId>,
project: Option<&'a types::NameOrId>,
sort_by: Option<types::NameOrIdSortMode>,
) -> impl futures::Stream<Item = Result<types::Instance, Error<types::Error>>> + Unpin + '_
2022-02-08 16:59:38 +00:00
{
2022-01-05 20:02:46 +00:00
use futures::StreamExt;
use futures::TryFutureExt;
use futures::TryStreamExt;
2023-05-04 03:53:28 +00:00
let final_stream_limit = limit
.clone()
.and_then(|x| std::num::NonZeroUsize::try_from(x).ok())
.map(std::num::NonZeroUsize::get)
.unwrap_or(usize::MAX);
2023-02-01 05:28:12 +00:00
self.instance_list_v1(limit, organization, None, project, sort_by)
.map_ok(move |page| {
let page = page.into_inner();
2023-05-08 03:43:45 +00:00
let first = futures::stream::iter(page.items).map(Ok);
2023-02-01 05:28:12 +00:00
let rest = futures::stream::try_unfold(page.next_page, move |state| async move {
if state.is_none() {
Ok(None)
} else {
self.instance_list_v1(None, None, state.as_deref(), None, None)
.map_ok(|page| {
let page = page.into_inner();
2023-05-08 03:43:45 +00:00
Some((futures::stream::iter(page.items).map(Ok), page.next_page))
2023-02-01 05:28:12 +00:00
})
.await
}
})
.try_flatten();
first.chain(rest)
2022-01-05 20:02:46 +00:00
})
2023-02-01 05:28:12 +00:00
.try_flatten_stream()
2023-05-04 03:53:28 +00:00
.take(final_stream_limit)
2023-02-01 05:28:12 +00:00
.boxed()
2022-01-05 20:02:46 +00:00
}
2023-02-01 05:28:12 +00:00
///Create an instance
2022-07-03 02:09:38 +00:00
///
2023-02-01 05:28:12 +00:00
///Sends a `POST` request to `/v1/instances`
pub async fn instance_create_v1<'a>(
2022-05-23 15:49:37 +00:00
&'a self,
2023-02-01 05:28:12 +00:00
organization: Option<&'a types::NameOrId>,
project: &'a types::NameOrId,
body: &'a types::InstanceCreate,
) -> Result<ResponseValue<types::Instance>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!("{}/v1/instances", self.baseurl,);
let mut query = Vec::with_capacity(2usize);
2023-02-01 05:28:12 +00:00
if let Some(v) = &organization {
2023-10-16 18:44:24 +00:00
query.push(("organization", v.to_string()));
2023-02-01 05:28:12 +00:00
}
2023-10-16 18:44:24 +00:00
query.push(("project", project.to_string()));
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.post(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
.json(&body)
2023-10-16 18:44:24 +00:00
.query(&query)
2023-04-25 00:42:22 +00:00
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
201u16 => ResponseValue::from_response(response).await,
2023-02-01 05:28:12 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2023-02-01 05:28:12 +00:00
}
}
///Fetch an instance
///
///Sends a `GET` request to `/v1/instances/{instance}`
pub async fn instance_view_v1<'a>(
&'a self,
instance: &'a types::NameOrId,
organization: Option<&'a types::NameOrId>,
project: Option<&'a types::NameOrId>,
) -> Result<ResponseValue<types::Instance>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!(
2023-02-01 05:28:12 +00:00
"{}/v1/instances/{}",
self.baseurl,
encode_path(&instance.to_string()),
);
2023-10-16 18:44:24 +00:00
let mut query = Vec::with_capacity(2usize);
2023-02-01 05:28:12 +00:00
if let Some(v) = &organization {
2023-10-16 18:44:24 +00:00
query.push(("organization", v.to_string()));
2023-02-01 05:28:12 +00:00
}
if let Some(v) = &project {
2023-10-16 18:44:24 +00:00
query.push(("project", v.to_string()));
2023-02-01 05:28:12 +00:00
}
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.get(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
2023-10-16 18:44:24 +00:00
.query(&query)
2023-04-25 00:42:22 +00:00
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
200u16 => ResponseValue::from_response(response).await,
2022-05-23 15:49:37 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-05-23 15:49:37 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-05-23 15:49:37 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2022-05-23 15:49:37 +00:00
}
}
2023-02-01 05:28:12 +00:00
///Delete an instance
2022-07-03 02:09:38 +00:00
///
2023-02-01 05:28:12 +00:00
///Sends a `DELETE` request to `/v1/instances/{instance}`
pub async fn instance_delete_v1<'a>(
2022-05-23 15:49:37 +00:00
&'a self,
2023-02-01 05:28:12 +00:00
instance: &'a types::NameOrId,
organization: Option<&'a types::NameOrId>,
project: Option<&'a types::NameOrId>,
) -> Result<ResponseValue<()>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!(
2023-02-01 05:28:12 +00:00
"{}/v1/instances/{}",
self.baseurl,
encode_path(&instance.to_string()),
);
2023-10-16 18:44:24 +00:00
let mut query = Vec::with_capacity(2usize);
2023-02-01 05:28:12 +00:00
if let Some(v) = &organization {
2023-10-16 18:44:24 +00:00
query.push(("organization", v.to_string()));
2023-02-01 05:28:12 +00:00
}
if let Some(v) = &project {
2023-10-16 18:44:24 +00:00
query.push(("project", v.to_string()));
2023-02-01 05:28:12 +00:00
}
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.delete(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
2023-10-16 18:44:24 +00:00
.query(&query)
2023-04-25 00:42:22 +00:00
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
204u16 => Ok(ResponseValue::empty(response)),
2022-05-23 15:49:37 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-05-23 15:49:37 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-05-23 15:49:37 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2022-05-23 15:49:37 +00:00
}
}
2023-02-01 05:28:12 +00:00
///List an instance's disks
2022-07-03 02:09:38 +00:00
///
2023-02-01 05:28:12 +00:00
///Sends a `GET` request to `/v1/instances/{instance}/disks`
2022-07-03 02:09:38 +00:00
///
///Arguments:
2023-02-01 05:28:12 +00:00
/// - `instance`
2022-07-03 02:09:38 +00:00
/// - `limit`: Maximum number of items returned by a single call
2023-02-01 05:28:12 +00:00
/// - `organization`
2022-07-08 01:35:36 +00:00
/// - `page_token`: Token returned by previous call to retrieve the
2022-07-03 02:09:38 +00:00
/// subsequent page
2023-02-01 05:28:12 +00:00
/// - `project`
/// - `sort_by`
pub async fn instance_disk_list_v1<'a>(
2022-01-05 20:02:46 +00:00
&'a self,
2023-02-01 05:28:12 +00:00
instance: &'a types::NameOrId,
2022-01-05 20:02:46 +00:00
limit: Option<std::num::NonZeroU32>,
2023-02-01 05:28:12 +00:00
organization: Option<&'a types::NameOrId>,
2022-01-05 20:02:46 +00:00
page_token: Option<&'a str>,
2023-02-01 05:28:12 +00:00
project: Option<&'a types::NameOrId>,
sort_by: Option<types::NameOrIdSortMode>,
) -> Result<ResponseValue<types::DiskResultsPage>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!(
2023-02-01 05:28:12 +00:00
"{}/v1/instances/{}/disks",
self.baseurl,
encode_path(&instance.to_string()),
);
2023-10-16 18:44:24 +00:00
let mut query = Vec::with_capacity(5usize);
2022-01-05 20:02:46 +00:00
if let Some(v) = &limit {
2023-10-16 18:44:24 +00:00
query.push(("limit", v.to_string()));
2022-01-05 20:02:46 +00:00
}
2023-02-01 05:28:12 +00:00
if let Some(v) = &organization {
2023-10-16 18:44:24 +00:00
query.push(("organization", v.to_string()));
2023-02-01 05:28:12 +00:00
}
2022-01-05 20:02:46 +00:00
if let Some(v) = &page_token {
2023-10-16 18:44:24 +00:00
query.push(("page_token", v.to_string()));
2022-01-05 20:02:46 +00:00
}
2023-02-01 05:28:12 +00:00
if let Some(v) = &project {
2023-10-16 18:44:24 +00:00
query.push(("project", v.to_string()));
2023-02-01 05:28:12 +00:00
}
if let Some(v) = &sort_by {
2023-10-16 18:44:24 +00:00
query.push(("sort_by", v.to_string()));
2023-02-01 05:28:12 +00:00
}
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.get(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
2023-10-16 18:44:24 +00:00
.query(&query)
2023-04-25 00:42:22 +00:00
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
200u16 => ResponseValue::from_response(response).await,
2022-02-08 16:59:38 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-02-08 16:59:38 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-02-08 16:59:38 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2022-02-08 16:59:38 +00:00
}
2022-01-05 20:02:46 +00:00
}
2023-02-01 05:28:12 +00:00
///List an instance's disks as a Stream
2022-07-03 02:09:38 +00:00
///
2023-02-01 05:28:12 +00:00
///Sends repeated `GET` requests to `/v1/instances/{instance}/disks` until
/// there are no more results.
2022-07-03 02:09:38 +00:00
///
///Arguments:
2023-02-01 05:28:12 +00:00
/// - `instance`
2022-07-03 02:09:38 +00:00
/// - `limit`: Maximum number of items returned by a single call
2023-02-01 05:28:12 +00:00
/// - `organization`
/// - `project`
/// - `sort_by`
pub fn instance_disk_list_v1_stream<'a>(
2022-01-05 20:02:46 +00:00
&'a self,
2023-02-01 05:28:12 +00:00
instance: &'a types::NameOrId,
2022-01-05 20:02:46 +00:00
limit: Option<std::num::NonZeroU32>,
2023-02-01 05:28:12 +00:00
organization: Option<&'a types::NameOrId>,
project: Option<&'a types::NameOrId>,
sort_by: Option<types::NameOrIdSortMode>,
) -> impl futures::Stream<Item = Result<types::Disk, Error<types::Error>>> + Unpin + '_ {
2022-01-05 20:02:46 +00:00
use futures::StreamExt;
use futures::TryFutureExt;
use futures::TryStreamExt;
2023-05-04 03:53:28 +00:00
let final_stream_limit = limit
.clone()
.and_then(|x| std::num::NonZeroUsize::try_from(x).ok())
.map(std::num::NonZeroUsize::get)
.unwrap_or(usize::MAX);
2023-02-01 05:28:12 +00:00
self.instance_disk_list_v1(instance, limit, organization, None, project, sort_by)
2022-01-05 20:02:46 +00:00
.map_ok(move |page| {
2022-02-08 16:59:38 +00:00
let page = page.into_inner();
2023-05-08 03:43:45 +00:00
let first = futures::stream::iter(page.items).map(Ok);
2022-01-05 20:02:46 +00:00
let rest = futures::stream::try_unfold(page.next_page, move |state| async move {
if state.is_none() {
Ok(None)
} else {
2023-02-01 05:28:12 +00:00
self.instance_disk_list_v1(
instance,
None,
None,
state.as_deref(),
None,
None,
)
.map_ok(|page| {
let page = page.into_inner();
2023-05-08 03:43:45 +00:00
Some((futures::stream::iter(page.items).map(Ok), page.next_page))
2023-02-01 05:28:12 +00:00
})
.await
2022-01-05 20:02:46 +00:00
}
})
.try_flatten();
first.chain(rest)
})
.try_flatten_stream()
2023-05-04 03:53:28 +00:00
.take(final_stream_limit)
2022-01-05 20:02:46 +00:00
.boxed()
}
2023-02-01 05:28:12 +00:00
///Attach a disk to an instance
2022-07-03 02:09:38 +00:00
///
2023-02-01 05:28:12 +00:00
///Sends a `POST` request to `/v1/instances/{instance}/disks/attach`
pub async fn instance_disk_attach_v1<'a>(
&'a self,
instance: &'a types::NameOrId,
organization: Option<&'a types::NameOrId>,
project: Option<&'a types::NameOrId>,
body: &'a types::DiskPath,
) -> Result<ResponseValue<types::Disk>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!(
2023-02-01 05:28:12 +00:00
"{}/v1/instances/{}/disks/attach",
self.baseurl,
encode_path(&instance.to_string()),
);
2023-10-16 18:44:24 +00:00
let mut query = Vec::with_capacity(2usize);
2023-02-01 05:28:12 +00:00
if let Some(v) = &organization {
2023-10-16 18:44:24 +00:00
query.push(("organization", v.to_string()));
2023-02-01 05:28:12 +00:00
}
if let Some(v) = &project {
2023-10-16 18:44:24 +00:00
query.push(("project", v.to_string()));
2023-02-01 05:28:12 +00:00
}
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.post(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
.json(&body)
2023-10-16 18:44:24 +00:00
.query(&query)
2023-04-25 00:42:22 +00:00
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
202u16 => ResponseValue::from_response(response).await,
2023-02-01 05:28:12 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2023-02-01 05:28:12 +00:00
}
}
///Detach a disk from an instance
2022-07-03 02:09:38 +00:00
///
2023-02-01 05:28:12 +00:00
///Sends a `POST` request to `/v1/instances/{instance}/disks/detach`
pub async fn instance_disk_detach_v1<'a>(
2022-02-08 16:59:38 +00:00
&'a self,
2023-02-01 05:28:12 +00:00
instance: &'a types::NameOrId,
organization: Option<&'a types::NameOrId>,
project: Option<&'a types::NameOrId>,
body: &'a types::DiskPath,
) -> Result<ResponseValue<types::Disk>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!(
2023-02-01 05:28:12 +00:00
"{}/v1/instances/{}/disks/detach",
2022-01-05 20:02:46 +00:00
self.baseurl,
2023-02-01 05:28:12 +00:00
encode_path(&instance.to_string()),
2022-01-05 20:02:46 +00:00
);
2023-10-16 18:44:24 +00:00
let mut query = Vec::with_capacity(2usize);
2023-02-01 05:28:12 +00:00
if let Some(v) = &organization {
2023-10-16 18:44:24 +00:00
query.push(("organization", v.to_string()));
2023-02-01 05:28:12 +00:00
}
if let Some(v) = &project {
2023-10-16 18:44:24 +00:00
query.push(("project", v.to_string()));
2023-02-01 05:28:12 +00:00
}
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.post(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
.json(&body)
2023-10-16 18:44:24 +00:00
.query(&query)
2023-04-25 00:42:22 +00:00
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
202u16 => ResponseValue::from_response(response).await,
2023-02-01 05:28:12 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2023-02-01 05:28:12 +00:00
}
}
///Migrate an instance
///
///Sends a `POST` request to `/v1/instances/{instance}/migrate`
pub async fn instance_migrate_v1<'a>(
&'a self,
instance: &'a types::NameOrId,
organization: Option<&'a types::NameOrId>,
project: Option<&'a types::NameOrId>,
body: &'a types::InstanceMigrate,
) -> Result<ResponseValue<types::Instance>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!(
2023-02-01 05:28:12 +00:00
"{}/v1/instances/{}/migrate",
self.baseurl,
encode_path(&instance.to_string()),
);
2023-10-16 18:44:24 +00:00
let mut query = Vec::with_capacity(2usize);
2023-02-01 05:28:12 +00:00
if let Some(v) = &organization {
2023-10-16 18:44:24 +00:00
query.push(("organization", v.to_string()));
2023-02-01 05:28:12 +00:00
}
if let Some(v) = &project {
2023-10-16 18:44:24 +00:00
query.push(("project", v.to_string()));
2023-02-01 05:28:12 +00:00
}
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.post(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
.json(&body)
2023-10-16 18:44:24 +00:00
.query(&query)
2023-04-25 00:42:22 +00:00
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
200u16 => ResponseValue::from_response(response).await,
2022-02-08 16:59:38 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-02-08 16:59:38 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-02-08 16:59:38 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2022-02-08 16:59:38 +00:00
}
2021-12-10 02:15:24 +00:00
}
2023-02-01 05:28:12 +00:00
///Reboot an instance
///
///Sends a `POST` request to `/v1/instances/{instance}/reboot`
pub async fn instance_reboot_v1<'a>(
&'a self,
instance: &'a types::NameOrId,
organization: Option<&'a types::NameOrId>,
project: Option<&'a types::NameOrId>,
) -> Result<ResponseValue<types::Instance>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!(
2023-02-01 05:28:12 +00:00
"{}/v1/instances/{}/reboot",
self.baseurl,
encode_path(&instance.to_string()),
);
2023-10-16 18:44:24 +00:00
let mut query = Vec::with_capacity(2usize);
2023-02-01 05:28:12 +00:00
if let Some(v) = &organization {
2023-10-16 18:44:24 +00:00
query.push(("organization", v.to_string()));
2023-02-01 05:28:12 +00:00
}
if let Some(v) = &project {
2023-10-16 18:44:24 +00:00
query.push(("project", v.to_string()));
2023-02-01 05:28:12 +00:00
}
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.post(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
2023-10-16 18:44:24 +00:00
.query(&query)
2023-04-25 00:42:22 +00:00
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
202u16 => ResponseValue::from_response(response).await,
2023-02-01 05:28:12 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2023-02-01 05:28:12 +00:00
}
}
///Fetch an instance's serial console
2022-07-03 02:09:38 +00:00
///
2023-02-01 05:28:12 +00:00
///Sends a `GET` request to `/v1/instances/{instance}/serial-console`
2022-07-03 02:09:38 +00:00
///
///Arguments:
2023-02-01 05:28:12 +00:00
/// - `instance`
/// - `from_start`: Character index in the serial buffer from which to read,
/// counting the bytes output since instance start. If this is not
/// provided, `most_recent` must be provided, and if this *is* provided,
/// `most_recent` must *not* be provided.
/// - `max_bytes`: Maximum number of bytes of buffered serial console
/// contents to return. If the requested range runs to the end of the
/// available buffer, the data returned will be shorter than `max_bytes`.
/// - `most_recent`: Character index in the serial buffer from which to
/// read, counting *backward* from the most recently buffered data
/// retrieved from the instance. (See note on `from_start` about mutual
/// exclusivity)
/// - `organization`
/// - `project`
pub async fn instance_serial_console_v1<'a>(
2022-01-05 20:02:46 +00:00
&'a self,
2023-02-01 05:28:12 +00:00
instance: &'a types::NameOrId,
from_start: Option<u64>,
max_bytes: Option<u64>,
most_recent: Option<u64>,
organization: Option<&'a types::NameOrId>,
project: Option<&'a types::NameOrId>,
) -> Result<ResponseValue<types::InstanceSerialConsoleData>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!(
2023-02-01 05:28:12 +00:00
"{}/v1/instances/{}/serial-console",
self.baseurl,
encode_path(&instance.to_string()),
);
2023-10-16 18:44:24 +00:00
let mut query = Vec::with_capacity(5usize);
2023-02-01 05:28:12 +00:00
if let Some(v) = &from_start {
2023-10-16 18:44:24 +00:00
query.push(("from_start", v.to_string()));
2021-12-10 02:15:24 +00:00
}
2023-02-01 05:28:12 +00:00
if let Some(v) = &max_bytes {
2023-10-16 18:44:24 +00:00
query.push(("max_bytes", v.to_string()));
2021-12-10 02:15:24 +00:00
}
2023-02-01 05:28:12 +00:00
if let Some(v) = &most_recent {
2023-10-16 18:44:24 +00:00
query.push(("most_recent", v.to_string()));
2023-02-01 05:28:12 +00:00
}
if let Some(v) = &organization {
2023-10-16 18:44:24 +00:00
query.push(("organization", v.to_string()));
2023-02-01 05:28:12 +00:00
}
if let Some(v) = &project {
2023-10-16 18:44:24 +00:00
query.push(("project", v.to_string()));
2021-12-10 02:15:24 +00:00
}
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.get(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
2023-10-16 18:44:24 +00:00
.query(&query)
2023-04-25 00:42:22 +00:00
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
200u16 => ResponseValue::from_response(response).await,
2022-02-08 16:59:38 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-02-08 16:59:38 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-02-08 16:59:38 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2022-02-08 16:59:38 +00:00
}
2021-12-10 02:15:24 +00:00
}
2023-02-01 05:28:12 +00:00
///Stream an instance's serial console
2022-07-03 02:09:38 +00:00
///
2023-02-01 05:28:12 +00:00
///Sends a `GET` request to
/// `/v1/instances/{instance}/serial-console/stream`
pub async fn instance_serial_console_stream_v1<'a>(
2022-01-05 20:02:46 +00:00
&'a self,
2023-02-01 05:28:12 +00:00
instance: &'a types::NameOrId,
organization: Option<&'a types::NameOrId>,
project: Option<&'a types::NameOrId>,
) -> Result<ResponseValue<reqwest::Upgraded>, Error<reqwest::Upgraded>> {
2023-10-16 18:44:24 +00:00
let url = format!(
2023-02-01 05:28:12 +00:00
"{}/v1/instances/{}/serial-console/stream",
self.baseurl,
encode_path(&instance.to_string()),
);
2023-10-16 18:44:24 +00:00
let mut query = Vec::with_capacity(2usize);
2023-02-01 05:28:12 +00:00
if let Some(v) = &organization {
2023-10-16 18:44:24 +00:00
query.push(("organization", v.to_string()));
2023-02-01 05:28:12 +00:00
}
if let Some(v) = &project {
2023-10-16 18:44:24 +00:00
query.push(("project", v.to_string()));
2023-02-01 05:28:12 +00:00
}
2023-10-16 18:44:24 +00:00
let request = self
2023-02-01 05:28:12 +00:00
.client
2023-10-16 18:44:24 +00:00
.get(url)
.query(&query)
2023-02-01 05:28:12 +00:00
.header(reqwest::header::CONNECTION, "Upgrade")
.header(reqwest::header::UPGRADE, "websocket")
.header(reqwest::header::SEC_WEBSOCKET_VERSION, "13")
.header(
reqwest::header::SEC_WEBSOCKET_KEY,
base64::Engine::encode(
&base64::engine::general_purpose::STANDARD,
rand::random::<[u8; 16]>(),
),
)
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
101u16 => ResponseValue::upgrade(response).await,
200..=299 => ResponseValue::upgrade(response).await,
_ => Err(Error::UnexpectedResponse(response)),
2023-02-01 05:28:12 +00:00
}
2022-01-05 20:02:46 +00:00
}
2023-02-01 05:28:12 +00:00
///Boot an instance
2022-07-03 02:09:38 +00:00
///
2023-02-01 05:28:12 +00:00
///Sends a `POST` request to `/v1/instances/{instance}/start`
pub async fn instance_start_v1<'a>(
2022-02-08 16:59:38 +00:00
&'a self,
2023-02-01 05:28:12 +00:00
instance: &'a types::NameOrId,
organization: Option<&'a types::NameOrId>,
project: Option<&'a types::NameOrId>,
) -> Result<ResponseValue<types::Instance>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!(
2023-02-01 05:28:12 +00:00
"{}/v1/instances/{}/start",
2021-12-10 02:15:24 +00:00
self.baseurl,
2023-02-01 05:28:12 +00:00
encode_path(&instance.to_string()),
2021-12-10 02:15:24 +00:00
);
2023-10-16 18:44:24 +00:00
let mut query = Vec::with_capacity(2usize);
2023-02-01 05:28:12 +00:00
if let Some(v) = &organization {
2023-10-16 18:44:24 +00:00
query.push(("organization", v.to_string()));
2023-02-01 05:28:12 +00:00
}
if let Some(v) = &project {
2023-10-16 18:44:24 +00:00
query.push(("project", v.to_string()));
2023-02-01 05:28:12 +00:00
}
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.post(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
2023-10-16 18:44:24 +00:00
.query(&query)
2023-04-25 00:42:22 +00:00
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
202u16 => ResponseValue::from_response(response).await,
2022-02-08 16:59:38 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-02-08 16:59:38 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-02-08 16:59:38 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2022-02-08 16:59:38 +00:00
}
}
2023-02-01 05:28:12 +00:00
///Stop an instance
2022-07-03 02:09:38 +00:00
///
2023-02-01 05:28:12 +00:00
///Sends a `POST` request to `/v1/instances/{instance}/stop`
pub async fn instance_stop_v1<'a>(
2022-02-08 16:59:38 +00:00
&'a self,
2023-02-01 05:28:12 +00:00
instance: &'a types::NameOrId,
organization: Option<&'a types::NameOrId>,
project: Option<&'a types::NameOrId>,
) -> Result<ResponseValue<types::Instance>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!(
2023-02-01 05:28:12 +00:00
"{}/v1/instances/{}/stop",
self.baseurl,
encode_path(&instance.to_string()),
);
2023-10-16 18:44:24 +00:00
let mut query = Vec::with_capacity(2usize);
2023-02-01 05:28:12 +00:00
if let Some(v) = &organization {
2023-10-16 18:44:24 +00:00
query.push(("organization", v.to_string()));
2023-02-01 05:28:12 +00:00
}
if let Some(v) = &project {
2023-10-16 18:44:24 +00:00
query.push(("project", v.to_string()));
2023-02-01 05:28:12 +00:00
}
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.post(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
2023-10-16 18:44:24 +00:00
.query(&query)
2023-04-25 00:42:22 +00:00
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
202u16 => ResponseValue::from_response(response).await,
2022-07-08 01:35:36 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-07-08 01:35:36 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-07-08 01:35:36 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2022-07-08 01:35:36 +00:00
}
}
2023-02-01 05:28:12 +00:00
///List organizations
2022-07-08 01:35:36 +00:00
///
2023-02-01 05:28:12 +00:00
///Sends a `GET` request to `/v1/organizations`
2022-07-08 01:35:36 +00:00
///
///Arguments:
/// - `limit`: Maximum number of items returned by a single call
/// - `page_token`: Token returned by previous call to retrieve the
/// subsequent page
/// - `sort_by`
2023-02-01 05:28:12 +00:00
pub async fn organization_list_v1<'a>(
2022-07-08 01:35:36 +00:00
&'a self,
limit: Option<std::num::NonZeroU32>,
page_token: Option<&'a str>,
2023-02-01 05:28:12 +00:00
sort_by: Option<types::NameOrIdSortMode>,
) -> Result<ResponseValue<types::OrganizationResultsPage>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!("{}/v1/organizations", self.baseurl,);
let mut query = Vec::with_capacity(3usize);
2022-07-08 01:35:36 +00:00
if let Some(v) = &limit {
2023-10-16 18:44:24 +00:00
query.push(("limit", v.to_string()));
2022-07-08 01:35:36 +00:00
}
if let Some(v) = &page_token {
2023-10-16 18:44:24 +00:00
query.push(("page_token", v.to_string()));
2022-07-08 01:35:36 +00:00
}
if let Some(v) = &sort_by {
2023-10-16 18:44:24 +00:00
query.push(("sort_by", v.to_string()));
2022-07-08 01:35:36 +00:00
}
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.get(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
2023-10-16 18:44:24 +00:00
.query(&query)
2023-04-25 00:42:22 +00:00
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
200u16 => ResponseValue::from_response(response).await,
2022-07-08 01:35:36 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-07-08 01:35:36 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-07-08 01:35:36 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2022-07-08 01:35:36 +00:00
}
}
2023-02-01 05:28:12 +00:00
///List organizations as a Stream
2022-07-08 01:35:36 +00:00
///
2023-02-01 05:28:12 +00:00
///Sends repeated `GET` requests to `/v1/organizations` until there are no
/// more results.
2022-07-08 01:35:36 +00:00
///
///Arguments:
/// - `limit`: Maximum number of items returned by a single call
/// - `sort_by`
2023-02-01 05:28:12 +00:00
pub fn organization_list_v1_stream<'a>(
2022-07-08 01:35:36 +00:00
&'a self,
limit: Option<std::num::NonZeroU32>,
2023-02-01 05:28:12 +00:00
sort_by: Option<types::NameOrIdSortMode>,
) -> impl futures::Stream<Item = Result<types::Organization, Error<types::Error>>> + Unpin + '_
{
2022-07-08 01:35:36 +00:00
use futures::StreamExt;
use futures::TryFutureExt;
use futures::TryStreamExt;
2023-05-04 03:53:28 +00:00
let final_stream_limit = limit
.clone()
.and_then(|x| std::num::NonZeroUsize::try_from(x).ok())
.map(std::num::NonZeroUsize::get)
.unwrap_or(usize::MAX);
2023-02-01 05:28:12 +00:00
self.organization_list_v1(limit, None, sort_by)
2022-07-08 01:35:36 +00:00
.map_ok(move |page| {
let page = page.into_inner();
2023-05-08 03:43:45 +00:00
let first = futures::stream::iter(page.items).map(Ok);
2022-07-08 01:35:36 +00:00
let rest = futures::stream::try_unfold(page.next_page, move |state| async move {
if state.is_none() {
Ok(None)
} else {
2023-02-01 05:28:12 +00:00
self.organization_list_v1(None, state.as_deref(), None)
2022-07-08 01:35:36 +00:00
.map_ok(|page| {
let page = page.into_inner();
2023-05-08 03:43:45 +00:00
Some((futures::stream::iter(page.items).map(Ok), page.next_page))
2022-07-08 01:35:36 +00:00
})
.await
}
})
.try_flatten();
first.chain(rest)
})
.try_flatten_stream()
2023-05-04 03:53:28 +00:00
.take(final_stream_limit)
2022-07-08 01:35:36 +00:00
.boxed()
}
2023-02-01 05:28:12 +00:00
///Create an organization
2022-07-08 01:35:36 +00:00
///
2023-02-01 05:28:12 +00:00
///Sends a `POST` request to `/v1/organizations`
pub async fn organization_create_v1<'a>(
2022-07-08 01:35:36 +00:00
&'a self,
2023-02-01 05:28:12 +00:00
body: &'a types::OrganizationCreate,
) -> Result<ResponseValue<types::Organization>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!("{}/v1/organizations", self.baseurl,);
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.post(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
.json(&body)
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
201u16 => ResponseValue::from_response(response).await,
2022-07-08 01:35:36 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-07-08 01:35:36 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-07-08 01:35:36 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2022-07-08 01:35:36 +00:00
}
}
2023-02-01 05:28:12 +00:00
///Fetch an organization
2022-07-08 01:35:36 +00:00
///
2023-02-01 05:28:12 +00:00
///Sends a `GET` request to `/v1/organizations/{organization}`
pub async fn organization_view_v1<'a>(
2022-07-08 01:35:36 +00:00
&'a self,
2023-02-01 05:28:12 +00:00
organization: &'a types::NameOrId,
) -> Result<ResponseValue<types::Organization>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!(
2023-02-01 05:28:12 +00:00
"{}/v1/organizations/{}",
2022-07-08 01:35:36 +00:00
self.baseurl,
2023-02-01 05:28:12 +00:00
encode_path(&organization.to_string()),
2022-07-08 01:35:36 +00:00
);
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.get(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
200u16 => ResponseValue::from_response(response).await,
2022-07-08 01:35:36 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-07-08 01:35:36 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-07-08 01:35:36 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2022-07-08 01:35:36 +00:00
}
}
2023-02-01 05:28:12 +00:00
///Update an organization
2022-07-08 01:35:36 +00:00
///
2023-02-01 05:28:12 +00:00
///Sends a `PUT` request to `/v1/organizations/{organization}`
pub async fn organization_update_v1<'a>(
2022-07-08 01:35:36 +00:00
&'a self,
2023-02-01 05:28:12 +00:00
organization: &'a types::NameOrId,
body: &'a types::OrganizationUpdate,
) -> Result<ResponseValue<types::Organization>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!(
2023-02-01 05:28:12 +00:00
"{}/v1/organizations/{}",
2022-07-08 01:35:36 +00:00
self.baseurl,
2023-02-01 05:28:12 +00:00
encode_path(&organization.to_string()),
2022-07-08 01:35:36 +00:00
);
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.put(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
.json(&body)
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
200u16 => ResponseValue::from_response(response).await,
2022-05-23 15:49:37 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-05-23 15:49:37 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-05-23 15:49:37 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2022-05-23 15:49:37 +00:00
}
}
2023-02-01 05:28:12 +00:00
///Delete an organization
2022-07-03 02:09:38 +00:00
///
2023-02-01 05:28:12 +00:00
///Sends a `DELETE` request to `/v1/organizations/{organization}`
pub async fn organization_delete_v1<'a>(
2022-05-23 15:49:37 +00:00
&'a self,
2023-02-01 05:28:12 +00:00
organization: &'a types::NameOrId,
) -> Result<ResponseValue<()>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!(
2023-02-01 05:28:12 +00:00
"{}/v1/organizations/{}",
self.baseurl,
encode_path(&organization.to_string()),
);
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.delete(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
204u16 => Ok(ResponseValue::empty(response)),
2022-05-23 15:49:37 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-05-23 15:49:37 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-05-23 15:49:37 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2022-05-23 15:49:37 +00:00
}
}
2023-02-01 05:28:12 +00:00
///Fetch an organization's IAM policy
2022-07-03 02:09:38 +00:00
///
2023-02-01 05:28:12 +00:00
///Sends a `GET` request to `/v1/organizations/{organization}/policy`
pub async fn organization_policy_view_v1<'a>(
2022-05-23 15:49:37 +00:00
&'a self,
2023-02-01 05:28:12 +00:00
organization: &'a types::NameOrId,
) -> Result<ResponseValue<types::OrganizationRolePolicy>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!(
2023-02-01 05:28:12 +00:00
"{}/v1/organizations/{}/policy",
2022-05-23 15:49:37 +00:00
self.baseurl,
2023-02-01 05:28:12 +00:00
encode_path(&organization.to_string()),
2022-05-23 15:49:37 +00:00
);
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.get(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
200u16 => ResponseValue::from_response(response).await,
2022-05-23 15:49:37 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-05-23 15:49:37 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-05-23 15:49:37 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2022-05-23 15:49:37 +00:00
}
}
2023-02-01 05:28:12 +00:00
///Update an organization's IAM policy
2022-07-03 02:09:38 +00:00
///
2023-02-01 05:28:12 +00:00
///Sends a `PUT` request to `/v1/organizations/{organization}/policy`
pub async fn organization_policy_update_v1<'a>(
2022-05-23 15:49:37 +00:00
&'a self,
2023-02-01 05:28:12 +00:00
organization: &'a types::NameOrId,
body: &'a types::OrganizationRolePolicy,
) -> Result<ResponseValue<types::OrganizationRolePolicy>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!(
2023-02-01 05:28:12 +00:00
"{}/v1/organizations/{}/policy",
2022-05-23 15:49:37 +00:00
self.baseurl,
2023-02-01 05:28:12 +00:00
encode_path(&organization.to_string()),
2022-05-23 15:49:37 +00:00
);
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.put(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
.json(&body)
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
200u16 => ResponseValue::from_response(response).await,
2022-05-23 15:49:37 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-05-23 15:49:37 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-05-23 15:49:37 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2022-05-23 15:49:37 +00:00
}
}
2023-02-01 05:28:12 +00:00
///List projects
2022-07-08 01:35:36 +00:00
///
2023-02-01 05:28:12 +00:00
///Sends a `GET` request to `/v1/projects`
2022-07-03 02:09:38 +00:00
///
///Arguments:
/// - `limit`: Maximum number of items returned by a single call
2023-02-01 05:28:12 +00:00
/// - `organization`
2022-07-08 01:35:36 +00:00
/// - `page_token`: Token returned by previous call to retrieve the
2022-07-03 02:09:38 +00:00
/// subsequent page
/// - `sort_by`
2023-02-01 05:28:12 +00:00
pub async fn project_list_v1<'a>(
2022-05-23 15:49:37 +00:00
&'a self,
limit: Option<std::num::NonZeroU32>,
2023-02-01 05:28:12 +00:00
organization: Option<&'a types::NameOrId>,
2022-05-23 15:49:37 +00:00
page_token: Option<&'a str>,
2023-02-01 05:28:12 +00:00
sort_by: Option<types::NameOrIdSortMode>,
) -> Result<ResponseValue<types::ProjectResultsPage>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!("{}/v1/projects", self.baseurl,);
let mut query = Vec::with_capacity(4usize);
2022-05-23 15:49:37 +00:00
if let Some(v) = &limit {
2023-10-16 18:44:24 +00:00
query.push(("limit", v.to_string()));
2022-05-23 15:49:37 +00:00
}
2023-02-01 05:28:12 +00:00
if let Some(v) = &organization {
2023-10-16 18:44:24 +00:00
query.push(("organization", v.to_string()));
2023-02-01 05:28:12 +00:00
}
2022-05-23 15:49:37 +00:00
if let Some(v) = &page_token {
2023-10-16 18:44:24 +00:00
query.push(("page_token", v.to_string()));
2022-05-23 15:49:37 +00:00
}
if let Some(v) = &sort_by {
2023-10-16 18:44:24 +00:00
query.push(("sort_by", v.to_string()));
2022-05-23 15:49:37 +00:00
}
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.get(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
2023-10-16 18:44:24 +00:00
.query(&query)
2023-04-25 00:42:22 +00:00
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
200u16 => ResponseValue::from_response(response).await,
2022-05-23 15:49:37 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-05-23 15:49:37 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-05-23 15:49:37 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2022-05-23 15:49:37 +00:00
}
}
2023-02-01 05:28:12 +00:00
///List projects as a Stream
2022-07-08 01:35:36 +00:00
///
2023-02-01 05:28:12 +00:00
///Sends repeated `GET` requests to `/v1/projects` until there are no more
/// results.
2022-07-03 02:09:38 +00:00
///
///Arguments:
/// - `limit`: Maximum number of items returned by a single call
2023-02-01 05:28:12 +00:00
/// - `organization`
2022-07-03 02:09:38 +00:00
/// - `sort_by`
2023-02-01 05:28:12 +00:00
pub fn project_list_v1_stream<'a>(
2022-05-23 15:49:37 +00:00
&'a self,
limit: Option<std::num::NonZeroU32>,
2023-02-01 05:28:12 +00:00
organization: Option<&'a types::NameOrId>,
sort_by: Option<types::NameOrIdSortMode>,
) -> impl futures::Stream<Item = Result<types::Project, Error<types::Error>>> + Unpin + '_ {
2022-05-23 15:49:37 +00:00
use futures::StreamExt;
use futures::TryFutureExt;
use futures::TryStreamExt;
2023-05-04 03:53:28 +00:00
let final_stream_limit = limit
.clone()
.and_then(|x| std::num::NonZeroUsize::try_from(x).ok())
.map(std::num::NonZeroUsize::get)
.unwrap_or(usize::MAX);
2023-02-01 05:28:12 +00:00
self.project_list_v1(limit, organization, None, sort_by)
2022-05-23 15:49:37 +00:00
.map_ok(move |page| {
let page = page.into_inner();
2023-05-08 03:43:45 +00:00
let first = futures::stream::iter(page.items).map(Ok);
2022-05-23 15:49:37 +00:00
let rest = futures::stream::try_unfold(page.next_page, move |state| async move {
if state.is_none() {
Ok(None)
} else {
2023-02-01 05:28:12 +00:00
self.project_list_v1(None, None, state.as_deref(), None)
2022-05-23 15:49:37 +00:00
.map_ok(|page| {
let page = page.into_inner();
2023-05-08 03:43:45 +00:00
Some((futures::stream::iter(page.items).map(Ok), page.next_page))
2022-05-23 15:49:37 +00:00
})
.await
}
})
.try_flatten();
first.chain(rest)
})
.try_flatten_stream()
2023-05-04 03:53:28 +00:00
.take(final_stream_limit)
2022-05-23 15:49:37 +00:00
.boxed()
}
2023-02-01 05:28:12 +00:00
///Create a project
///
///Sends a `POST` request to `/v1/projects`
pub async fn project_create_v1<'a>(
&'a self,
organization: &'a types::NameOrId,
body: &'a types::ProjectCreate,
) -> Result<ResponseValue<types::Project>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!("{}/v1/projects", self.baseurl,);
let mut query = Vec::with_capacity(1usize);
query.push(("organization", organization.to_string()));
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.post(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
.json(&body)
2023-10-16 18:44:24 +00:00
.query(&query)
2023-04-25 00:42:22 +00:00
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
201u16 => ResponseValue::from_response(response).await,
2023-02-01 05:28:12 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2023-02-01 05:28:12 +00:00
}
}
///Fetch a project
///
///Sends a `GET` request to `/v1/projects/{project}`
pub async fn project_view_v1<'a>(
&'a self,
project: &'a types::NameOrId,
organization: Option<&'a types::NameOrId>,
) -> Result<ResponseValue<types::Project>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!(
2023-02-01 05:28:12 +00:00
"{}/v1/projects/{}",
self.baseurl,
encode_path(&project.to_string()),
);
2023-10-16 18:44:24 +00:00
let mut query = Vec::with_capacity(1usize);
2023-02-01 05:28:12 +00:00
if let Some(v) = &organization {
2023-10-16 18:44:24 +00:00
query.push(("organization", v.to_string()));
2023-02-01 05:28:12 +00:00
}
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.get(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
2023-10-16 18:44:24 +00:00
.query(&query)
2023-04-25 00:42:22 +00:00
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
200u16 => ResponseValue::from_response(response).await,
2023-02-01 05:28:12 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2023-02-01 05:28:12 +00:00
}
}
///Update a project
2022-07-08 01:35:36 +00:00
///
2023-02-01 05:28:12 +00:00
///Sends a `PUT` request to `/v1/projects/{project}`
pub async fn project_update_v1<'a>(
2022-05-23 15:49:37 +00:00
&'a self,
2023-02-01 05:28:12 +00:00
project: &'a types::NameOrId,
organization: Option<&'a types::NameOrId>,
body: &'a types::ProjectUpdate,
) -> Result<ResponseValue<types::Project>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!(
2023-02-01 05:28:12 +00:00
"{}/v1/projects/{}",
2022-07-08 01:35:36 +00:00
self.baseurl,
2023-02-01 05:28:12 +00:00
encode_path(&project.to_string()),
2022-07-08 01:35:36 +00:00
);
2023-10-16 18:44:24 +00:00
let mut query = Vec::with_capacity(1usize);
2023-02-01 05:28:12 +00:00
if let Some(v) = &organization {
2023-10-16 18:44:24 +00:00
query.push(("organization", v.to_string()));
2023-02-01 05:28:12 +00:00
}
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.put(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
.json(&body)
2023-10-16 18:44:24 +00:00
.query(&query)
2023-04-25 00:42:22 +00:00
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
200u16 => ResponseValue::from_response(response).await,
2022-05-23 15:49:37 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-05-23 15:49:37 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-05-23 15:49:37 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2022-05-23 15:49:37 +00:00
}
}
2023-02-01 05:28:12 +00:00
///Delete a project
2022-07-03 02:09:38 +00:00
///
2023-02-01 05:28:12 +00:00
///Sends a `DELETE` request to `/v1/projects/{project}`
pub async fn project_delete_v1<'a>(
2022-05-23 15:49:37 +00:00
&'a self,
2023-02-01 05:28:12 +00:00
project: &'a types::NameOrId,
organization: Option<&'a types::NameOrId>,
) -> Result<ResponseValue<()>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!(
2023-02-01 05:28:12 +00:00
"{}/v1/projects/{}",
2022-05-23 15:49:37 +00:00
self.baseurl,
2023-02-01 05:28:12 +00:00
encode_path(&project.to_string()),
2022-05-23 15:49:37 +00:00
);
2023-10-16 18:44:24 +00:00
let mut query = Vec::with_capacity(1usize);
2023-02-01 05:28:12 +00:00
if let Some(v) = &organization {
2023-10-16 18:44:24 +00:00
query.push(("organization", v.to_string()));
2023-02-01 05:28:12 +00:00
}
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.delete(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
2023-10-16 18:44:24 +00:00
.query(&query)
2023-04-25 00:42:22 +00:00
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
204u16 => Ok(ResponseValue::empty(response)),
2022-05-23 15:49:37 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-05-23 15:49:37 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-05-23 15:49:37 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2022-05-23 15:49:37 +00:00
}
}
2023-02-01 05:28:12 +00:00
///Fetch a project's IAM policy
2022-07-03 02:09:38 +00:00
///
2023-02-01 05:28:12 +00:00
///Sends a `GET` request to `/v1/projects/{project}/policy`
pub async fn project_policy_view_v1<'a>(
2022-05-23 15:49:37 +00:00
&'a self,
2023-02-01 05:28:12 +00:00
project: &'a types::NameOrId,
organization: Option<&'a types::NameOrId>,
) -> Result<ResponseValue<types::ProjectRolePolicy>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!(
2023-02-01 05:28:12 +00:00
"{}/v1/projects/{}/policy",
2022-05-23 15:49:37 +00:00
self.baseurl,
2023-02-01 05:28:12 +00:00
encode_path(&project.to_string()),
2022-05-23 15:49:37 +00:00
);
2023-10-16 18:44:24 +00:00
let mut query = Vec::with_capacity(1usize);
2023-02-01 05:28:12 +00:00
if let Some(v) = &organization {
2023-10-16 18:44:24 +00:00
query.push(("organization", v.to_string()));
2023-02-01 05:28:12 +00:00
}
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.get(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
2023-10-16 18:44:24 +00:00
.query(&query)
2023-04-25 00:42:22 +00:00
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
200u16 => ResponseValue::from_response(response).await,
2022-05-23 15:49:37 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-05-23 15:49:37 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-05-23 15:49:37 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2022-05-23 15:49:37 +00:00
}
}
2023-02-01 05:28:12 +00:00
///Update a project's IAM policy
2022-07-03 02:09:38 +00:00
///
2023-02-01 05:28:12 +00:00
///Sends a `PUT` request to `/v1/projects/{project}/policy`
pub async fn project_policy_update_v1<'a>(
2022-05-23 15:49:37 +00:00
&'a self,
2023-02-01 05:28:12 +00:00
project: &'a types::NameOrId,
organization: Option<&'a types::NameOrId>,
body: &'a types::ProjectRolePolicy,
) -> Result<ResponseValue<types::ProjectRolePolicy>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!(
2023-02-01 05:28:12 +00:00
"{}/v1/projects/{}/policy",
2022-05-23 15:49:37 +00:00
self.baseurl,
2023-02-01 05:28:12 +00:00
encode_path(&project.to_string()),
2022-05-23 15:49:37 +00:00
);
2023-10-16 18:44:24 +00:00
let mut query = Vec::with_capacity(1usize);
2023-02-01 05:28:12 +00:00
if let Some(v) = &organization {
2023-10-16 18:44:24 +00:00
query.push(("organization", v.to_string()));
2023-02-01 05:28:12 +00:00
}
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.put(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
.json(&body)
2023-10-16 18:44:24 +00:00
.query(&query)
2023-04-25 00:42:22 +00:00
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
200u16 => ResponseValue::from_response(response).await,
2022-05-23 15:49:37 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-05-23 15:49:37 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-05-23 15:49:37 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2022-05-23 15:49:37 +00:00
}
}
2023-02-01 05:28:12 +00:00
///View version and update status of component tree
2022-07-03 02:09:38 +00:00
///
2023-02-01 05:28:12 +00:00
///Sends a `GET` request to `/v1/system/update/components`
2022-07-03 02:09:38 +00:00
///
///Arguments:
2022-07-08 01:35:36 +00:00
/// - `limit`: Maximum number of items returned by a single call
/// - `page_token`: Token returned by previous call to retrieve the
/// subsequent page
/// - `sort_by`
2023-02-01 05:28:12 +00:00
pub async fn system_component_version_list<'a>(
2022-05-23 15:49:37 +00:00
&'a self,
2022-07-08 01:35:36 +00:00
limit: Option<std::num::NonZeroU32>,
page_token: Option<&'a str>,
2023-02-01 05:28:12 +00:00
sort_by: Option<types::IdSortMode>,
) -> Result<ResponseValue<types::UpdateableComponentResultsPage>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!("{}/v1/system/update/components", self.baseurl,);
let mut query = Vec::with_capacity(3usize);
2022-07-08 01:35:36 +00:00
if let Some(v) = &limit {
2023-10-16 18:44:24 +00:00
query.push(("limit", v.to_string()));
2022-07-08 01:35:36 +00:00
}
if let Some(v) = &page_token {
2023-10-16 18:44:24 +00:00
query.push(("page_token", v.to_string()));
2022-07-08 01:35:36 +00:00
}
if let Some(v) = &sort_by {
2023-10-16 18:44:24 +00:00
query.push(("sort_by", v.to_string()));
2022-07-08 01:35:36 +00:00
}
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.get(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
2023-10-16 18:44:24 +00:00
.query(&query)
2023-04-25 00:42:22 +00:00
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
200u16 => ResponseValue::from_response(response).await,
2022-07-08 01:35:36 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-07-08 01:35:36 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-07-08 01:35:36 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2022-07-08 01:35:36 +00:00
}
}
2023-02-01 05:28:12 +00:00
///View version and update status of component tree as a Stream
2022-07-08 01:35:36 +00:00
///
2023-02-01 05:28:12 +00:00
///Sends repeated `GET` requests to `/v1/system/update/components` until
/// there are no more results.
2022-07-08 01:35:36 +00:00
///
///Arguments:
/// - `limit`: Maximum number of items returned by a single call
/// - `sort_by`
2023-02-01 05:28:12 +00:00
pub fn system_component_version_list_stream<'a>(
2022-07-08 01:35:36 +00:00
&'a self,
limit: Option<std::num::NonZeroU32>,
2023-02-01 05:28:12 +00:00
sort_by: Option<types::IdSortMode>,
) -> impl futures::Stream<Item = Result<types::UpdateableComponent, Error<types::Error>>> + Unpin + '_
2022-07-08 01:35:36 +00:00
{
use futures::StreamExt;
use futures::TryFutureExt;
use futures::TryStreamExt;
2023-05-04 03:53:28 +00:00
let final_stream_limit = limit
.clone()
.and_then(|x| std::num::NonZeroUsize::try_from(x).ok())
.map(std::num::NonZeroUsize::get)
.unwrap_or(usize::MAX);
2023-02-01 05:28:12 +00:00
self.system_component_version_list(limit, None, sort_by)
2022-07-08 01:35:36 +00:00
.map_ok(move |page| {
let page = page.into_inner();
2023-05-08 03:43:45 +00:00
let first = futures::stream::iter(page.items).map(Ok);
2022-07-08 01:35:36 +00:00
let rest = futures::stream::try_unfold(page.next_page, move |state| async move {
if state.is_none() {
Ok(None)
} else {
2023-02-01 05:28:12 +00:00
self.system_component_version_list(None, state.as_deref(), None)
2022-07-08 01:35:36 +00:00
.map_ok(|page| {
let page = page.into_inner();
2023-05-08 03:43:45 +00:00
Some((futures::stream::iter(page.items).map(Ok), page.next_page))
2022-07-08 01:35:36 +00:00
})
.await
}
})
.try_flatten();
first.chain(rest)
})
.try_flatten_stream()
2023-05-04 03:53:28 +00:00
.take(final_stream_limit)
2022-07-08 01:35:36 +00:00
.boxed()
}
2023-02-01 05:28:12 +00:00
///List all update deployments
2022-07-03 02:09:38 +00:00
///
2023-02-01 05:28:12 +00:00
///Sends a `GET` request to `/v1/system/update/deployments`
2022-07-03 02:09:38 +00:00
///
///Arguments:
/// - `limit`: Maximum number of items returned by a single call
2022-07-08 01:35:36 +00:00
/// - `page_token`: Token returned by previous call to retrieve the
2022-07-03 02:09:38 +00:00
/// subsequent page
2023-02-01 05:28:12 +00:00
/// - `sort_by`
pub async fn update_deployments_list<'a>(
2022-01-05 20:02:46 +00:00
&'a self,
limit: Option<std::num::NonZeroU32>,
page_token: Option<&'a str>,
2023-02-01 05:28:12 +00:00
sort_by: Option<types::IdSortMode>,
) -> Result<ResponseValue<types::UpdateDeploymentResultsPage>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!("{}/v1/system/update/deployments", self.baseurl,);
let mut query = Vec::with_capacity(3usize);
2022-01-05 20:02:46 +00:00
if let Some(v) = &limit {
2023-10-16 18:44:24 +00:00
query.push(("limit", v.to_string()));
2022-01-05 20:02:46 +00:00
}
if let Some(v) = &page_token {
2023-10-16 18:44:24 +00:00
query.push(("page_token", v.to_string()));
2022-01-05 20:02:46 +00:00
}
2023-02-01 05:28:12 +00:00
if let Some(v) = &sort_by {
2023-10-16 18:44:24 +00:00
query.push(("sort_by", v.to_string()));
2023-02-01 05:28:12 +00:00
}
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.get(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
2023-10-16 18:44:24 +00:00
.query(&query)
2023-04-25 00:42:22 +00:00
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
200u16 => ResponseValue::from_response(response).await,
2022-02-08 16:59:38 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-02-08 16:59:38 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-02-08 16:59:38 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2022-02-08 16:59:38 +00:00
}
2022-01-05 20:02:46 +00:00
}
2023-02-01 05:28:12 +00:00
///List all update deployments as a Stream
2022-07-03 02:09:38 +00:00
///
2023-02-01 05:28:12 +00:00
///Sends repeated `GET` requests to `/v1/system/update/deployments` until
/// there are no more results.
2022-07-03 02:09:38 +00:00
///
///Arguments:
/// - `limit`: Maximum number of items returned by a single call
2023-02-01 05:28:12 +00:00
/// - `sort_by`
pub fn update_deployments_list_stream<'a>(
2022-01-05 20:02:46 +00:00
&'a self,
limit: Option<std::num::NonZeroU32>,
2023-02-01 05:28:12 +00:00
sort_by: Option<types::IdSortMode>,
) -> impl futures::Stream<Item = Result<types::UpdateDeployment, Error<types::Error>>> + Unpin + '_
2022-02-08 16:59:38 +00:00
{
2022-01-05 20:02:46 +00:00
use futures::StreamExt;
use futures::TryFutureExt;
use futures::TryStreamExt;
2023-05-04 03:53:28 +00:00
let final_stream_limit = limit
.clone()
.and_then(|x| std::num::NonZeroUsize::try_from(x).ok())
.map(std::num::NonZeroUsize::get)
.unwrap_or(usize::MAX);
2023-02-01 05:28:12 +00:00
self.update_deployments_list(limit, None, sort_by)
2022-01-05 20:02:46 +00:00
.map_ok(move |page| {
2022-02-08 16:59:38 +00:00
let page = page.into_inner();
2023-05-08 03:43:45 +00:00
let first = futures::stream::iter(page.items).map(Ok);
2022-01-05 20:02:46 +00:00
let rest = futures::stream::try_unfold(page.next_page, move |state| async move {
if state.is_none() {
Ok(None)
} else {
2023-02-01 05:28:12 +00:00
self.update_deployments_list(None, state.as_deref(), None)
2022-01-05 20:02:46 +00:00
.map_ok(|page| {
2022-02-08 16:59:38 +00:00
let page = page.into_inner();
2023-05-08 03:43:45 +00:00
Some((futures::stream::iter(page.items).map(Ok), page.next_page))
2022-01-05 20:02:46 +00:00
})
.await
}
})
.try_flatten();
first.chain(rest)
})
.try_flatten_stream()
2023-05-04 03:53:28 +00:00
.take(final_stream_limit)
2022-01-05 20:02:46 +00:00
.boxed()
}
2023-02-01 05:28:12 +00:00
///Fetch a system update deployment
///
///Sends a `GET` request to `/v1/system/update/deployments/{id}`
pub async fn update_deployment_view<'a>(
&'a self,
id: &'a uuid::Uuid,
) -> Result<ResponseValue<types::UpdateDeployment>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!(
2023-02-01 05:28:12 +00:00
"{}/v1/system/update/deployments/{}",
self.baseurl,
encode_path(&id.to_string()),
);
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.get(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
200u16 => ResponseValue::from_response(response).await,
2023-02-01 05:28:12 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2023-02-01 05:28:12 +00:00
}
}
///Refresh update data
2022-07-03 02:09:38 +00:00
///
2023-02-01 05:28:12 +00:00
///Sends a `POST` request to `/v1/system/update/refresh`
pub async fn system_update_refresh<'a>(
&'a self,
) -> Result<ResponseValue<()>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!("{}/v1/system/update/refresh", self.baseurl,);
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.post(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
204u16 => Ok(ResponseValue::empty(response)),
2022-03-18 06:54:10 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-03-18 06:54:10 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-03-18 06:54:10 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2022-03-18 06:54:10 +00:00
}
}
2023-02-01 05:28:12 +00:00
///Start system update
2022-07-03 02:09:38 +00:00
///
2023-02-01 05:28:12 +00:00
///Sends a `POST` request to `/v1/system/update/start`
pub async fn system_update_start<'a>(
&'a self,
body: &'a types::SystemUpdateStart,
) -> Result<ResponseValue<types::UpdateDeployment>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!("{}/v1/system/update/start", self.baseurl,);
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.post(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
.json(&body)
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
202u16 => ResponseValue::from_response(response).await,
2023-02-01 05:28:12 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2023-02-01 05:28:12 +00:00
}
}
///Stop system update
///
///If there is no update in progress, do nothing.
///
///Sends a `POST` request to `/v1/system/update/stop`
pub async fn system_update_stop<'a>(
&'a self,
) -> Result<ResponseValue<()>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!("{}/v1/system/update/stop", self.baseurl,);
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.post(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
204u16 => Ok(ResponseValue::empty(response)),
2023-02-01 05:28:12 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2023-02-01 05:28:12 +00:00
}
}
///List all updates
///
///Sends a `GET` request to `/v1/system/update/updates`
2022-07-03 02:09:38 +00:00
///
///Arguments:
/// - `limit`: Maximum number of items returned by a single call
2022-07-08 01:35:36 +00:00
/// - `page_token`: Token returned by previous call to retrieve the
2022-07-03 02:09:38 +00:00
/// subsequent page
/// - `sort_by`
2023-02-01 05:28:12 +00:00
pub async fn system_update_list<'a>(
2022-01-05 20:02:46 +00:00
&'a self,
2021-12-10 02:15:24 +00:00
limit: Option<std::num::NonZeroU32>,
2022-01-05 20:02:46 +00:00
page_token: Option<&'a str>,
2022-07-08 01:35:36 +00:00
sort_by: Option<types::IdSortMode>,
2023-02-01 05:28:12 +00:00
) -> Result<ResponseValue<types::SystemUpdateResultsPage>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!("{}/v1/system/update/updates", self.baseurl,);
let mut query = Vec::with_capacity(3usize);
2021-12-10 02:15:24 +00:00
if let Some(v) = &limit {
2023-10-16 18:44:24 +00:00
query.push(("limit", v.to_string()));
2021-12-10 02:15:24 +00:00
}
if let Some(v) = &page_token {
2023-10-16 18:44:24 +00:00
query.push(("page_token", v.to_string()));
2021-12-10 02:15:24 +00:00
}
if let Some(v) = &sort_by {
2023-10-16 18:44:24 +00:00
query.push(("sort_by", v.to_string()));
2021-12-10 02:15:24 +00:00
}
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.get(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
2023-10-16 18:44:24 +00:00
.query(&query)
2023-04-25 00:42:22 +00:00
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
200u16 => ResponseValue::from_response(response).await,
2022-02-08 16:59:38 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-02-08 16:59:38 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2022-02-08 16:59:38 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2022-02-08 16:59:38 +00:00
}
2021-12-10 02:15:24 +00:00
}
2023-02-01 05:28:12 +00:00
///List all updates as a Stream
2022-07-03 02:09:38 +00:00
///
2023-02-01 05:28:12 +00:00
///Sends repeated `GET` requests to `/v1/system/update/updates` until there
/// are no more results.
2022-07-03 02:09:38 +00:00
///
///Arguments:
/// - `limit`: Maximum number of items returned by a single call
/// - `sort_by`
2023-02-01 05:28:12 +00:00
pub fn system_update_list_stream<'a>(
2022-01-05 20:02:46 +00:00
&'a self,
limit: Option<std::num::NonZeroU32>,
2022-07-08 01:35:36 +00:00
sort_by: Option<types::IdSortMode>,
2023-02-01 05:28:12 +00:00
) -> impl futures::Stream<Item = Result<types::SystemUpdate, Error<types::Error>>> + Unpin + '_
{
2022-01-05 20:02:46 +00:00
use futures::StreamExt;
use futures::TryFutureExt;
use futures::TryStreamExt;
2023-05-04 03:53:28 +00:00
let final_stream_limit = limit
.clone()
.and_then(|x| std::num::NonZeroUsize::try_from(x).ok())
.map(std::num::NonZeroUsize::get)
.unwrap_or(usize::MAX);
2023-02-01 05:28:12 +00:00
self.system_update_list(limit, None, sort_by)
2022-01-05 20:02:46 +00:00
.map_ok(move |page| {
2022-02-08 16:59:38 +00:00
let page = page.into_inner();
2023-05-08 03:43:45 +00:00
let first = futures::stream::iter(page.items).map(Ok);
2022-01-05 20:02:46 +00:00
let rest = futures::stream::try_unfold(page.next_page, move |state| async move {
if state.is_none() {
Ok(None)
} else {
2023-02-01 05:28:12 +00:00
self.system_update_list(None, state.as_deref(), None)
2022-01-05 20:02:46 +00:00
.map_ok(|page| {
2022-02-08 16:59:38 +00:00
let page = page.into_inner();
2023-05-08 03:43:45 +00:00
Some((futures::stream::iter(page.items).map(Ok), page.next_page))
2022-01-05 20:02:46 +00:00
})
.await
}
})
.try_flatten();
first.chain(rest)
})
.try_flatten_stream()
2023-05-04 03:53:28 +00:00
.take(final_stream_limit)
2022-01-05 20:02:46 +00:00
.boxed()
}
2023-02-01 05:28:12 +00:00
///View system update
///
///Sends a `GET` request to `/v1/system/update/updates/{version}`
pub async fn system_update_view<'a>(
&'a self,
version: &'a types::SemverVersion,
) -> Result<ResponseValue<types::SystemUpdate>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!(
2023-02-01 05:28:12 +00:00
"{}/v1/system/update/updates/{}",
self.baseurl,
encode_path(&version.to_string()),
);
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.get(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
200u16 => ResponseValue::from_response(response).await,
2023-02-01 05:28:12 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2023-02-01 05:28:12 +00:00
}
}
///View system update component tree
///
///Sends a `GET` request to
/// `/v1/system/update/updates/{version}/components`
pub async fn system_update_components_list<'a>(
&'a self,
version: &'a types::SemverVersion,
) -> Result<ResponseValue<types::ComponentUpdateResultsPage>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!(
2023-02-01 05:28:12 +00:00
"{}/v1/system/update/updates/{}/components",
self.baseurl,
encode_path(&version.to_string()),
);
2023-10-16 18:44:24 +00:00
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.get(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
200u16 => ResponseValue::from_response(response).await,
2023-02-01 05:28:12 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2023-02-01 05:28:12 +00:00
}
}
///View system version and update status
///
///Sends a `GET` request to `/v1/system/update/version`
pub async fn system_version<'a>(
&'a self,
) -> Result<ResponseValue<types::SystemVersion>, Error<types::Error>> {
2023-10-16 18:44:24 +00:00
let url = format!("{}/v1/system/update/version", self.baseurl,);
let request = self
2023-04-25 00:42:22 +00:00
.client
2023-10-16 18:44:24 +00:00
.get(url)
2023-04-25 00:42:22 +00:00
.header(
reqwest::header::ACCEPT,
reqwest::header::HeaderValue::from_static("application/json"),
)
.build()?;
2023-10-16 18:44:24 +00:00
let result = self.client.execute(request).await;
let response = result?;
match response.status().as_u16() {
200u16 => ResponseValue::from_response(response).await,
2023-02-01 05:28:12 +00:00
400u16..=499u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
500u16..=599u16 => Err(Error::ErrorResponse(
2023-10-16 18:44:24 +00:00
ResponseValue::from_response(response).await?,
2023-02-01 05:28:12 +00:00
)),
2023-10-16 18:44:24 +00:00
_ => Err(Error::UnexpectedResponse(response)),
2023-02-01 05:28:12 +00:00
}
}
2021-12-10 02:15:24 +00:00
}
2022-08-27 15:23:02 +00:00
pub mod prelude {
pub use super::Client;
}
