Class: Namespace

    lib/k8s/namespace .Namespace

    Hierarchy

    • any

      Namespace

    Constructors

    constructor

    new Namespace(json)

    Parameters

    Name Type
    json KubeNamespace

    Inherited from

    makeKubeObject<KubeNamespace>(‘namespace’).constructor

    Defined in

    lib/k8s/cluster.ts:317

    Properties

    apiEndpoint

    Static apiEndpoint: Object

    Type declaration

    Name Type
    apiInfo { group: string ; resource: string ; version: string }[]
    delete (name: string, queryParams?: QueryParameters , cluster?: string) => Promise<any>
    get (name: string, cb: StreamResultsCb , errCb: StreamErrCb , queryParams?: QueryParameters , cluster?: string) => Promise<() => void>
    isNamespaced boolean
    list (cb: StreamResultsCb , errCb: StreamErrCb , queryParams?: QueryParameters , cluster?: string) => Promise<() => void>
    patch (body: OpPatch[], name: string, queryParams?: QueryParameters , cluster?: string) => Promise<any>
    post (body: KubeObjectInterface , queryParams?: QueryParameters , cluster?: string) => Promise<any>
    put (body: KubeObjectInterface , queryParams?: QueryParameters , cluster?: string) => Promise<any>

    Defined in

    lib/k8s/namespace.ts:11


    className

    Static className: string

    Inherited from

    makeKubeObject<KubeNamespace>(‘namespace’).className

    Defined in

    lib/k8s/cluster.ts:318

    Accessors

    status

    get status(): any

    Returns

    any

    Defined in

    lib/k8s/namespace.ts:13

    Methods

    apiList

    Static apiList(onList, onError?, opts?): any

    Parameters

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

    Returns

    any

    Inherited from

    makeKubeObject<KubeNamespace>(‘namespace’).apiList

    Defined in

    lib/k8s/cluster.ts:293


    getAuthorization

    Static Optional getAuthorization(arg, resourceAttrs?): any

    Parameters

    Name Type
    arg string
    resourceAttrs? AuthRequestResourceAttrs

    Returns

    any

    Inherited from

    makeKubeObject<KubeNamespace>(‘namespace’).getAuthorization

    Defined in

    lib/k8s/cluster.ts:320


    getErrorMessage

    Static getErrorMessage(err?): null | string

    Parameters

    Name Type
    err? null | ApiError

    Returns

    null | string

    Inherited from

    makeKubeObject<KubeNamespace>(‘namespace’).getErrorMessage

    Defined in

    lib/k8s/cluster.ts:316


    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<KubeNamespace>(‘namespace’).useApiGet

    Defined in

    lib/k8s/cluster.ts:303


    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<KubeNamespace>(‘namespace’).useApiList

    Defined in

    lib/k8s/cluster.ts:298


    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<KubeNamespace>(‘namespace’).useGet

    Defined in

    lib/k8s/cluster.ts:312


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

    Defined in

    lib/k8s/cluster.ts:309