Struct oxide_api::disks::Disks

source · [−]

pub struct Disks {
    pub client: Client,
}

Fields

client: Client

Implementations

source

impl Disks

source

pub async fn view(&self, id: &str) -> Result<Disk>

Fetch a disk by id.

This function performs a GET to the /by-id/disks/{id} endpoint.

Parameters:

id: &str

source

pub async fn get_page(
 &self,
 limit: u32,
 organization_name: &str,
 page_token: &str,
 project_name: &str,
 sort_by: NameSortMode
) -> Result<Vec<Disk>>

List disks.

This function performs a GET to the /organizations/{organization_name}/projects/{project_name}/disks endpoint.

Parameters:

limit: u32 – Maximum number of items returned by a single call.
page_token: &str – Token returned by previous call to retrieve the subsequent page.
sort_by: crate::types::NameSortMode – Supported set of sort modes for scanning by name only

Currently, we only support scanning in ascending order.

organization_name: &str – 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.
project_name: &str – 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.

source

pub async fn get_all(
 &self,
 organization_name: &str,
 project_name: &str,
 sort_by: NameSortMode
) -> Result<Vec<Disk>>

List disks.

This function performs a GET to the /organizations/{organization_name}/projects/{project_name}/disks endpoint.

As opposed to get, this function returns all the pages of the request at once.

source

pub async fn post(
 &self,
 organization_name: &str,
 project_name: &str,
 body: &DiskCreate
) -> Result<Disk>

Create a disk.

This function performs a POST to the /organizations/{organization_name}/projects/{project_name}/disks endpoint.

Parameters:

organization_name: &str – 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.
project_name: &str – 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.

source

pub async fn get(
 &self,
 disk_name: &str,
 organization_name: &str,
 project_name: &str
) -> Result<Disk>

Fetch a disk.

This function performs a GET to the /organizations/{organization_name}/projects/{project_name}/disks/{disk_name} endpoint.

Parameters:

disk_name: &str – 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.
organization_name: &str – 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.
project_name: &str – 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.

source

pub async fn delete(
 &self,
 disk_name: &str,
 organization_name: &str,
 project_name: &str
) -> Result<()>

Delete a disk.

This function performs a DELETE to the /organizations/{organization_name}/projects/{project_name}/disks/{disk_name} endpoint.

Parameters:

disk_name: &str – 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.
organization_name: &str – 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.
project_name: &str – 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.

source

pub async fn metrics_list(
 &self,
 disk_name: &str,
 end_time: Option<DateTime<Utc>>,
 limit: u32,
 metric_name: &str,
 organization_name: &str,
 page_token: &str,
 project_name: &str,
 start_time: Option<DateTime<Utc>>
) -> Result<Vec<Measurement>>

Fetch disk metrics.

This function performs a GET to the /organizations/{organization_name}/projects/{project_name}/disks/{disk_name}/metrics/{metric_name} endpoint.

Parameters:

disk_name: &str – 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.
metric_name: crate::types::DiskMetricName
organization_name: &str – 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.
project_name: &str – 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.
end_time: chrono::DateTime<chrono::Utc> – An exclusive end time of metrics.
limit: u32 – Maximum number of items returned by a single call.
page_token: &str – Token returned by previous call to retrieve the subsequent page.
start_time: chrono::DateTime<chrono::Utc> – An inclusive start time of metrics.

source

pub async fn metrics_list_all(
 &self,
 disk_name: &str,
 end_time: Option<DateTime<Utc>>,
 metric_name: &str,
 organization_name: &str,
 project_name: &str,
 start_time: Option<DateTime<Utc>>
) -> Result<Vec<Measurement>>

Fetch disk metrics.

This function performs a GET to the /organizations/{organization_name}/projects/{project_name}/disks/{disk_name}/metrics/{metric_name} endpoint.

As opposed to metrics_list, this function returns all the pages of the request at once.

Auto Trait Implementations

impl !RefUnwindSafe for Disks

impl Send for Disks

impl Sync for Disks

impl Unpin for Disks

impl !UnwindSafe for Disks

Blanket Implementations

source

impl<T> Any for T where
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T> Instrument for T

source

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

source

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

impl<T> IntoResult<T> for T

type Err = Infallible

source

fn into_result(self) -> Result<T, <T as IntoResult<T>>::Err>

source

impl<T> Same<T> for T

type Output = T

Should always be Self

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

source

impl<T> WithSubscriber for T

source

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

source

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

Struct oxide_api::disks::Disks

Fields

Implementations

impl Disks

pub async fn view(&self, id: &str) -> Result<Disk>

pub async fn get_page( &self, limit: u32, organization_name: &str, page_token: &str, project_name: &str, sort_by: NameSortMode) -> Result<Vec<Disk>>

pub async fn get_all( &self, organization_name: &str, project_name: &str, sort_by: NameSortMode) -> Result<Vec<Disk>>

pub async fn post( &self, organization_name: &str, project_name: &str, body: &DiskCreate) -> Result<Disk>

pub async fn get( &self, disk_name: &str, organization_name: &str, project_name: &str) -> Result<Disk>

pub async fn delete( &self, disk_name: &str, organization_name: &str, project_name: &str) -> Result<()>

pub async fn metrics_list( &self, disk_name: &str, end_time: Option<DateTime<Utc>>, limit: u32, metric_name: &str, organization_name: &str, page_token: &str, project_name: &str, start_time: Option<DateTime<Utc>>) -> Result<Vec<Measurement>>

pub async fn metrics_list_all( &self, disk_name: &str, end_time: Option<DateTime<Utc>>, metric_name: &str, organization_name: &str, project_name: &str, start_time: Option<DateTime<Utc>>) -> Result<Vec<Measurement>>

Auto Trait Implementations

impl !RefUnwindSafe for Disks

impl Send for Disks

impl Sync for Disks

impl Unpin for Disks

impl !UnwindSafe for Disks

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

fn in_current_span(self) -> Instrumented<Self>

impl<T, U> Into<U> for T where U: From<T>,

fn into(self) -> U

impl<T> IntoResult<T> for T

type Err = Infallible

fn into_result(self) -> Result<T, <T as IntoResult<T>>::Err>

impl<T> Same<T> for T

type Output = T

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where S: Into<Dispatch>,

fn with_current_subscriber(self) -> WithDispatch<Self>

pub async fn get_page(
&self,
limit: u32,
organization_name: &str,
page_token: &str,
project_name: &str,
sort_by: NameSortMode
) -> Result<Vec<Disk>>

pub async fn get_all(
&self,
organization_name: &str,
project_name: &str,
sort_by: NameSortMode
) -> Result<Vec<Disk>>

pub async fn post(
&self,
organization_name: &str,
project_name: &str,
body: &DiskCreate
) -> Result<Disk>

pub async fn get(
&self,
disk_name: &str,
organization_name: &str,
project_name: &str
) -> Result<Disk>

pub async fn delete(
&self,
disk_name: &str,
organization_name: &str,
project_name: &str
) -> Result<()>

pub async fn metrics_list(
&self,
disk_name: &str,
end_time: Option<DateTime<Utc>>,
limit: u32,
metric_name: &str,
organization_name: &str,
page_token: &str,
project_name: &str,
start_time: Option<DateTime<Utc>>
) -> Result<Vec<Measurement>>

pub async fn metrics_list_all(
&self,
disk_name: &str,
end_time: Option<DateTime<Utc>>,
metric_name: &str,
organization_name: &str,
project_name: &str,
start_time: Option<DateTime<Utc>>
) -> Result<Vec<Measurement>>

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,