Struct kube_core::params::ListParams
source · pub struct ListParams {
pub label_selector: Option<String>,
pub field_selector: Option<String>,
pub timeout: Option<u32>,
pub limit: Option<u32>,
pub continue_token: Option<String>,
pub version_match: Option<VersionMatch>,
pub resource_version: Option<String>,
}
Expand description
Common query parameters used in 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.
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.
version_match: Option<VersionMatch>
Determines how resourceVersion is matched applied to list calls.
resource_version: Option<String>
An explicit resourceVersion using the given VersionMatch
strategy
See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details.
Implementations§
source§impl ListParams
impl ListParams
Builder interface to ListParams
Usage:
use kube::api::ListParams;
let lp = ListParams::default()
.match_any()
.timeout(60)
.labels("kubernetes.io/lifecycle=spot");
sourcepub fn timeout(self, timeout_secs: u32) -> Self
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
sourcepub fn fields(self, field_selector: &str) -> Self
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 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) -> Self
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 can be comma separated: key1=value1,key2=value2
.
sourcepub fn continue_token(self, token: &str) -> Self
pub fn continue_token(self, token: &str) -> Self
Sets a continue token.
sourcepub fn matching(self, version_match: VersionMatch) -> Self
pub fn matching(self, version_match: VersionMatch) -> Self
Sets an arbitary resource version match strategy
A non-default strategy such as VersionMatch::Exact
or VersionMatch::NotOlderThan
requires an explicit resource_version
set to pass request validation.
sourcepub fn match_any(self) -> Self
pub fn match_any(self) -> Self
Use the semantic “any” resource version strategy
This is a less taxing variant of the default list, returning data at any resource version. It will prefer the newest avialable resource version, but strong consistency is not required; data at any resource version may be served. It is possible for the request to return data at a much older resource version than the client has previously observed, particularly in high availability configurations, due to partitions or stale caches. Clients that cannot tolerate this should not use this semantic.
Trait Implementations§
source§impl Clone for ListParams
impl Clone for ListParams
source§fn clone(&self) -> ListParams
fn clone(&self) -> ListParams
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for ListParams
impl Debug for ListParams
source§impl Default for ListParams
impl Default for ListParams
source§fn default() -> ListParams
fn default() -> ListParams
source§impl PartialEq for ListParams
impl PartialEq for ListParams
impl StructuralPartialEq for ListParams
Auto Trait Implementations§
impl Freeze for ListParams
impl RefUnwindSafe for ListParams
impl Send for ListParams
impl Sync for ListParams
impl Unpin for ListParams
impl UnwindSafe for ListParams
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§default unsafe fn clone_to_uninit(&self, dst: *mut T)
default unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)