Class: CustomResourceDefinition

lib/k8s/crd .CustomResourceDefinition

Hierarchy

any

↳ CustomResourceDefinition

Constructors

constructor

• new CustomResourceDefinition(json)

Parameters

Name	Type
`json`	`KubeCRD`

Inherited from

makeKubeObject<KubeCRD>(‘crd’).constructor

Defined in

lib/k8s/cluster.ts:107

Properties

apiEndpoint

▪ Static apiEndpoint: Object

Type declaration

Name	Type
`delete`	(`name`: `string`, `queryParams?`: `QueryParameters` ) => `Promise`<`any`>
`get`	(`name`: `string`, `cb`: `StreamResultsCb` , `errCb`: `StreamErrCb` , `queryParams?`: `QueryParameters` ) => `Promise`<() => `void`>
`isNamespaced`	`boolean`
`list`	(`cb`: `StreamResultsCb` , `errCb`: `StreamErrCb` , `queryParams?`: `QueryParameters` ) => `Promise`<() => `void`>
`patch`	(`body`: `OpPatch`[], `name`: `string`, `queryParams?`: `QueryParameters` ) => `Promise`<`any`>
`post`	(`body`: `KubeObjectInterface` , `queryParams?`: `QueryParameters` ) => `Promise`<`any`>
`put`	(`body`: `KubeObjectInterface` , `queryParams?`: `QueryParameters` ) => `Promise`<`any`>

Defined in

lib/k8s/crd.ts:34

Accessors

plural

• get plural(): string

Returns

string

Defined in

lib/k8s/crd.ts:51

spec

• get spec(): any

Returns

any

Defined in

lib/k8s/crd.ts:47

className

• Static get className(): string

Returns

string

Overrides

makeKubeObject<KubeCRD>('crd').className

Defined in

lib/k8s/crd.ts:39

detailsRoute

• Static get detailsRoute(): string

Returns

string

Defined in

lib/k8s/crd.ts:43

Methods

apiList

▸ Static apiList(onList): any

Parameters

Name	Type
`onList`	(`arg`: `any`[]) => `void`

Returns

any

Inherited from

makeKubeObject<KubeCRD>(‘crd’).apiList

Defined in

lib/k8s/cluster.ts:87

getAuthorization

▸ Static Optional getAuthorization(arg, resourceAttrs?): any

Parameters

Name	Type
`arg`	`string`
`resourceAttrs?`	`AuthRequestResourceAttrs`

Returns

any

Inherited from

makeKubeObject<KubeCRD>(‘crd’).getAuthorization

Defined in

lib/k8s/cluster.ts:110

getErrorMessage

▸ Static getErrorMessage(err?): null | string

Parameters

Name	Type
`err?`	`null` \| `ApiError`

Returns

null | string

Inherited from

makeKubeObject<KubeCRD>(‘crd’).getErrorMessage

Defined in

lib/k8s/cluster.ts:106

useApiGet

▸ Static useApiGet(onGet, name, namespace?, onError?): void

Parameters

Name	Type
`onGet`	(…`args`: `any`) => `void`
`name`	`string`
`namespace?`	`string`
`onError?`	(`err`: `ApiError` ) => `void`

Returns

void

Inherited from

makeKubeObject<KubeCRD>(‘crd’).useApiGet

Defined in

lib/k8s/cluster.ts:93

useApiList

▸ Static useApiList(onList, onError?, opts?): any

Parameters

Name	Type
`onList`	(`arg`: `any`[]) => `void`
`onError?`	(`err`: `ApiError` ) => `void`
`opts?`	`ApiListOptions`

Returns

any

Inherited from

makeKubeObject<KubeCRD>(‘crd’).useApiList

Defined in

lib/k8s/cluster.ts:88

useGet

▸ Static useGet(name, namespace?): [any, null | ApiError , (item: any) => void, (err: null | ApiError ) => void]

Parameters

Name	Type
`name`	`string`
`namespace?`	`string`

Returns

[any, null | ApiError , (item: any) => void, (err: null | ApiError ) => void]

Inherited from

makeKubeObject<KubeCRD>(‘crd’).useGet

Defined in

lib/k8s/cluster.ts:102

useList

▸ Static useList(opts?): [any[], null | ApiError , (items: any[]) => void, (err: null | ApiError ) => void]

Parameters

Name	Type
`opts?`	`ApiListOptions`

Returns

[any[], null | ApiError , (items: any[]) => void, (err: null | ApiError ) => void]

Inherited from

makeKubeObject<KubeCRD>(‘crd’).useList

Defined in

lib/k8s/cluster.ts:99