Skip to content

@k8slens/extensions

Globals / "src/renderer/api/endpoints/job.api" / Job

Class: Job#

Hierarchy#

↳ Job

Implements#

Index#

Constructors#

Properties#

Accessors#

Methods#

Constructors#

constructor#

+ new Job(data: KubeJsonApiData): Job

Inherited from KubeObject.constructor

Defined in src/renderer/api/kube-object.ts:69

Parameters:

Name Type
data KubeJsonApiData

Returns: Job

Properties#

apiVersion#

• apiVersion: string

Inherited from KubeObject.apiVersion

Defined in src/renderer/api/kube-object.ts:75

kind#

• kind: string

Inherited from KubeObject.kind

Defined in src/renderer/api/kube-object.ts:76

metadata#

• metadata: IKubeObjectMetadata

Inherited from KubeObject.metadata

Defined in src/renderer/api/kube-object.ts:77

spec#

• spec: { backoffLimit?: number ; completions?: number ; containers?: IPodContainer[] ; dnsPolicy?: string ; parallelism?: number ; restartPolicy?: string ; schedulerName?: string ; selector?: { matchLabels: { [name:string]: string; } } ; serviceAccount?: string ; serviceAccountName?: string ; template: { metadata: { annotations?: { [name:string]: string; } ; creationTimestamp?: string ; labels?: { [name:string]: string; } } ; spec: { affinity?: IAffinity ; containers: IPodContainer[] ; dnsPolicy: string ; hostPID: boolean ; nodeSelector?: { [selector:string]: string; } ; restartPolicy: string ; schedulerName: string ; terminationGracePeriodSeconds: number ; tolerations?: { effect: string ; key: string ; operator: string ; tolerationSeconds: number }[] } } ; terminationGracePeriodSeconds?: number }

Overrides WorkloadKubeObject.spec

Defined in src/renderer/api/endpoints/job.api.ts:14

Type declaration:

Name Type
backoffLimit? number
completions? number
containers? IPodContainer[]
dnsPolicy? string
parallelism? number
restartPolicy? string
schedulerName? string
selector? { matchLabels: { [name:string]: string; } }
serviceAccount? string
serviceAccountName? string
template { metadata: { annotations?: { [name:string]: string; } ; creationTimestamp?: string ; labels?: { [name:string]: string; } } ; spec: { affinity?: IAffinity ; containers: IPodContainer[] ; dnsPolicy: string ; hostPID: boolean ; nodeSelector?: { [selector:string]: string; } ; restartPolicy: string ; schedulerName: string ; terminationGracePeriodSeconds: number ; tolerations?: { effect: string ; key: string ; operator: string ; tolerationSeconds: number }[] } }
terminationGracePeriodSeconds? number

status#

• status: { completionTime: string ; conditions: { lastProbeTime: string ; lastTransitionTime: string ; message?: string ; status: string ; type: string }[] ; startTime: string ; succeeded: number }

Overrides KubeObject.status

Defined in src/renderer/api/endpoints/job.api.ts:60

Type declaration:

Name Type
completionTime string
conditions { lastProbeTime: string ; lastTransitionTime: string ; message?: string ; status: string ; type: string }[]
startTime string
succeeded number

apiBase#

▪ Static apiBase: string = "/apis/batch/v1/jobs"

Defined in src/renderer/api/endpoints/job.api.ts:12

kind#

▪ Static kind: string = "Job"

Overrides KubeObject.kind

Defined in src/renderer/api/endpoints/job.api.ts:10

namespaced#

▪ Static namespaced: boolean = true

Overrides KubeObject.namespaced

Defined in src/renderer/api/endpoints/job.api.ts:11

Accessors#

• get selfLink(): string

Inherited from KubeObject.selfLink

Defined in src/renderer/api/kube-object.ts:80

Returns: string

Methods#

delete#

▸ delete(): CancelablePromise\<KubeJsonApiData>

Overrides KubeObject.delete

Defined in src/renderer/api/endpoints/job.api.ts:98

Returns: CancelablePromise\<KubeJsonApiData>

getAffinity#

▸ getAffinity(): IAffinity

Inherited from WorkloadKubeObject.getAffinity

Defined in src/renderer/api/workload-kube-object.ts:71

Returns: IAffinity

getAffinityNumber#

▸ getAffinityNumber(): number

Inherited from WorkloadKubeObject.getAffinityNumber

Defined in src/renderer/api/workload-kube-object.ts:75

Returns: number

getAge#

▸ getAge(humanize?: boolean, compact?: boolean, fromNow?: boolean): string | number

Inherited from KubeObject.getAge

Defined in src/renderer/api/kube-object.ts:102

Parameters:

Name Type Default value
humanize boolean true
compact boolean true
fromNow boolean false

Returns: string | number

getAnnotations#

▸ getAnnotations(filter?: boolean): string[]

Inherited from KubeObject.getAnnotations

Defined in src/renderer/api/kube-object.ts:121

