Struct kube::api::ListParams

pub struct ListParams {
    pub field_selector: Option<String>,
    pub include_uninitialized: bool,
    pub label_selector: Option<String>,
    pub timeout: Option<u32>,
}

Common query parameters used in watch/list/delete calls on collections

Constructed internally with a builder on Informer and Reflector, but can be passed to the helper function of Resource.

Fields

field_selector: Option<String>

include_uninitialized: bool

label_selector: Option<String>

timeout: Option<u32>

Implementations

impl ListParams

Builder interface to ListParams

Usage:

use kube::api::ListParams;
let lp = ListParams::default()
    .timeout(60)
    .labels("kubernetes.io/lifecycle=spot");

pub fn timeout(self, timeout_secs: u32) -> Self

Configure the timeout for list/watch calls

This limits the duration of the call, regardless of any activity or inactivity. Defaults to 290s

pub fn fields(self, field_selector: &str) -> Self

Configure the selector to restrict the list of returned objects by their fields.

Defaults to everything. Supports ‘=’, ‘==’, and ‘!=’, and can comma separate: key1=value1,key2=value2 The server only supports a limited number of field queries per type.

pub fn labels(self, label_selector: &str) -> Self

Configure the selector to restrict the list of returned objects by their labels.

Defaults to everything. Supports ‘=’, ‘==’, and ‘!=’, and can comma separate: key1=value1,key2=value2

pub fn include_uninitialized(self) -> Self

If called, partially initialized resources are included in watch/list responses.

Trait Implementations

impl Clone for ListParams

fn clone(&self) -> ListParams

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for ListParams

fn default() -> ListParams

Returns the “default value” for a type.