Class: CronJob#
Hierarchy#
↳ CronJob
Implements#
- ItemObject
Index#
Constructors#
Properties#
Accessors#
Methods#
- delete
- getAge
- getAnnotations
- getFinalizers
- getId
- getLabels
- getLastScheduleTime
- getName
- getNs
- getOwnerRefs
- getResourceVersion
- getSchedule
- getSearchFields
- getSuspendFlag
- getTimeDiffFromNow
- isNeverRun
- isSuspend
- toPlainObject
- update
- create
- isJsonApiData
- isJsonApiDataList
- isKubeJsonApiListMetadata
- isKubeJsonApiMetadata
- isNonSystem
- isPartialJsonApiData
- stringifyLabels
Constructors#
constructor#
+ new CronJob(data
: KubeJsonApiData): CronJob
Inherited from KubeObject.constructor
Defined in src/renderer/api/kube-object.ts:138
Parameters:
Name | Type |
---|---|
data |
KubeJsonApiData |
Returns: CronJob
Properties#
apiVersion#
• apiVersion: string
Overrides KubeObject.apiVersion
Defined in src/renderer/api/endpoints/cron-job.api.ts:47
kind#
• kind: string
Overrides KubeObject.kind
Defined in src/renderer/api/endpoints/cron-job.api.ts:46
metadata#
• metadata: object
Overrides KubeObject.metadata
Defined in src/renderer/api/endpoints/cron-job.api.ts:48
Type declaration:#
-
annotations(): object
-
creationTimestamp: string
-
labels(): object
-
name: string
-
namespace: string
-
resourceVersion: string
-
selfLink: string
-
uid: string
spec#
• spec: object
Defined in src/renderer/api/endpoints/cron-job.api.ts:62
Type declaration:#
-
concurrencyPolicy: string
-
failedJobsHistoryLimit: number
-
jobTemplate(): object
-
metadata(): object
-
annotations(): object
-
creationTimestamp? : string
-
labels(): object
-
-
spec(): object
-
template(): object
-
metadata(): object
- creationTimestamp? : string
-
spec(): object
-
containers: IPodContainer[]
-
dnsPolicy: string
-
hostPID: boolean
-
restartPolicy: string
-
schedulerName: string
-
terminationGracePeriodSeconds: number
-
-
-
schedule: string
-
successfulJobsHistoryLimit: number
-
suspend: boolean
status#
• status: object
Overrides KubeObject.status
Defined in src/renderer/api/endpoints/cron-job.api.ts:95
Type declaration:#
- lastScheduleTime? : string
Static
apiBase#
▪ apiBase: string = "/apis/batch/v1beta1/cronjobs"
Defined in src/renderer/api/endpoints/cron-job.api.ts:44
Static
kind#
▪ kind: string = "CronJob"
Overrides KubeObject.kind
Defined in src/renderer/api/endpoints/cron-job.api.ts:42
Static
namespaced#
▪ namespaced: boolean = true
Overrides KubeObject.namespaced
Defined in src/renderer/api/endpoints/cron-job.api.ts:43
Accessors#
selfLink#
• get selfLink(): string
Inherited from KubeObject.selfLink
Defined in src/renderer/api/kube-object.ts:149
Returns: string
Methods#
delete#
▸ delete(params?
: JsonApiParams): Promise‹KubeJsonApiData›
Inherited from KubeObject.delete
Defined in src/renderer/api/kube-object.ts:238
Parameters:
Name | Type |
---|---|
params? |
JsonApiParams |
Returns: Promise‹KubeJsonApiData›
getAge#
▸ getAge(humanize
: boolean, compact
: boolean, fromNow
: boolean): string | number
Inherited from KubeObject.getAge
Defined in src/renderer/api/kube-object.ts:174
Parameters:
Name | Type | Default |
---|---|---|
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:195
Parameters:
Name | Type | Default |
---|---|---|
filter |
boolean | false |
Returns: string[]
getFinalizers#
▸ getFinalizers(): string[]
Inherited from KubeObject.getFinalizers
Defined in src/renderer/api/kube-object.ts:187
Returns: string[]
getId#
▸ getId(): string
Inherited from KubeObject.getId
Defined in src/renderer/api/kube-object.ts:153
Returns: string
getLabels#
▸ getLabels(): string[]
Inherited from KubeObject.getLabels
Defined in src/renderer/api/kube-object.ts:191
Returns: string[]
getLastScheduleTime#
▸ getLastScheduleTime(): string
Defined in src/renderer/api/endpoints/cron-job.api.ts:103
Returns: string
getName#
▸ getName(): string
Inherited from KubeObject.getName
Defined in src/renderer/api/kube-object.ts:161
Returns: string
getNs#
▸ getNs(): string
Inherited from KubeObject.getNs
Defined in src/renderer/api/kube-object.ts:165
Returns: string
getOwnerRefs#
▸ getOwnerRefs(): object[]
Inherited from KubeObject.getOwnerRefs
Defined in src/renderer/api/kube-object.ts:205
Returns: object[]
getResourceVersion#
▸ getResourceVersion(): string
Inherited from KubeObject.getResourceVersion
Defined in src/renderer/api/kube-object.ts:157
Returns: string
getSchedule#
▸ getSchedule(): string
Defined in src/renderer/api/endpoints/cron-job.api.ts:110
Returns: string
getSearchFields#
▸ getSearchFields(): string[]
Inherited from KubeObject.getSearchFields
Defined in src/renderer/api/kube-object.ts:214
Returns: string[]
getSuspendFlag#
▸ getSuspendFlag(): string
Defined in src/renderer/api/endpoints/cron-job.api.ts:99
Returns: string
getTimeDiffFromNow#
▸ getTimeDiffFromNow(): number
Inherited from KubeObject.getTimeDiffFromNow
Defined in src/renderer/api/kube-object.ts:170
Returns: number
isNeverRun#
▸ isNeverRun(): boolean
Defined in src/renderer/api/endpoints/cron-job.api.ts:114
Returns: boolean
isSuspend#
▸ isSuspend(): boolean
Defined in src/renderer/api/endpoints/cron-job.api.ts:126
Returns: boolean
toPlainObject#
▸ toPlainObject(): object
Inherited from KubeObject.toPlainObject
Defined in src/renderer/api/kube-object.ts:226
Returns: object
update#
▸ update‹T›(data
: Partial‹T›): Promise‹T›
Inherited from KubeObject.update
Defined in src/renderer/api/kube-object.ts:231
Type parameters:
▪ T: KubeObject
Parameters:
Name | Type |
---|---|
data |
Partial‹T› |
Returns: Promise‹T›
Static
create#
▸ create(data
: any): KubeObject‹›
Inherited from KubeObject.create
Defined in src/renderer/api/kube-object.ts:74
Parameters:
Name | Type |
---|---|
data |
any |
Returns: KubeObject‹›
Static
isJsonApiData#
▸ isJsonApiData(object
: unknown): object is KubeJsonApiData
Inherited from KubeObject.isJsonApiData
Defined in src/renderer/api/kube-object.ts:82
Parameters:
Name | Type |
---|---|
object |
unknown |
Returns: object is KubeJsonApiData
Static
isJsonApiDataList#
▸ isJsonApiDataList‹T›(object
: unknown, verifyItem
: function): object is KubeJsonApiDataList‹T›
Inherited from KubeObject.isJsonApiDataList
Defined in src/renderer/api/kube-object.ts:124
Type parameters:
▪ T
Parameters:
▪ object: unknown
▪ verifyItem: function
▸ (val
: unknown): val is T
Parameters:
Name | Type |
---|---|
val |
unknown |
Returns: object is KubeJsonApiDataList‹T›
Static
isKubeJsonApiListMetadata#
▸ isKubeJsonApiListMetadata(object
: unknown): object is KubeJsonApiListMetadata
Inherited from KubeObject.isKubeJsonApiListMetadata
Defined in src/renderer/api/kube-object.ts:91
Parameters:
Name | Type |
---|---|
object |
unknown |
Returns: object is KubeJsonApiListMetadata
Static
isKubeJsonApiMetadata#
▸ isKubeJsonApiMetadata(object
: unknown): object is KubeJsonApiMetadata
Inherited from KubeObject.isKubeJsonApiMetadata
Defined in src/renderer/api/kube-object.ts:99
Parameters:
Name | Type |
---|---|
object |
unknown |
Returns: object is KubeJsonApiMetadata
Static
isNonSystem#
▸ isNonSystem(item
: KubeJsonApiData | KubeObject): boolean
Inherited from KubeObject.isNonSystem
Defined in src/renderer/api/kube-object.ts:78
Parameters:
Name | Type |
---|---|
item |
KubeJsonApiData | KubeObject |
Returns: boolean
Static
isPartialJsonApiData#
▸ isPartialJsonApiData(object
: unknown): object is Partial‹KubeJsonApiData›
Inherited from KubeObject.isPartialJsonApiData
Defined in src/renderer/api/kube-object.ts:115
Parameters:
Name | Type |
---|---|
object |
unknown |
Returns: object is Partial‹KubeJsonApiData›
Static
stringifyLabels#
▸ stringifyLabels(labels?
: object): string[]
Inherited from KubeObject.stringifyLabels
Defined in src/renderer/api/kube-object.ts:134
Parameters:
Name | Type |
---|---|
labels? |
object |
Returns: string[]