Struct kube_client::api::Request

pub struct Request {
    pub url_path: String,
}

Available on crate feature client only.

A Kubernetes request builder

Takes a base_path and supplies constructors for common operations The extra operations all return http::Request objects.

Fields

url_path: String

The path component of a url

Implementations

impl Request

pub fn new<S>(url_path: S) -> Requestwhere
    S: Into<String>,

New request with a resource’s url path

impl Request

Convenience methods found from API conventions

pub fn list(&self, lp: &ListParams) -> Result<Request<Vec<u8, Global>>, Error>

List a collection of a resource

pub fn watch(
    &self,
    lp: &ListParams,
    ver: &str
) -> Result<Request<Vec<u8, Global>>, Error>

Watch a resource at a given version

pub fn get(&self, name: &str) -> Result<Request<Vec<u8, Global>>, Error>

Get a single instance

pub fn create(
    &self,
    pp: &PostParams,
    data: Vec<u8, Global>
) -> Result<Request<Vec<u8, Global>>, Error>

Create an instance of a resource

pub fn delete(
    &self,
    name: &str,
    dp: &DeleteParams
) -> Result<Request<Vec<u8, Global>>, Error>

Delete an instance of a resource

pub fn delete_collection(
    &self,
    dp: &DeleteParams,
    lp: &ListParams
) -> Result<Request<Vec<u8, Global>>, Error>

Delete a collection of a resource

pub fn patch<P>(
    &self,
    name: &str,
    pp: &PatchParams,
    patch: &Patch<P>
) -> Result<Request<Vec<u8, Global>>, Error>where
    P: Serialize,

Patch an instance of a resource

Requires a serialized merge-patch+json at the moment.

pub fn replace(
    &self,
    name: &str,
    pp: &PostParams,
    data: Vec<u8, Global>
) -> Result<Request<Vec<u8, Global>>, Error>

Replace an instance of a resource

Requires metadata.resourceVersion set in data

impl Request

Subresources

pub fn get_subresource(
    &self,
    subresource_name: &str,
    name: &str
) -> Result<Request<Vec<u8, Global>>, Error>

Get an instance of the subresource

pub fn create_subresource(
    &self,
    subresource_name: &str,
    name: &str,
    pp: &PostParams,
    data: Vec<u8, Global>
) -> Result<Request<Vec<u8, Global>>, Error>

Create an instance of the subresource

pub fn patch_subresource<P>(
    &self,
    subresource_name: &str,
    name: &str,
    pp: &PatchParams,
    patch: &Patch<P>
) -> Result<Request<Vec<u8, Global>>, Error>where
    P: Serialize,

Patch an instance of the subresource

pub fn replace_subresource(
    &self,
    subresource_name: &str,
    name: &str,
    pp: &PostParams,
    data: Vec<u8, Global>
) -> Result<Request<Vec<u8, Global>>, Error>

Replace an instance of the subresource

impl Request

pub fn logs(
    &self,
    name: &str,
    lp: &LogParams
) -> Result<Request<Vec<u8, Global>>, Error>

Get a pod logs

impl Request

pub fn evict(
    &self,
    name: &str,
    ep: &EvictParams
) -> Result<Request<Vec<u8, Global>>, Error>

Create an eviction

impl Request

pub fn attach(
    &self,
    name: &str,
    ap: &AttachParams
) -> Result<Request<Vec<u8, Global>>, Error>

Attach to a pod

impl Request

pub fn exec<I, T>(
    &self,
    name: &str,
    command: I,
    ap: &AttachParams
) -> Result<Request<Vec<u8, Global>>, Error>where
    I: IntoIterator<Item = T>,
    T: Into<String>,

Execute command in a pod

impl Request

pub fn portforward(
    &self,
    name: &str,
    ports: &[u16]
) -> Result<Request<Vec<u8, Global>>, Error>

Request to forward ports of a pod

impl Request

pub fn restart(&self, name: &str) -> Result<Request<Vec<u8, Global>>, Error>

Restart a resource

impl Request

pub fn cordon(&self, name: &str) -> Result<Request<Vec<u8, Global>>, Error>

Cordon a resource

pub fn uncordon(&self, name: &str) -> Result<Request<Vec<u8, Global>>, Error>

Uncordon a resource

Trait Implementations

impl Clone for Request

fn clone(&self) -> Request

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Request

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

Formats the value using the given formatter.