Struct oxide_api::projects::Projects

pub struct Projects {
    pub client: Client,
}

Fields

client: Client

Implementations

impl Projects

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

• This function performs a GET to the /organizations/{organization_name}/projects endpoint.
• List all projects.
• 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 – human-readable free-form text about a resource.
• • sort_by: crate::types::NameSortMode – Supported set of sort modes for scanning by name or id.
• • organization_name: &str – human-readable free-form text about a resource.

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

• This function performs a GET to the /organizations/{organization_name}/projects endpoint.
• As opposed to get, this function returns all the pages of the request at once.
• List all projects.

pub async fn post(
    &self,
    organization_name: &str,
    body: &ProjectCreate
) -> Result<Project>

• This function performs a POST to the /organizations/{organization_name}/projects endpoint.
• Create a new project.
• Parameters:
• • organization_name: &str – human-readable free-form text about a resource.

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

• This function performs a GET to the /organizations/{organization_name}/projects/{project_name} endpoint.
• Fetch a specific project
• Parameters:
• • 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,
    organization_name: &str,
    project_name: &str
) -> Result<()>

• This function performs a DELETE to the /organizations/{organization_name}/projects/{project_name} endpoint.
• Delete a specific project.
• Parameters:
• • 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 disks_get(
    &self,
    limit: u32,
    page_token: &str,
    sort_by: NameSortModeAscending,
    organization_name: &str,
    project_name: &str
) -> Result<Vec<Disk>>

• This function performs a GET to the /organizations/{organization_name}/projects/{project_name}/disks endpoint.
• List disks in a project.
• 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 – human-readable free-form text about a resource.
• • sort_by: crate::types::NameSortModeAscending – 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 – human-readable free-form text about a resource.

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

• This function performs a GET to the /organizations/{organization_name}/projects/{project_name}/disks endpoint.
• As opposed to disks_get, this function returns all the pages of the request at once.
• List disks in a project.

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

• This function performs a POST to the /organizations/{organization_name}/projects/{project_name}/disks endpoint.
• Create a disk in a project.
• • TODO-correctness See note about instance create. This should be async.
• Parameters:
• • 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 disks_get_disk(
    &self,
    disk_name: &str,
    organization_name: &str,
    project_name: &str
) -> Result<Disk>

• This function performs a GET to the /organizations/{organization_name}/projects/{project_name}/disks/{disk_name} endpoint.
• Fetch a single disk in a project.
• 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 disks_delete_disk(
    &self,
    disk_name: &str,
    organization_name: &str,
    project_name: &str
) -> Result<()>

• This function performs a DELETE to the /organizations/{organization_name}/projects/{project_name}/disks/{disk_name} endpoint.
• Delete a disk from a project.
• 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.