Struct RunpodClient

pub struct RunpodClient { /* private fields */ }

Main client struct for interacting with RunPod.

Implementations

impl RunpodClient

pub fn new(api_key: impl Into<String>) -> Self

Construct a new RunpodClient with your API key.

pub async fn list_gpu_types_graphql( &self, ) -> Result<GPUTypesListResponseData, Error>

List GPU Types (only available in GraphQL).

pub async fn get_gpu_type_graphql( &self, gpu_type_id: &str, ) -> Result<GPUTypeResponseData, Error>

Get GPU Type by ID (only available in GraphQL).

pub async fn list_available_gpus_with_datacenters( &self, ) -> Result<DatacentersWithGpuTypes, Error>

pub async fn create_on_demand_pod( &self, req: CreateOnDemandPodRequest, ) -> Result<PodCreateResponseData, Error>

Create an on-demand (reserved) Pod using the REST API.

pub async fn create_spot_pod( &self, req: CreateSpotPodRequest, ) -> Result<PodCreateResponseData, Error>

Create a spot/interruptible Pod using the REST API.

pub async fn start_pod( &self, pod_id: &str, ) -> Result<PodStartResponseData, Error>

Start (Resume) a Pod. REST does not differentiate on-demand vs. spot.

pub async fn stop_pod(&self, pod_id: &str) -> Result<PodStopResponseData, Error>

Stop a Pod.

pub async fn list_pods(&self) -> Result<PodsListResponseData, Error>

List all Pods.

pub async fn get_pod(&self, pod_id: &str) -> Result<PodInfoResponseData, Error>

Get a Pod by ID.

pub async fn create_network_volume( &self, req: NetworkVolumeCreateInput, ) -> Result<NetworkVolume, Error>

Create a new Network Volume.

pub async fn list_network_volumes(&self) -> Result<Vec<NetworkVolume>, Error>

List all Network Volumes.

pub async fn get_network_volume( &self, network_volume_id: &str, ) -> Result<NetworkVolume, Error>

Get a specific Network Volume by ID.

pub async fn update_network_volume( &self, network_volume_id: &str, req: NetworkVolumeUpdateInput, ) -> Result<NetworkVolume, Error>

Update (rename or resize) a Network Volume.
For resizing, you must specify a size greater than the current size.

pub async fn delete_network_volume( &self, network_volume_id: &str, ) -> Result<(), Error>

Delete a Network Volume by ID.

pub async fn list_endpoints(&self) -> Result<Endpoints, Error>

List all Endpoints.

pub async fn get_endpoint(&self, endpoint_id: &str) -> Result<Endpoint, Error>

Get a specific Endpoint by ID.

pub async fn create_endpoint( &self, req: EndpointCreateInput, ) -> Result<Endpoint, Error>

Create a new Endpoint.

pub async fn update_endpoint( &self, endpoint_id: &str, req: EndpointUpdateInput, ) -> Result<Endpoint, Error>

Update (patch) an existing Endpoint by ID.

pub async fn delete_endpoint(&self, endpoint_id: &str) -> Result<(), Error>

Delete an Endpoint by ID.

Trait Implementations

impl Clone for RunpodClient

fn clone(&self) -> RunpodClient

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.