Class: PDB

    lib/k8s/podDisruptionBudget .PDB

    Hierarchy

    • any

      PDB

    Constructors

    constructor

    new PDB(json)

    Parameters

    Name Type
    json KubePDB

    Inherited from

    makeKubeObject<KubePDB>(‘podDisruptionBudget’).constructor

    Defined in

    lib/k8s/cluster.ts:317

    Properties

    apiEndpoint

    Static apiEndpoint: Object

    Index signature

    ▪ [other: string]: any

    Type declaration

    Name Type
    scale? { get: (namespace: string, name: string, clusterName?: string) => Promise<any> ; put: (body: { metadata: KubeMetadata ; spec: { replicas: number } }, clusterName?: string) => Promise<any> }
    scale.get (namespace: string, name: string, clusterName?: string) => Promise<any>
    scale.put (body: { metadata: KubeMetadata ; spec: { replicas: number } }, clusterName?: string) => Promise<any>

    Defined in

    lib/k8s/podDisruptionBudget.ts:40


    className

    Static className: string

    Inherited from

    makeKubeObject<KubePDB>(‘podDisruptionBudget’).className

    Defined in

    lib/k8s/cluster.ts:318

    Accessors

    selectors

    get selectors(): string[]

    Returns

    string[]

    Defined in

    lib/k8s/podDisruptionBudget.ts:50


    spec

    get spec(): Object

    Returns

    Object

    Name Type
    maxUnavailable? number
    minAvailable? number
    selector { matchExpressions?: { key: string ; operator: string ; values: string[] } ; matchLabels: { [key: string]: string; } }
    selector.matchExpressions? { key: string ; operator: string ; values: string[] }
    selector.matchExpressions.key string
    selector.matchExpressions.operator string
    selector.matchExpressions.values string[]
    selector.matchLabels { [key: string]: string; }

    Defined in

    lib/k8s/podDisruptionBudget.ts:42


    status

    get status(): Object

    Returns

    Object

    Name Type
    conditions { lastTransitionTime: string ; message: string ; observedGeneration: number ; reason: string ; status: string ; type: string }[]
    currentHealthy number
    desiredHealthy number
    disruptedPods? { [key: string]: string; }
    disruptionsAllowed number
    expectedPods number
    observedGeneration number

    Defined in

    lib/k8s/podDisruptionBudget.ts:46

    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<KubePDB>(‘podDisruptionBudget’).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<KubePDB>(‘podDisruptionBudget’).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<KubePDB>(‘podDisruptionBudget’).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<KubePDB>(‘podDisruptionBudget’).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<KubePDB>(‘podDisruptionBudget’).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<KubePDB>(‘podDisruptionBudget’).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<KubePDB>(‘podDisruptionBudget’).useList

    Defined in

    lib/k8s/cluster.ts:309