pub struct ImagesGlobal {
pub client: Client,
}Fields§
§client: ClientImplementations§
Source§impl ImagesGlobal
impl ImagesGlobal
Sourcepub async fn image_global_view(&self, id: &str) -> Result<GlobalImage>
pub async fn image_global_view(&self, id: &str) -> Result<GlobalImage>
Fetch a global image by id.
This function performs a GET to the /by-id/global-images/{id} endpoint.
Parameters:
id: &str
Sourcepub async fn images_get(
&self,
limit: u32,
page_token: &str,
sort_by: NameSortMode,
) -> Result<Vec<GlobalImage>>
pub async fn images_get( &self, limit: u32, page_token: &str, sort_by: NameSortMode, ) -> Result<Vec<GlobalImage>>
List global images.
This function performs a GET to the /images endpoint.
Returns a list of all the global images. Global images are returned sorted by creation date, with the most recent images appearing first.
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.
Sourcepub async fn images_get_all(
&self,
sort_by: NameSortMode,
) -> Result<Vec<GlobalImage>>
pub async fn images_get_all( &self, sort_by: NameSortMode, ) -> Result<Vec<GlobalImage>>
List global images.
This function performs a GET to the /images endpoint.
As opposed to images_get, this function returns all the pages of the request at once.
Returns a list of all the global images. Global images are returned sorted by creation date, with the most recent images appearing first.
Sourcepub async fn images_post(&self, body: &GlobalImageCreate) -> Result<GlobalImage>
pub async fn images_post(&self, body: &GlobalImageCreate) -> Result<GlobalImage>
Create a global image.
This function performs a POST to the /images endpoint.
Create a new global image. This image can then be used by any user as a base for instances.
Sourcepub async fn images_get_image(&self, image_name: &str) -> Result<GlobalImage>
pub async fn images_get_image(&self, image_name: &str) -> Result<GlobalImage>
Fetch a global image.
This function performs a GET to the /images/{image_name} endpoint.
Returns the details of a specific global image.
Parameters:
image_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.
Sourcepub async fn images_delete_image(&self, image_name: &str) -> Result<()>
pub async fn images_delete_image(&self, image_name: &str) -> Result<()>
Delete a global image.
This function performs a DELETE to the /images/{image_name} endpoint.
Permanently delete a global image. This operation cannot be undone. Any instances using the global image will continue to run, however new instances can not be created with this image.
Parameters:
image_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.