Class: CustomResourceDefinition

Extends

• any

Constructors

new CustomResourceDefinition()

new CustomResourceDefinition(json: KubeCRD): CustomResourceDefinition

Parameters

Parameter	Type
json	KubeCRD

Returns

CustomResourceDefinition

Inherited from

makeKubeObject<KubeCRD>('crd').constructor

Defined in

src/lib/k8s/cluster.ts:337

Properties

Property	Modifier	Type	Inherited from	Defined in
apiEndpoint	static	ApiClient<KubeObjectInterface>	-	src/lib/k8s/crd.ts:51
apiList	static	(onList: (arg: any[]) => void, onError?: (err: ApiError) => void, opts?: ApiListSingleNamespaceOptions) => any	makeKubeObject<KubeCRD>('crd').apiList	src/lib/k8s/cluster.ts:311
getAuthorization?	static	(arg: string, resourceAttrs?: AuthRequestResourceAttrs) => any	makeKubeObject<KubeCRD>('crd').getAuthorization	src/lib/k8s/cluster.ts:340
getErrorMessage	static	(err?: null | ApiError) => null | string	makeKubeObject<KubeCRD>('crd').getErrorMessage	src/lib/k8s/cluster.ts:336
readOnlyFields	static	string[]	-	src/lib/k8s/crd.ts:55
useApiGet	static	(onGet: (...args: any) => void, name: string, namespace?: string, onError?: (err: ApiError) => void) => void	makeKubeObject<KubeCRD>('crd').useApiGet	src/lib/k8s/cluster.ts:321
useApiList	static	(onList: (arg: any[]) => void, onError?: (err: ApiError) => void, opts?: ApiListOptions) => any	makeKubeObject<KubeCRD>('crd').useApiList	src/lib/k8s/cluster.ts:316
useGet	static	(name: string, namespace?: string, opts?: object) => [any, null | ApiError] & QueryResponse<any, ApiError>	makeKubeObject<KubeCRD>('crd').useGet	src/lib/k8s/cluster.ts:328

Accessors

isNamespacedScope

get isNamespacedScope(): boolean

Returns

boolean

Defined in

src/lib/k8s/crd.ts:97

---

plural

get plural(): string

Returns

string

Defined in

src/lib/k8s/crd.ts:73

---

spec

get spec(): object

Returns

object

group

group: string;

names

names: object;

names.categories?

optional categories: string[];

names.kind

kind: string;

names.listKind

listKind: string;

names.plural

plural: string;

names.singular

singular: string;

scope

scope: string;

version

version: string;

versions

versions: object[];

Defined in

src/lib/k8s/crd.ts:65

---

status

get status(): undefined | object

Returns

undefined | object

Defined in

src/lib/k8s/crd.ts:69

---

className

get static className(): string

Returns

string

Overrides

makeKubeObject<KubeCRD>('crd').className

Defined in

src/lib/k8s/crd.ts:57

---

detailsRoute

get static detailsRoute(): string

Returns

string

Defined in

src/lib/k8s/crd.ts:61

Methods

getCategories()

getCategories(): string[]

Returns

string[]

Defined in

src/lib/k8s/crd.ts:114

---

getMainAPIGroup()

getMainAPIGroup(): [string, string, string]

Returns

[string, string, string]

Defined in

src/lib/k8s/crd.ts:77

---

makeCRClass()

makeCRClass(): KubeObjectIface<KubeObjectInterface | KubeEvent>

Returns

KubeObjectIface<KubeObjectInterface | KubeEvent>

Defined in

src/lib/k8s/crd.ts:101

---

useList()

static useList(options?: ApiListOptions): [null | any[], null | ApiError] & QueryListResponse<KubeList<any>, any, ApiError>

Parameters

Parameter	Type
options?	ApiListOptions

Returns

[null | any[], null | ApiError] & QueryListResponse<KubeList<any>, any, ApiError>

Inherited from

makeKubeObject<KubeCRD>('crd').useList

Defined in

src/lib/k8s/cluster.ts:327