Struct kube_client::api::WatchParams

pub struct WatchParams {
    pub label_selector: Option<String>,
    pub field_selector: Option<String>,
    pub timeout: Option<u32>,
    pub bookmarks: bool,
}

Available on crate feature client only.

Common query parameters used in watch calls on collections

Fields

label_selector: Option<String>

A selector to restrict returned objects by their labels.

Defaults to everything if None.

field_selector: Option<String>

A selector to restrict returned objects by their fields.

Defaults to everything if None.

timeout: Option<u32>

Timeout for the watch call.

This limits the duration of the call, regardless of any activity or inactivity. If unset for a watch call, we will use 290s. We limit this to 295s due to inherent watch limitations.

bookmarks: bool

Enables watch events with type “BOOKMARK”.

Servers that do not implement bookmarks ignore this flag and bookmarks are sent at the server’s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.

Implementations

impl WatchParams

Builder interface to WatchParams

Usage:

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

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

Configure the timeout for 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) -> WatchParams

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

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

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

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

Defaults to everything. Supports =, ==, !=, and can be comma separated: key1=value1,key2=value2.

pub fn disable_bookmarks(self) -> WatchParams

Disables watch bookmarks to simplify watch handling

This is not recommended to use with production watchers as it can cause desyncs. See #219 for details.

Trait Implementations

impl Clone for WatchParams

fn clone(&self) -> WatchParams

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for WatchParams

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

Formats the value using the given formatter.

impl Default for WatchParams

fn default() -> WatchParams

Default WatchParams without any constricting selectors