Project: Headlamp (Observability and Analysis / Observability)
File: lib_k8s_crd.CustomResourceDefinition.md

title: "Class: CustomResourceDefinition" linkTitle: "CustomResourceDefinition" slug: "libk8scrd.CustomResourceDefinition" .CustomResourceDefinition `any` `CustomResourceDefinition` new CustomResourceDefinition(`json`) | Name | Type | | : | : | | `json` | | makeKubeObject<KubeCRD\>('crd').constructor `Static` apiEndpoint: `Object` | Name | Type | | : | : | | `apiInfo` | { `group`: `string` ; `resource`: `string` ; `version`: `string` }[] | | `delete` | (`name`: `string`, `queryParams?`: , `cluster?`: `string`) => `Promise`<`any`\> | | `get` | (`name`: `string`, `cb`: , `errCb`: , `queryParams?`: , `cluster?`: `string`) => `Promise`<() => `void`\> | | `isNamespaced` | `boolean` | | `list` | (`cb`: , `errCb`: , `queryParams?`: , `cluster?`: `string`) => `Promise`<() => `void`\> | | `patch` | (`body`: `OpPatch`, `cluster?`: `string`) => `Promise`<`any`\> | | `post` | (`body`: , `queryParams?`: , `cluster?`: `string`) => `Promise`<`any`\> | | `put` | (`body`: , `queryParams?`: , `cluster?`: `string`) => `Promise`<`any`\> | `get` isNamespaced(): `boolean` `boolean` _ `get` plural(): `string` `string` _ `get` spec(): `Object` `Object` | Name | Type | | : | : | | `group` | `string` | | `names` | { `kind`: `string` ; `listKind`: `string` ; `plural`: `string` ; `singular`: `string` } | | `names.kind` | `string` | | `names.listKind` | `string` | | `names.plural` | `string` | | `names.singular` | `string` | | `scope` | `string` | | `version` | `string` | | `versions` | { `additionalPrinterColumns`: { `description?`: `string` ; `format?`: `string` ; `jsonPath`: `string` ; `name`: `string` ; `priority?`: `number` ; `type`: `string` }[] ; `name`: `string` ; `served`: `boolean` ; `storage`: `boolean` }[] | _ `Static` `get` className(): `string` `string` makeKubeObject&lt;KubeCRD\&gt;(&#x27;crd&#x27;).className _ `Static` `get` detailsRoute(): `string` `string` getMainAPIGroup(): [`string`, `string`, `string`] [`string`, `string`, `string`] _ makeCRClass(): < \| \> < \| \> _ `Static` apiList(`onList`, `onError?`, `opts?`): `any` | Name | Type | | : | : | | `onList` | (`arg`: `any`[]) => `void` | | `onError?` | (`err`: ) => `void` | | `opts?` | | `any` makeKubeObject<KubeCRD\>('crd').apiList _ `Static` `Optional` getAuthorization(`arg`, `resourceAttrs?`): `any` | Name | Type | | : | : | | `arg` | `string` | | `resourceAttrs?` | | `any` makeKubeObject<KubeCRD\>('crd').getAuthorization _ `Static` getErrorMessage(`err?`): ``null`` \| `string` | Name | Type | | : | : | | `err?` | ``null`` \| | ``null`` \| `string` makeKubeObject<KubeCRD\>('crd').getErrorMessage _ `Static` useApiGet(`onGet`, `name`, `namespace?`, `onError?`): `void` | Name | Type | | : | : | | `onGet` | (...`args`: `any`) => `void` | | `name` | `string` | | `namespace?` | `string` | | `onError?` | (`err`: ) => `void` | `void` makeKubeObject<KubeCRD\>('crd').useApiGet _ `Static` useApiList(`onList`, `onError?`, `opts?`): `any` | Name | Type | | : | : | | `onList` | (`arg`: `any`[]) => `void` | | `onError?` | (`err`: ) => `void` | | `opts?` | | `any` makeKubeObject<KubeCRD\>('crd').useApiList _ `Static` useGet(`name`, `namespace?`): , (`item`: `any`) => `void`, (`err`: ``null`` \| ) => `void`] | Name | Type | | : | : | | `name` | `string` | | `namespace?` | `string` | , (`item`: `any`) => `void`, (`err`: ``null`` \| ) => `void`] makeKubeObject<KubeCRD\>('crd').useGet _ `Static` useList(`opts?`): , (`items`: `any`) => `void`] | Name | Type | | : | : | | `opts?` | | , (`items`: `any`) => `void`] makeKubeObject<KubeCRD\>('crd').useList