Struct ListPodsQuery 

pub struct ListPodsQuery {

    pub compute_type: Option<ComputeType>,
    pub cpu_flavor_id: Option<Vec<CpuFlavorId>>,
    pub data_center_id: Option<Vec<DataCenterId>>,
    pub desired_status: Option<PodStatus>,
    pub endpoint_id: Option<String>,
    pub gpu_type_id: Option<Vec<GpuTypeId>>,
    pub id: Option<String>,
    pub image_name: Option<String>,
    pub include_machine: Option<bool>,
    pub include_network_volume: Option<bool>,
    pub include_savings_plans: Option<bool>,
    pub include_template: Option<bool>,
    pub include_workers: Option<bool>,
    pub name: Option<String>,
    pub network_volume_id: Option<String>,
    pub template_id: Option<String>,
}

Query parameters for filtering and configuring Pod list operations.

This struct provides various filters and options for customizing the response when listing Pods.

Examples

use runpod_sdk::model::{ListPodsQuery, ComputeType, PodStatus};

let query = ListPodsQuery {
    compute_type: Some(ComputeType::Gpu),
    desired_status: Some(PodStatus::Running),
    include_machine: Some(true),
    ..Default::default()
};

Fields

compute_type: Option<ComputeType>

Filter to only GPU or only CPU Pods.

cpu_flavor_id: Option<Vec<CpuFlavorId>>

Filter to CPU Pods with any of the listed CPU flavors.

data_center_id: Option<Vec<DataCenterId>>

Filter to Pods located in any of the provided RunPod data centers.

desired_status: Option<PodStatus>

Filter to Pods currently in the provided state.

endpoint_id: Option<String>

Filter to workers on the provided Serverless endpoint. Note that endpoint workers are not included in the response by default.

gpu_type_id: Option<Vec<GpuTypeId>>

Filter to Pods with any of the listed GPU types attached.

id: Option<String>

Filter to a specific Pod.

image_name: Option<String>

Filter to Pods created with the provided image.

include_machine: Option<bool>

Include information about the machine the Pod is running on.

include_network_volume: Option<bool>

Include information about the network volume attached to the Pod, if any.

include_savings_plans: Option<bool>

Include information about the savings plans applied to the Pod.

include_template: Option<bool>

Include information about the template the Pod uses, if any.

include_workers: Option<bool>

Set to true to also list Pods which are Serverless workers.

name: Option<String>

Filter to Pods with the provided name.

network_volume_id: Option<String>

Filter to Pods with the provided network volume attached.

template_id: Option<String>

Filter to Pods created from the provided template.

Trait Implementations

impl Clone for ListPodsQuery

fn clone(&self) -> ListPodsQuery

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ListPodsQuery

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ListPodsQuery

fn default() -> ListPodsQuery

Returns the “default value” for a type.

impl Serialize for ListPodsQuery

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.