Struct kube::Api

pub struct Api<K> { /* fields omitted */ }

An easy Api interaction helper

The upsides of working with this rather than a Resource directly are:

• easiers serialization interface (no figuring out return types)
• client hidden within, less arguments

But the downsides are:

• openapi types can take up a large amount of memory
• openapi types can be annoying to wrangle with their heavy Option use
• no control over requests (opinionated)

Methods

impl<K> Api<K> where
    K: Resource, 

Expose same interface as Api for controlling scope/group/versions/ns

pub fn all(client: APIClient) -> Self

Cluster level resources, or resources viewed across all namespaces

pub fn namespaced(client: APIClient, ns: &str) -> Self

Namespaced resource within a given namespace

impl<K> Api<K> where
    K: Clone + DeserializeOwned + Meta, 

PUSH/PUT/POST/GET abstractions

pub async fn get<'_, '_>(&'_ self, name: &'_ str) -> Result<K>

pub async fn create<'_, '_>(
    &'_ self,
    pp: &'_ PostParams,
    data: Vec<u8>
) -> Result<K>

pub async fn delete<'_, '_, '_>(
    &'_ self,
    name: &'_ str,
    dp: &'_ DeleteParams
) -> Result<Either<K, Status>>

pub async fn list<'_, '_>(&'_ self, lp: &'_ ListParams) -> Result<ObjectList<K>>

pub async fn delete_collection<'_, '_>(
    &'_ self,
    lp: &'_ ListParams
) -> Result<Either<ObjectList<K>, Status>>

pub async fn patch<'_, '_, '_>(
    &'_ self,
    name: &'_ str,
    pp: &'_ PatchParams,
    patch: Vec<u8>
) -> Result<K>

pub async fn replace<'_, '_, '_>(
    &'_ self,
    name: &'_ str,
    pp: &'_ PostParams,
    data: Vec<u8>
) -> Result<K>

pub async fn watch<'_, '_, '_>(
    &'_ self,
    lp: &'_ ListParams,
    version: &'_ str
) -> Result<impl Stream<Item = WatchEvent<K>>>

impl<K> Api<K> where
    K: Clone + DeserializeOwned, 

Scale subresource

https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/#scale-subresource

pub async fn get_scale<'_, '_>(&'_ self, name: &'_ str) -> Result<Scale>

pub async fn patch_scale<'_, '_, '_>(
    &'_ self,
    name: &'_ str,
    pp: &'_ PatchParams,
    patch: Vec<u8>
) -> Result<Scale>

pub async fn replace_scale<'_, '_, '_>(
    &'_ self,
    name: &'_ str,
    pp: &'_ PostParams,
    data: Vec<u8>
) -> Result<Scale>

impl<K> Api<K> where
    K: Clone + DeserializeOwned, 

Status subresource

https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/#status-subresource

pub async fn get_status<'_, '_>(&'_ self, name: &'_ str) -> Result<K>

pub async fn patch_status<'_, '_, '_>(
    &'_ self,
    name: &'_ str,
    pp: &'_ PatchParams,
    patch: Vec<u8>
) -> Result<K>

pub async fn replace_status<'_, '_, '_>(
    &'_ self,
    name: &'_ str,
    pp: &'_ PostParams,
    data: Vec<u8>
) -> Result<K>

impl<K> Api<K> where
    K: Clone + DeserializeOwned + LoggingObject, 

pub async fn log<'_, '_, '_>(
    &'_ self,
    name: &'_ str,
    lp: &'_ LogParams
) -> Result<String>

pub async fn log_stream<'_, '_, '_>(
    &'_ self,
    name: &'_ str,
    lp: &'_ LogParams
) -> Result<impl Stream<Item = Result<Bytes>>>

Trait Implementations

impl<K: Clone> Clone for Api<K>

fn clone(&self) -> Api<K>

Returns a copy of the value.

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

Performs copy-assignment from source.