[−][src]Struct kube::Client
Client for connecting with a Kubernetes cluster.
The best way to instantiate the client is either by
inferring the configuration from the environment using
Client::try_default
or with an existing Config
using Client::new
Implementations
impl Client
[src]
pub fn new(config: Config) -> Self
[src]
Create and initialize a Client
using the given
configuration.
Panics
Panics if the configuration supplied leads to an invalid HTTP client.
Refer to the reqwest::ClientBuilder::build
docs for information
on situations where this might fail. If you want to handle this error case
use Config::try_from
(note that this requires std::convert::TryFrom
to be in scope.)
pub async fn try_default() -> Result<Self>
[src]
Create and initialize a Client
using the inferred
configuration.
Will use Config::infer
to try in-cluster enironment
variables first, then fallback to the local kubeconfig.
Will fail if neither configuration could be loaded.
If you already have a Config
then use Client::try_from
instead
pub async fn connect(
&self,
request: Request<()>
) -> Result<WebSocketStream<ConnectStream>>
[src]
&self,
request: Request<()>
) -> Result<WebSocketStream<ConnectStream>>
ws
only.Make WebSocket connection.
pub async fn request<T>(&self, request: Request<Vec<u8>>) -> Result<T> where
T: DeserializeOwned,
[src]
T: DeserializeOwned,
Perform a raw HTTP request against the API and deserialize the response as JSON to some known type.
pub async fn request_text(&self, request: Request<Vec<u8>>) -> Result<String>
[src]
Perform a raw HTTP request against the API and get back the response as a string
pub async fn request_text_stream(
&self,
request: Request<Vec<u8>>
) -> Result<impl Stream<Item = Result<Bytes>>>
[src]
&self,
request: Request<Vec<u8>>
) -> Result<impl Stream<Item = Result<Bytes>>>
Perform a raw HTTP request against the API and get back the response as a stream of bytes
pub async fn request_status<T>(
&self,
request: Request<Vec<u8>>
) -> Result<Either<T, Status>> where
T: DeserializeOwned,
[src]
&self,
request: Request<Vec<u8>>
) -> Result<Either<T, Status>> where
T: DeserializeOwned,
Perform a raw HTTP request against the API and get back either an object
deserialized as JSON or a Status
Object.
pub async fn request_events<T: Clone + Meta>(
&self,
request: Request<Vec<u8>>
) -> Result<impl TryStream<Item = Result<WatchEvent<T>>>> where
T: DeserializeOwned,
[src]
&self,
request: Request<Vec<u8>>
) -> Result<impl TryStream<Item = Result<WatchEvent<T>>>> where
T: DeserializeOwned,
Perform a raw request and get back a stream of WatchEvent
objects
pub async fn apiserver_version(&self) -> Result<Info>
[src]
Returns apiserver version.
pub async fn list_api_groups(&self) -> Result<APIGroupList>
[src]
Lists api groups that apiserver serves.
pub async fn list_api_group_resources(
&self,
apiversion: &str
) -> Result<APIResourceList>
[src]
&self,
apiversion: &str
) -> Result<APIResourceList>
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); }
pub async fn list_core_api_versions(&self) -> Result<APIVersions>
[src]
Lists versions of core
a.k.a. ""
legacy API group.
pub async fn list_core_api_resources(
&self,
version: &str
) -> Result<APIResourceList>
[src]
&self,
version: &str
) -> Result<APIResourceList>
Lists resources served in particular core
group version.
Trait Implementations
Auto Trait Implementations
impl !RefUnwindSafe for Client
[src]
impl Send for Client
[src]
impl Sync for Client
[src]
impl Unpin for Client
[src]
impl !UnwindSafe for Client
[src]
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T> Instrument for T
[src]
pub fn instrument(self, span: Span) -> Instrumented<Self>
[src]
pub fn in_current_span(self) -> Instrumented<Self>
[src]
impl<T> Instrument for T
[src]
pub fn instrument(self, span: Span) -> Instrumented<Self>
[src]
pub fn in_current_span(self) -> Instrumented<Self>
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> Same<T> for T
type Output = T
Should always be Self
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn clone_into(&self, target: &mut T)
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
V: MultiLane<T>,