Class: Job

    lib/k8s/job .Job

    Hierarchy

    • any

      Job

    Constructors

    constructor

    new Job(json)

    Parameters

    Name Type
    json KubeJob

    Inherited from

    makeKubeObject<KubeJob>(‘Job’).constructor

    Defined in

    lib/k8s/cluster.ts:301

    Properties

    apiEndpoint

    Static apiEndpoint: Object

    Index signature

    ▪ [other: string]: any

    Type declaration

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

    Defined in

    lib/k8s/job.ts:26


    className

    Static className: string

    Inherited from

    makeKubeObject<KubeJob>(‘Job’).className

    Defined in

    lib/k8s/cluster.ts:302

    Accessors

    spec

    get spec(): any

    Returns

    any

    Defined in

    lib/k8s/job.ts:28


    status

    get status(): any

    Returns

    any

    Defined in

    lib/k8s/job.ts:32

    Methods

    getContainers

    getContainers(): KubeContainer []

    Returns

    KubeContainer []

    Defined in

    lib/k8s/job.ts:36


    getDuration

    getDuration(): number

    Returns the duration of the job in milliseconds.

    Returns

    number

    Defined in

    lib/k8s/job.ts:41


    apiList

    Static apiList(onList): any

    Parameters

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

    Returns

    any

    Inherited from

    makeKubeObject<KubeJob>(‘Job’).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<KubeJob>(‘Job’).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<KubeJob>(‘Job’).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<KubeJob>(‘Job’).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<KubeJob>(‘Job’).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<KubeJob>(‘Job’).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<KubeJob>(‘Job’).useList

    Defined in

    lib/k8s/cluster.ts:293