Struct oxide_api::disks::Disks

pub struct Disks {
    pub client: Client,
}

Fields

client: Client

Implementations

impl Disks

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 in a project.

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

Parameters:

• limit: u32 – 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.

• page_token: &str – Token returned by previous call to retreive 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 – human-readable free-form text about a resource.
• project_name: &str – The project’s unique name within the organization.

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

List disks in a project.

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.

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

Create a disk in a project.

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

Parameters:

• organization_name: &str – human-readable free-form text about a resource.
• project_name: &str – The project’s unique name within the organization.

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

Fetch a single disk in a project.

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

Parameters:

• disk_name: &str – human-readable free-form text about a resource.
• organization_name: &str – human-readable free-form text about a resource.
• project_name: &str – human-readable free-form text about a resource.

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

Delete a disk from a project.

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

Parameters:

• disk_name: &str – human-readable free-form text about a resource.
• organization_name: &str – human-readable free-form text about a resource.
• project_name: &str – human-readable free-form text about a resource.