Struct Disks

pub struct Disks {
    pub client: Client,
}

Fields

client: Client

Implementations

impl Disks

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

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.

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.

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.

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.

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.

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.

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.