Parameters:

Name Type Default value
filter boolean false

Returns: string[]

getCompletions#

▸ getCompletions(): number

Defined in src/renderer/api/endpoints/job.api.ts:77

Returns: number

getCondition#

▸ getCondition(): object

Defined in src/renderer/api/endpoints/job.api.ts:85

Returns: object

Name Type
lastProbeTime string
lastTransitionTime string
message? string
status string
type string

getDesiredCompletions#

▸ getDesiredCompletions(): number

Defined in src/renderer/api/endpoints/job.api.ts:73

Returns: number

getFinalizers#

▸ getFinalizers(): string[]

Inherited from KubeObject.getFinalizers

Defined in src/renderer/api/kube-object.ts:113

Returns: string[]

getId#

▸ getId(): string

Implementation of ItemObject

Inherited from KubeObject.getId

Defined in src/renderer/api/kube-object.ts:84

Returns: string

getImages#

▸ getImages(): string[]

Defined in src/renderer/api/endpoints/job.api.ts:93

Returns: string[]

getLabels#

▸ getLabels(): string[]

Inherited from KubeObject.getLabels

Defined in src/renderer/api/kube-object.ts:117

Returns: string[]

getName#

▸ getName(): string

Implementation of ItemObject

Inherited from KubeObject.getName

Defined in src/renderer/api/kube-object.ts:92

Returns: string

getNodeSelectors#

▸ getNodeSelectors(): string[]

Inherited from WorkloadKubeObject.getNodeSelectors

Defined in src/renderer/api/workload-kube-object.ts:57

Returns: string[]

getNs#

▸ getNs(): string

Inherited from KubeObject.getNs

Defined in src/renderer/api/kube-object.ts:96

Returns: string

getOwnerRefs#

▸ getOwnerRefs(): { namespace: string = this.getNs() }[]

Inherited from KubeObject.getOwnerRefs

Defined in src/renderer/api/kube-object.ts:129

Returns: { namespace: string = this.getNs() }[]

getParallelism#

▸ getParallelism(): number

Defined in src/renderer/api/endpoints/job.api.ts:81

Returns: number

getResourceVersion#

▸ getResourceVersion(): string

Inherited from KubeObject.getResourceVersion

Defined in src/renderer/api/kube-object.ts:88

Returns: string

getSearchFields#

▸ getSearchFields(): string[]

Inherited from KubeObject.getSearchFields

Defined in src/renderer/api/kube-object.ts:137

Returns: string[]

getSelectors#

▸ getSelectors(): string[]

Inherited from WorkloadKubeObject.getSelectors

Defined in src/renderer/api/workload-kube-object.ts:52

Returns: string[]

getTemplateLabels#

▸ getTemplateLabels(): string[]

Inherited from WorkloadKubeObject.getTemplateLabels

Defined in src/renderer/api/workload-kube-object.ts:62

Returns: string[]

getTolerations#

▸ getTolerations(): IToleration[]

Inherited from WorkloadKubeObject.getTolerations

Defined in src/renderer/api/workload-kube-object.ts:67

Returns: IToleration[]

toPlainObject#

▸ toPlainObject(): object

Inherited from KubeObject.toPlainObject

Defined in src/renderer/api/kube-object.ts:148

Returns: object

update#

▸ update\(data: Partial\): Promise\

Inherited from KubeObject.update

Defined in src/renderer/api/kube-object.ts:153

Type parameters:

Name Type
T KubeObject

Parameters:

Name Type
data Partial\

Returns: Promise\

create#

▸ Staticcreate(data: any): KubeObject

Inherited from KubeObject.create

Defined in src/renderer/api/kube-object.ts:50

Parameters:

Name Type
data any

Returns: KubeObject

isJsonApiData#

▸ StaticisJsonApiData(object: any): object is KubeJsonApiData

Inherited from KubeObject.isJsonApiData

Defined in src/renderer/api/kube-object.ts:58

Parameters:

Name Type
object any

Returns: object is KubeJsonApiData

isJsonApiDataList#

▸ StaticisJsonApiDataList(object: any): object is KubeJsonApiDataList

Inherited from KubeObject.isJsonApiDataList

Defined in src/renderer/api/kube-object.ts:62

Parameters:

Name Type
object any

Returns: object is KubeJsonApiDataList

isNonSystem#

▸ StaticisNonSystem(item: KubeJsonApiData | KubeObject): boolean

Inherited from KubeObject.isNonSystem

Defined in src/renderer/api/kube-object.ts:54

Parameters:

Name Type
item KubeJsonApiData | KubeObject

Returns: boolean

stringifyLabels#

▸ StaticstringifyLabels(labels: { [name:string]: string; }): string[]

Inherited from KubeObject.stringifyLabels

Defined in src/renderer/api/kube-object.ts:66

Parameters:

Name Type
labels { [name:string]: string; }

Returns: string[]

Last update: November 10, 2020