Struct oxide_api::hardware::Hardware

pub struct Hardware {
    pub client: Client,
}

Fields

client: Client

Implementations

impl Hardware

pub async fn racks_get(
    &self,
    limit: u32,
    page_token: &str,
    sort_by: IdSortModeAscending
) -> Result<Vec<Rack>>

• This function performs a GET to the /hardware/racks endpoint.
• List racks in the system.
• 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::IdSortModeAscending – Supported set of sort modes for scanning by id only.
• Currently, we only support scanning in ascending order.

pub async fn racks_get_all(
    &self,
    sort_by: IdSortModeAscending
) -> Result<Vec<Rack>>

• This function performs a GET to the /hardware/racks endpoint.
• As opposed to racks_get, this function returns all the pages of the request at once.
• List racks in the system.

pub async fn racks_get_rack(&self, rack_id: &str) -> Result<Rack>

• This function performs a GET to the /hardware/racks/{rack_id} endpoint.
• Fetch information about a particular rack.
• Parameters:
• • rack_id: &str – human-readable free-form text about a resource.

pub async fn sleds_get(
    &self,
    limit: u32,
    page_token: &str,
    sort_by: IdSortModeAscending
) -> Result<Vec<Sled>>

• This function performs a GET to the /hardware/sleds endpoint.
• List sleds in the system.
• 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::IdSortModeAscending – Supported set of sort modes for scanning by id only.
• Currently, we only support scanning in ascending order.

pub async fn sleds_get_all(
    &self,
    sort_by: IdSortModeAscending
) -> Result<Vec<Sled>>

• This function performs a GET to the /hardware/sleds endpoint.
• As opposed to sleds_get, this function returns all the pages of the request at once.
• List sleds in the system.

pub async fn sleds_get_sled(&self, sled_id: &str) -> Result<Sled>

• This function performs a GET to the /hardware/sleds/{sled_id} endpoint.
• Fetch information about a sled in the system.
• Parameters:
• • sled_id: &str – human-readable free-form text about a resource.