Struct k8s_openapi::WatchOptional

pub struct WatchOptional<'a> {
    pub allow_watch_bookmarks: Option<bool>,
    pub field_selector: Option<&'a str>,
    pub label_selector: Option<&'a str>,
    pub resource_version: Option<&'a str>,
    pub resource_version_match: Option<&'a str>,
    pub send_initial_events: Option<bool>,
    pub timeout_seconds: Option<i64>,
}

Common parameters for all watch operations.

Fields

allow_watch_bookmarks: Option<bool>

allowWatchBookmarks requests watch events with type “BOOKMARK”. Servers that do not implement bookmarks may 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.

field_selector: Option<&'a str>

A selector to restrict the list of returned objects by their fields. Defaults to everything.

label_selector: Option<&'a str>

A selector to restrict the list of returned objects by their labels. Defaults to everything.

resource_version: Option<&'a str>

resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details.

Defaults to unset

resource_version_match: Option<&'a str>

resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details.

Defaults to unset

send_initial_events: Option<bool>

sendInitialEvents=true may be set together with watch=true. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic “Bookmark” event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with "k8s.io/initial-events-end": "true" annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched.

When sendInitialEvents option is set, we require resourceVersionMatch option to also be set. The semantic of the watch request is as following: - resourceVersionMatch = NotOlderThan is interpreted as “data at least as new as the provided resourceVersion” and the bookmark event is send when the state is synced to a resourceVersion at least as fresh as the one provided by the ListOptions. If resourceVersion is unset, this is interpreted as “consistent read” and the bookmark event is send when the state is synced at least to the moment when request started being processed.

• resourceVersionMatch set to any other value or unset Invalid error is returned.

Defaults to true if resourceVersion="" or resourceVersion="0" (for backward compatibility reasons) and to false otherwise.

timeout_seconds: Option<i64>

Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

Trait Implementations

impl<'a> Clone for WatchOptional<'a>

fn clone(&self) -> WatchOptional<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for WatchOptional<'a>

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

Formats the value using the given formatter.

impl<'a> Default for WatchOptional<'a>

fn default() -> WatchOptional<'a>

Returns the “default value” for a type.

impl<'a> PartialEq<WatchOptional<'a>> for WatchOptional<'a>

fn eq(&self, other: &WatchOptional<'a>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a> Copy for WatchOptional<'a>

impl<'a> StructuralPartialEq for WatchOptional<'a>