Class: PriorityClass

    lib/k8s/priorityClass .PriorityClass

    Hierarchy

    • any

      PriorityClass

    Constructors

    constructor

    new PriorityClass(json)

    Parameters

    Name Type
    json KubePriorityClass

    Inherited from

    makeKubeObject<KubePriorityClass>(‘priorityClass’).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/priorityClass.ts:12


    className

    Static className: string

    Inherited from

    makeKubeObject<KubePriorityClass>(‘priorityClass’).className

    Defined in

    lib/k8s/cluster.ts:318

    Accessors

    description

    get description(): string

    Returns

    string

    Defined in

    lib/k8s/priorityClass.ts:30


    globalDefault

    get globalDefault(): null | boolean

    Returns

    null | boolean

    Defined in

    lib/k8s/priorityClass.ts:26


    preemptionPolicy

    get preemptionPolicy(): string

    Returns

    string

    Defined in

    lib/k8s/priorityClass.ts:34


    value

    get value(): string

    Returns

    string

    Defined in

    lib/k8s/priorityClass.ts:22


    listRoute

    Static get listRoute(): string

    Returns

    string

    Defined in

    lib/k8s/priorityClass.ts:18


    pluralName

    Static get pluralName(): string

    Returns

    string

    Defined in

    lib/k8s/priorityClass.ts:14

    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<KubePriorityClass>(‘priorityClass’).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<KubePriorityClass>(‘priorityClass’).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<KubePriorityClass>(‘priorityClass’).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<KubePriorityClass>(‘priorityClass’).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<KubePriorityClass>(‘priorityClass’).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<KubePriorityClass>(‘priorityClass’).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<KubePriorityClass>(‘priorityClass’).useList

    Defined in

    lib/k8s/cluster.ts:309