Struct ApiResource

pub struct ApiResource {
    pub group: String,
    pub version: String,
    pub api_version: String,
    pub kind: String,
    pub plural: String,
}

Available on crate feature client only.

Information about a Kubernetes API resource

Enough information to use it like a Resource by passing it to the dynamic Api constructors like Api::all_with and Api::namespaced_with.

Fields

group: String

Resource group, empty for core group.

version: String

group version

api_version: String

apiVersion of the resource (v1 for core group, groupName/groupVersions for other).

kind: String

Singular PascalCase name of the resource

plural: String

Plural name of the resource

Implementations

impl ApiResource

pub fn erase<K>(dt: &<K as Resource>::DynamicType) -> ApiResource

where K: Resource,

Creates an ApiResource by type-erasing a Resource

pub fn from_gvk_with_plural(gvk: &GroupVersionKind, plural: &str) -> ApiResource

Creates an ApiResource from group, version, kind and plural name.

pub fn from_gvk(gvk: &GroupVersionKind) -> ApiResource

Creates an ApiResource from group, version and kind.

Warning

This function will guess the resource plural name. Usually, this is ok, but for CRDs with complex pluralisations it can fail. If you are getting your values from kube_derive use the generated method for giving you an ApiResource. Otherwise consider using ApiResource::from_gvk_with_plural to explicitly set the plural, or run api discovery on it via kube::discovery.

Trait Implementations

impl Clone for ApiResource

fn clone(&self) -> ApiResource

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ApiResource

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ApiResource

fn deserialize<__D>( __deserializer: __D, ) -> Result<ApiResource, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for ApiResource

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for ApiResource

fn eq(&self, other: &ApiResource) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for ApiResource

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for ApiResource

impl StructuralPartialEq for ApiResource