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:301

    Properties

    apiEndpoint

    Static apiEndpoint: Object

    Type declaration

    Name Type
    apiInfo { group: string ; resource: string ; version: string }[]
    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

    isNamespaced

    get isNamespaced(): boolean

    Returns

    boolean

    Defined in

    lib/k8s/crd.ts:75


    plural

    get plural(): string

    Returns

    string

    Defined in

    lib/k8s/crd.ts:51


    spec

    get spec(): Object

    Returns

    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 }[]

    Defined in

    lib/k8s/crd.ts:47


    className

    Static get className(): string

    Returns

    string

    Overrides

    makeKubeObject<KubeCRD&gt;('crd').className

    Defined in

    lib/k8s/crd.ts:39


    detailsRoute

    Static get detailsRoute(): string

    Returns

    string

    Defined in

    lib/k8s/crd.ts:43

    Methods

    getMainAPIGroup

    getMainAPIGroup(): [string, string, string]

    Returns

    [string, string, string]

    Defined in

    lib/k8s/crd.ts:55


    makeCRClass

    makeCRClass(): KubeObjectIface < KubeObjectInterface | KubeEvent >

    Returns

    KubeObjectIface < KubeObjectInterface | KubeEvent >

    Defined in

    lib/k8s/crd.ts:79


    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:281


    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:304


    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:300


    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:287


    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:282


    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:296


    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:293