Struct kube_core::params::ListParams [−][src]
pub struct ListParams { pub label_selector: Option<String>, pub field_selector: Option<String>, pub timeout: Option<u32>, pub bookmarks: bool, pub limit: Option<u32>, pub continue_token: Option<String>, }
Expand description
Common query parameters used in watch/list/delete calls on collections
Fields
label_selector: Option<String>
A selector to restrict the list of returned objects by their labels.
Defaults to everything if None
.
field_selector: Option<String>
A selector to restrict the list of returned objects by their fields.
Defaults to everything if None
.
timeout: Option<u32>
Timeout for the list/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.
limit: Option<u32>
Limit the number of results.
If there are more results, the server will respond with a continue token which can be used to fetch another page of results. See the Kubernetes API docs for pagination details.
continue_token: Option<String>
Fetch a second page of results.
After listing results with a limit, a continue token can be used to fetch another page of results.
Implementations
impl ListParams
[src]
impl ListParams
[src]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
[src]
pub fn timeout(self, timeout_secs: u32) -> Self
[src]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
[src]
pub fn fields(self, field_selector: &str) -> Self
[src]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) -> Self
[src]
pub fn labels(self, label_selector: &str) -> Self
[src]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) -> Self
[src]
pub fn disable_bookmarks(self) -> Self
[src]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.
pub fn continue_token(self, token: &str) -> Self
[src]
pub fn continue_token(self, token: &str) -> Self
[src]Sets a continue token.
Trait Implementations
impl Clone for ListParams
[src]
impl Clone for ListParams
[src]fn clone(&self) -> ListParams
[src]
fn clone(&self) -> ListParams
[src]Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
1.0.0[src]
fn clone_from(&mut self, source: &Self)
1.0.0[src]Performs copy-assignment from source
. Read more
impl Debug for ListParams
[src]
impl Debug for ListParams
[src]Auto Trait Implementations
impl RefUnwindSafe for ListParams
impl Send for ListParams
impl Sync for ListParams
impl Unpin for ListParams
impl UnwindSafe for ListParams
Blanket Implementations
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]pub fn borrow_mut(&mut self) -> &mut T
[src]
pub fn borrow_mut(&mut self) -> &mut T
[src]Mutably borrows from an owned value. Read more
impl<T> ToOwned for T where
T: Clone,
[src]
impl<T> ToOwned for T where
T: Clone,
[src]type Owned = T
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn to_owned(&self) -> T
[src]Creates owned data from borrowed data, usually by cloning. Read more
pub fn clone_into(&self, target: &mut T)
[src]
pub fn clone_into(&self, target: &mut T)
[src]🔬 This is a nightly-only experimental API. (toowned_clone_into
)
recently added
Uses borrowed data to replace owned data, usually by cloning. Read more