Struct CLIENT

Source

pub struct CLIENT { /* private fields */ }

Available on crate feature k8s only.

Methods from Deref<Target = Client>§

Source

pub fn valid_until(&self) -> &Option<Timestamp>

Get the expiration timestamp of the client, if it has been set.

Source

pub fn default_namespace(&self) -> &str

Get the default namespace for the client

The namespace is either configured on context in the kubeconfig, falls back to default when running locally, or uses the service account’s namespace when deployed in-cluster.

Source

pub async fn send( &self, request: Request<Body>, ) -> Result<Response<Body>, Error>

Perform a raw HTTP request against the API and return the raw response back. This method can be used to get raw access to the API which may be used to, for example, create a proxy server or application-level gateway between localhost and the API server.

Source

pub async fn request<T>(&self, request: Request<Vec<u8>>) -> Result<T, Error>
where T: DeserializeOwned,

Perform a raw HTTP request against the API and deserialize the response as JSON to some known type.

Source

pub async fn request_text( &self, request: Request<Vec<u8>>, ) -> Result<String, Error>

Perform a raw HTTP request against the API and get back the response as a string

Source

pub async fn request_stream( &self, request: Request<Vec<u8>>, ) -> Result<impl AsyncBufRead + use<>, Error>

Perform a raw HTTP request against the API and stream the response body.

The response can be processed using AsyncReadExt and AsyncBufReadExt.

Source

pub async fn request_status<T>( &self, request: Request<Vec<u8>>, ) -> Result<Either<T, Status>, Error>
where T: DeserializeOwned,

Perform a raw HTTP request against the API and get back either an object deserialized as JSON or a Status Object.

Source

pub async fn request_events<T>( &self, request: Request<Vec<u8>>, ) -> Result<impl TryStream + use<T>, Error>
where T: Clone + DeserializeOwned,

Perform a raw request and get back a stream of WatchEvent objects

Source

pub async fn apiserver_version(&self) -> Result<Info, Error>

Returns apiserver version.

Source

pub async fn list_api_groups(&self) -> Result<APIGroupList, Error>

Lists api groups that apiserver serves.

Source

pub async fn list_api_group_resources( &self, apiversion: &str, ) -> Result<APIResourceList, Error>

Lists resources served in given API group.

§Example usage:

let apigroups = client.list_api_groups().await?;
for g in apigroups.groups {
    let ver = g
        .preferred_version
        .as_ref()
        .or_else(|| g.versions.first())
        .expect("preferred or versions exists");
    let apis = client.list_api_group_resources(&ver.group_version).await?;
    dbg!(apis);
}

Source

pub async fn list_core_api_versions(&self) -> Result<APIVersions, Error>

Lists versions of core a.k.a. "" legacy API group.

Source

pub async fn list_core_api_resources( &self, version: &str, ) -> Result<APIResourceList, Error>

Lists resources served in particular core group version.

Source

pub async fn list_api_groups_aggregated( &self, ) -> Result<APIGroupDiscoveryList, Error>

Returns aggregated discovery for all API groups served at /apis.

This uses the Aggregated Discovery API to fetch all non-core API groups and their resources in a single request.

Requires Kubernetes 1.26+ (beta) or 1.30+ (stable).

§Example usage:

let discovery = client.list_api_groups_aggregated().await?;
for group in discovery.items {
    let name = group.metadata.as_ref().and_then(|m| m.name.as_ref());
    println!("Group: {:?}", name);
    for version in group.versions {
        println!("  Version: {:?}", version.version);
        for resource in version.resources {
            println!("    Resource: {:?}", resource.resource);
        }
    }
}

Source

pub async fn list_core_api_versions_aggregated( &self, ) -> Result<APIGroupDiscoveryList, Error>

Returns aggregated discovery for core API group served at /api.

This uses the Aggregated Discovery API to fetch the core API group and all its resources in a single request.

Requires Kubernetes 1.26+ (beta) or 1.30+ (stable).

§Example usage:

let discovery = client.list_core_api_versions_aggregated().await?;
for group in discovery.items {
    for version in group.versions {
        println!("Core version: {:?}", version.version);
        for resource in version.resources {
            println!("  Resource: {:?} (scope: {:?})", resource.resource, resource.scope);
        }
    }
}

CLIENT

Struct CLIENT Copy item path

Methods from Deref<Target = Client>§

pub fn valid_until(&self) -> &Option<Timestamp>

pub fn default_namespace(&self) -> &str

pub async fn send( &self, request: Request<Body>, ) -> Result<Response<Body>, Error>

pub async fn request<T>(&self, request: Request<Vec<u8>>) -> Result<T, Error>where T: DeserializeOwned,

pub async fn request_text( &self, request: Request<Vec<u8>>, ) -> Result<String, Error>

