Class: Namespace

Extends

• any

Constructors

new Namespace()

new Namespace(json: KubeNamespace): Namespace

Parameters

Parameter	Type
json	KubeNamespace

Returns

Namespace

Inherited from

makeKubeObject<KubeNamespace>('namespace').constructor

Defined in

src/lib/k8s/cluster.ts:337

Properties

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

Accessors

status

get status(): any

Returns

any

Defined in

src/lib/k8s/namespace.ts:13

Methods

isValidNamespaceFormat()

static isValidNamespaceFormat(namespace: string): boolean

This function validates the custom namespace input matches the crieria for DNS-1123 label names.

Parameters

Parameter	Type
namespace	string

Returns

boolean

true if the namespace is valid, false otherwise.

Params

namespace: string

See

https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#dns-label-names

Defined in

src/lib/k8s/namespace.ts:23

---

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<KubeNamespace>('namespace').useList

Defined in

src/lib/k8s/cluster.ts:327