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
sourceimpl ListParams
impl ListParams
Builder interface to ListParams
Usage:
use kube::api::ListParams;
let lp = ListParams::default()
.timeout(60)
.labels("kubernetes.io/lifecycle=spot");
sourcepub fn timeout(self, timeout_secs: u32) -> ListParams
Available on crate feature client
only.
pub fn timeout(self, timeout_secs: u32) -> ListParams
client
only.Configure the timeout for list/watch calls
This limits the duration of the call, regardless of any activity or inactivity. Defaults to 290s
sourcepub fn fields(self, field_selector: &str) -> ListParams
Available on crate feature client
only.
pub fn fields(self, field_selector: &str) -> ListParams
client
only.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.
sourcepub fn labels(self, label_selector: &str) -> ListParams
Available on crate feature client
only.
pub fn labels(self, label_selector: &str) -> ListParams
client
only.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
.
sourcepub fn disable_bookmarks(self) -> ListParams
Available on crate feature client
only.
pub fn disable_bookmarks(self) -> ListParams
client
only.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.
sourcepub fn limit(self, limit: u32) -> ListParams
Available on crate feature client
only.
pub fn limit(self, limit: u32) -> ListParams
client
only.Sets a result limit.
sourcepub fn continue_token(self, token: &str) -> ListParams
Available on crate feature client
only.
pub fn continue_token(self, token: &str) -> ListParams
client
only.Sets a continue token.
Trait Implementations
sourceimpl Clone for ListParams
impl Clone for ListParams
sourcefn clone(&self) -> ListParams
fn clone(&self) -> ListParams
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for ListParams
impl Debug for ListParams
sourceimpl Default for ListParams
impl Default for ListParams
sourcefn default() -> ListParams
fn default() -> ListParams
Default ListParams
without any constricting selectors
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
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
fn vzip(self) -> V
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more