pub async fn request_stream( &self, request: Request<Vec<u8>>, ) -> Result<impl AsyncBufRead + use<>, Error>

pub async fn request_status<T>( &self, request: Request<Vec<u8>>, ) -> Result<Either<T, Status>, Error>where T: DeserializeOwned,

pub async fn request_events<T>( &self, request: Request<Vec<u8>>, ) -> Result<impl TryStream + use<T>, Error>where T: Clone + DeserializeOwned,

pub async fn apiserver_version(&self) -> Result<Info, Error>

pub async fn list_api_groups(&self) -> Result<APIGroupList, Error>

pub async fn list_api_group_resources( &self, apiversion: &str, ) -> Result<APIResourceList, Error>

§Example usage:

pub async fn list_core_api_versions(&self) -> Result<APIVersions, Error>

pub async fn list_core_api_resources( &self, version: &str, ) -> Result<APIResourceList, Error>

pub async fn list_api_groups_aggregated( &self, ) -> Result<APIGroupDiscoveryList, Error>

§Example usage:

pub async fn list_core_api_versions_aggregated( &self, ) -> Result<APIGroupDiscoveryList, Error>

§Example usage:

Trait Implementations§

impl Deref for CLIENT

type Target = Client

fn deref(&self) -> &Client

impl LazyStatic for CLIENT

Auto Trait Implementations§

impl Freeze for CLIENT

impl RefUnwindSafe for CLIENT

impl Send for CLIENT

impl Sync for CLIENT

impl Unpin for CLIENT

impl UnsafeUnpin for CLIENT

impl UnwindSafe for CLIENT

Blanket Implementations§

impl<T> Any for Twhere T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for Twhere T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for Twhere T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DTwhere ST: ?Sized, DT: ?Sized,

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DTwhere ST: ?Sized, DT: ?Sized,

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

fn in_current_span(self) -> Instrumented<Self> ⓘ

impl<T, U> Into<U> for Twhere U: From<T>,

fn into(self) -> U

impl<T> IntoEither for T

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘwhere F: FnOnce(&Self) -> bool,

impl<T> PolicyExt for Twhere T: ?Sized,

fn and<P, B, E>(self, other: P) -> And<T, P>where T: Sized + Policy<B, E>, P: Policy<B, E>,

fn or<P, B, E>(self, other: P) -> Or<T, P>where T: Sized + Policy<B, E>, P: Policy<B, E>,

impl<T> Read<Exclusive, BecauseExclusive> for Twhere T: ?Sized,

impl<P, T> Receiver for Pwhere P: Deref<Target = T> + ?Sized, T: ?Sized,

type Target = T

impl<T> Same for T

type Output = T

impl<T> ServiceExt for T

fn map_response_body<F>(self, f: F) -> MapResponseBody<Self, F>where Self: Sized,

fn trace_for_http(self) -> Trace<Self, SharedClassifier<ServerErrorsAsFailures>>where Self: Sized,

fn trace_for_grpc(self) -> Trace<Self, SharedClassifier<GrpcErrorsAsFailures>>where Self: Sized,

fn follow_redirects(self) -> FollowRedirect<Self>where Self: Sized,

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

type Error = !

fn try_from(value: U) -> Result<T, !>

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<V, T> VZip<V> for Twhere V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘwhere S: Into<Dispatch>,

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Struct CLIENT

pub async fn request<T>(&self, request: Request<Vec<u8>>) -> Result<T, Error>
where T: DeserializeOwned,

pub async fn request_status<T>( &self, request: Request<Vec<u8>>, ) -> Result<Either<T, Status>, Error>
where T: DeserializeOwned,

pub async fn request_events<T>( &self, request: Request<Vec<u8>>, ) -> Result<impl TryStream + use<T>, Error>
where T: Clone + DeserializeOwned,

impl<T> Any for T
where T: 'static + ?Sized,

impl<T> Borrow<T> for T
where T: ?Sized,

impl<T> BorrowMut<T> for T
where T: ?Sized,

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

impl<T, U> Into<U> for T
where U: From<T>,

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

impl<T> PolicyExt for T
where T: ?Sized,

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

impl<P, T> Receiver for P
where P: Deref<Target = T> + ?Sized, T: ?Sized,

fn map_response_body<F>(self, f: F) -> MapResponseBody<Self, F>
where Self: Sized,

fn trace_for_http(self) -> Trace<Self, SharedClassifier<ServerErrorsAsFailures>>
where Self: Sized,

fn trace_for_grpc(self) -> Trace<Self, SharedClassifier<GrpcErrorsAsFailures>>
where Self: Sized,

fn follow_redirects(self) -> FollowRedirect<Self>
where Self: Sized,

impl<T, U> TryFrom<U> for T
where U: Into<T>,

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,