Struct oxide_api::instances::Instances

pub struct Instances {
    pub client: Client,
}

Fields

client: Client

Implementations

impl Instances

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

This function performs a GET to the /organizations/{organization_name}/projects/{project_name}/instances endpoint. * List instances 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 get_all(
    &self,
    sort_by: NameSortModeAscending,
    organization_name: &str,
    project_name: &str
) -> Result<Vec<Instance>>

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

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

This function performs a POST to the /organizations/{organization_name}/projects/{project_name}/instances endpoint. * Create an instance in a project.

• TODO-correctness This is supposed to be async. Is that right? We can create the instance immediately – it’s just not booted yet. Maybe the boot operation is what’s a separate operation_id. What about the response code (201 Created vs 202 Accepted)? Is that orthogonal? Things can return a useful response, including an operation id, with either response code. Maybe a “reboot” operation would return a 202 Accepted because there’s no actual resource created?

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 get(
    &self,
    instance_name: &str,
    organization_name: &str,
    project_name: &str
) -> Result<Instance>

This function performs a GET to the /organizations/{organization_name}/projects/{project_name}/instances/{instance_name} endpoint. * Get an instance in a project. * Parameters: *

• instance_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,
    instance_name: &str,
    organization_name: &str,
    project_name: &str
) -> Result<()>

This function performs a DELETE to the /organizations/{organization_name}/projects/{project_name}/instances/{instance_name} endpoint. * Delete an instance from a project. * Parameters: *

• instance_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_get(
    &self,
    limit: u32,
    page_token: &str,
    sort_by: NameSortModeAscending,
    instance_name: &str,
    organization_name: &str,
    project_name: &str
) -> Result<Vec<Disk>>

This function performs a GET to the /organizations/{organization_name}/projects/{project_name}/instances/{instance_name}/disks endpoint. * List disks attached to this instance. * 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.

• instance_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_get_all(
    &self,
    sort_by: NameSortModeAscending,
    instance_name: &str,
    organization_name: &str,
    project_name: &str
) -> Result<Vec<Disk>>

This function performs a GET to the /organizations/{organization_name}/projects/{project_name}/instances/{instance_name}/disks endpoint. * As opposed to disks_get, this function returns all the pages of the request at once. * List disks attached to this instance.

pub async fn disks_attach(
    &self,
    instance_name: &str,
    organization_name: &str,
    project_name: &str,
    body: &DiskIdentifier
) -> Result<Disk>

This function performs a POST to the /organizations/{organization_name}/projects/{project_name}/instances/{instance_name}/disks/attach endpoint. * Parameters: *

• instance_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_detach(
    &self,
    instance_name: &str,
    organization_name: &str,
    project_name: &str,
    body: &DiskIdentifier
) -> Result<Disk>

This function performs a POST to the /organizations/{organization_name}/projects/{project_name}/instances/{instance_name}/disks/detach endpoint. * Parameters: *

• instance_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 reboot(
    &self,
    instance_name: &str,
    organization_name: &str,
    project_name: &str
) -> Result<Instance>

This function performs a POST to the /organizations/{organization_name}/projects/{project_name}/instances/{instance_name}/reboot endpoint. * Reboot an instance. * Parameters: *

• instance_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 start(
    &self,
    instance_name: &str,
    organization_name: &str,
    project_name: &str
) -> Result<Instance>

This function performs a POST to the /organizations/{organization_name}/projects/{project_name}/instances/{instance_name}/start endpoint. * Boot an instance. * Parameters: *

• instance_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 stop(
    &self,
    instance_name: &str,
    organization_name: &str,
    project_name: &str
) -> Result<Instance>

This function performs a POST to the /organizations/{organization_name}/projects/{project_name}/instances/{instance_name}/stop endpoint. * Halt an instance. * Parameters: *

• instance_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.