Class: Pod

    lib/k8s/pod .Pod

    Hierarchy

    • any

      ↳ Pod

    Constructors

    constructor

    • new Pod(json)

    Parameters

    Name Type
    json KubePod

    Inherited from

    makeKubeObject<KubePod>(‘Pod’).constructor

    Defined in

    lib/k8s/cluster.ts:76

    Properties

    apiEndpoint

    ▪ Static apiEndpoint: Object

    Index signature

    ▪ [other: string]: any

    Defined in

    lib/k8s/pod.ts:35

    className

    ▪ Static className: string

    Inherited from

    makeKubeObject<KubePod>(‘Pod’).className

    Defined in

    lib/k8s/cluster.ts:77

    Accessors

    spec

    • get spec(): Object

    Returns

    Object

    Name Type
    containers KubeContainer []
    nodeName string

    Defined in

    lib/k8s/pod.ts:37

    status

    • get status(): Object

    Returns

    Object

    Name Type
    conditions KubeCondition []
    containerStatuses KubeContainerStatus []
    hostIP string
    message string
    phase string
    qosClass string
    reason string
    startTime number

    Defined in

    lib/k8s/pod.ts:41

    Methods

    exec

    ▸ exec(container, onExec, options?): Object

    Parameters

    Name Type
    container string
    onExec StreamResultsCb
    options ExecOptions

    Returns

    Object

    Name Type
    cancel () => void
    getSocket () => null | WebSocket

    Defined in

    lib/k8s/pod.ts:68

    getLogs

    ▸ getLogs(container, tailLines, showPrevious, onLogs): () => void

    Parameters

    Name Type
    container string
    tailLines number
    showPrevious boolean
    onLogs StreamResultsCb

    Returns

    fn

    ▸ (): void

    Returns

    void

    Defined in

    lib/k8s/pod.ts:45

    apiList

    ▸ Static apiList(onList): any

    Parameters

    Name Type
    onList (arg: any[]) => void

    Returns

    any

    Inherited from

    makeKubeObject<KubePod>(‘Pod’).apiList

    Defined in

    lib/k8s/cluster.ts:60

    getErrorMessage

    ▸ Static getErrorMessage(err?): null | string

    Parameters

    Name Type
    err? null | ApiError

    Returns

    null | string

    Inherited from

    makeKubeObject<KubePod>(‘Pod’).getErrorMessage

    Defined in

    lib/k8s/cluster.ts:75

    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<KubePod>(‘Pod’).useApiGet

    Defined in

    lib/k8s/cluster.ts:66

    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<KubePod>(‘Pod’).useApiList

    Defined in

    lib/k8s/cluster.ts:61

    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<KubePod>(‘Pod’).useList

    Defined in

    lib/k8s/cluster.ts:72

    Edit this page File documentation issue