Class: Pod#
Hierarchy#
- WorkloadKubeObject
↳ Pod
Implements#
- ItemObject
Index#
Constructors#
Properties#
Accessors#
Methods#
- delete
- getAffinity
- getAffinityNumber
- getAge
- getAllContainers
- getAnnotations
- getConditions
- getContainerStatuses
- getContainers
- getFinalizers
- getId
- getInitContainers
- getLabels
- getLivenessProbe
- getName
- getNodeName
- getNodeSelectors
- getNs
- getOwnerRefs
- getPriorityClassName
- getProbe
- getQosClass
- getReadinessProbe
- getReason
- getResourceVersion
- getRestartsCount
- getRunningContainers
- getSearchFields
- getSecrets
- getSelectedNodeOs
- getSelectors
- getStartupProbe
- getStatus
- getStatusMessage
- getStatusPhase
- getTemplateLabels
- getTolerations
- getVolumes
- hasIssues
- toPlainObject
- update
- create
- isJsonApiData
- isJsonApiDataList
- isNonSystem
- stringifyLabels
Constructors#
constructor#
+ new Pod(data
: KubeJsonApiData): Pod
Inherited from KubeObject.constructor
Defined in src/renderer/api/kube-object.ts:93
Parameters:
Name | Type |
---|---|
data |
KubeJsonApiData |
Returns: Pod
Properties#
apiVersion#
• apiVersion: string
Inherited from KubeObject.apiVersion
Defined in src/renderer/api/kube-object.ts:99
kind#
• kind: string
Inherited from KubeObject.kind
Defined in src/renderer/api/kube-object.ts:100
metadata#
• metadata: IKubeObjectMetadata
Inherited from KubeObject.metadata
Defined in src/renderer/api/kube-object.ts:101
spec#
• spec: object
Overrides void
Defined in src/renderer/api/endpoints/pods.api.ts:190
Type declaration:#
-
activeDeadlineSeconds? : number
-
affinity? : IAffinity
-
automountServiceAccountToken? : boolean
-
containers: IPodContainer[]
-
dnsPolicy? : string
-
hostAliases(): object
-
hostnames: string[]
-
ip: string
-
hostIPC? : boolean
-
hostNetwork? : boolean
-
hostPID? : boolean
-
hostname? : string
-
imagePullSecrets? : object[]
-
initContainers: IPodContainer[]
-
nodeName? : string
-
nodeSelector(): object
-
priority? : number
-
priorityClassName? : string
-
restartPolicy? : string
-
schedulerName? : string
-
securityContext(): object
-
serviceAccount: string
-
serviceAccountName: string
-
shareProcessNamespace? : boolean
-
subdomain? : string
-
terminationGracePeriodSeconds? : number
-
tolerations? : object[]
-
volumes? : object[]
Optional
status#
• status? : object
Overrides KubeObject.status
Defined in src/renderer/api/endpoints/pods.api.ts:247
Type declaration:#
-
conditions: object[]
-
containerStatuses? : IPodContainerStatus[]
-
hostIP: string
-
initContainerStatuses? : IPodContainerStatus[]
-
phase: string
-
podIP: string
-
qosClass? : string
-
reason? : string
-
startTime: string
Static
apiBase#
▪ apiBase: string = "/api/v1/pods"
Defined in src/renderer/api/endpoints/pods.api.ts:188
Static
kind#
▪ kind: string = "Pod"
Overrides KubeObject.kind
Defined in src/renderer/api/endpoints/pods.api.ts:186
Static
namespaced#
▪ namespaced: boolean = true
Overrides KubeObject.namespaced
Defined in src/renderer/api/endpoints/pods.api.ts:187
Accessors#
selfLink#
• get selfLink(): string
Inherited from KubeObject.selfLink
Defined in src/renderer/api/kube-object.ts:104
Returns: string
Methods#
delete#
▸ delete(params?
: JsonApiParams): CancelablePromise‹KubeJsonApiData›
Inherited from KubeObject.delete
Defined in src/renderer/api/kube-object.ts:190
Parameters:
Name | Type |
---|---|
params? |
JsonApiParams |
Returns: CancelablePromise‹KubeJsonApiData›
getAffinity#
▸ getAffinity(): IAffinity
Overrides Deployment.getAffinity
Defined in src/renderer/api/endpoints/pods.api.ts:407
Returns: IAffinity
getAffinityNumber#
▸ getAffinityNumber(): number
Inherited from Pod.getAffinityNumber
Defined in src/renderer/api/workload-kube-object.ts:78
Returns: number
getAge#
▸ getAge(humanize
: boolean, compact
: boolean, fromNow
: boolean): string | number
Inherited from KubeObject.getAge
Defined in src/renderer/api/kube-object.ts:126
Parameters:
Name | Type | Default |
---|---|---|
humanize |
boolean | true |
compact |
boolean | true |
fromNow |
boolean | false |
Returns: string | number
getAllContainers#
▸ getAllContainers(): IPodContainer[]
Defined in src/renderer/api/endpoints/pods.api.ts:272
Returns: IPodContainer[]
getAnnotations#
▸ getAnnotations(filter
: boolean): string[]
Inherited from KubeObject.getAnnotations
Defined in src/renderer/api/kube-object.ts:147
Parameters:
Name | Type | Default |
---|---|---|
filter |
boolean | false |
Returns: string[]
getConditions#
▸ getConditions(): object[]
Defined in src/renderer/api/endpoints/pods.api.ts:381
Returns: object[]
getContainerStatuses#
▸ getContainerStatuses(includeInitContainers
: boolean): IPodContainerStatus[]
Defined in src/renderer/api/endpoints/pods.api.ts:285
Parameters:
Name | Type | Default |
---|---|---|
includeInitContainers |
boolean | true |
Returns: IPodContainerStatus[]
getContainers#
▸ getContainers(): IPodContainer[]
Defined in src/renderer/api/endpoints/pods.api.ts:268
Returns: IPodContainer[]
getFinalizers#
▸ getFinalizers(): string[]
Inherited from KubeObject.getFinalizers
Defined in src/renderer/api/kube-object.ts:139
Returns: string[]
getId#
▸ getId(): string
Inherited from KubeObject.getId
Defined in src/renderer/api/kube-object.ts:108
Returns: string
getInitContainers#
▸ getInitContainers(): IPodContainer[]
Defined in src/renderer/api/endpoints/pods.api.ts:264
Returns: IPodContainer[]
getLabels#
▸ getLabels(): string[]
Inherited from KubeObject.getLabels
Defined in src/renderer/api/kube-object.ts:143
Returns: string[]
getLivenessProbe#
▸ getLivenessProbe(container
: IPodContainer): string[]
Defined in src/renderer/api/endpoints/pods.api.ts:428
Parameters:
Name | Type |
---|---|
container |
IPodContainer |
Returns: string[]
getName#
▸ getName(): string
Inherited from KubeObject.getName
Defined in src/renderer/api/kube-object.ts:116
Returns: string
getNodeName#
▸ getNodeName(): string
Defined in src/renderer/api/endpoints/pods.api.ts:478
Returns: string
getNodeSelectors#
▸ getNodeSelectors(): string[]
Overrides Deployment.getNodeSelectors
Defined in src/renderer/api/endpoints/pods.api.ts:395
Returns: string[]
getNs#
▸ getNs(): string
Inherited from KubeObject.getNs
Defined in src/renderer/api/kube-object.ts:120
Returns: string
getOwnerRefs#
▸ getOwnerRefs(): object[]
Inherited from KubeObject.getOwnerRefs
Defined in src/renderer/api/kube-object.ts:157
Returns: object[]
getPriorityClassName#
▸ getPriorityClassName(): string
Defined in src/renderer/api/endpoints/pods.api.ts:316
Returns: string
getProbe#
▸ getProbe(probeData
: IContainerProbe): string[]
Defined in src/renderer/api/endpoints/pods.api.ts:440
Parameters:
Name | Type |
---|---|
probeData |
IContainerProbe |
Returns: string[]
getQosClass#
▸ getQosClass(): string
Defined in src/renderer/api/endpoints/pods.api.ts:308
Returns: string
getReadinessProbe#
▸ getReadinessProbe(container
: IPodContainer): string[]
Defined in src/renderer/api/endpoints/pods.api.ts:432
Parameters:
Name | Type |
---|---|
container |
IPodContainer |
Returns: string[]
getReason#
▸ getReason(): string
Defined in src/renderer/api/endpoints/pods.api.ts:312
Returns: string
getResourceVersion#
▸ getResourceVersion(): string
Inherited from KubeObject.getResourceVersion
Defined in src/renderer/api/kube-object.ts:112
Returns: string
getRestartsCount#
▸ getRestartsCount(): number
Defined in src/renderer/api/endpoints/pods.api.ts:300
Returns: number
getRunningContainers#
▸ getRunningContainers(): IPodContainer[]
Defined in src/renderer/api/endpoints/pods.api.ts:276
Returns: IPodContainer[]
getSearchFields#
▸ getSearchFields(): string[]
Inherited from KubeObject.getSearchFields
Defined in src/renderer/api/kube-object.ts:166
Returns: string[]
getSecrets#
▸ getSecrets(): string[]
Defined in src/renderer/api/endpoints/pods.api.ts:389
Returns: string[]
getSelectedNodeOs#
▸ getSelectedNodeOs(): string
Defined in src/renderer/api/endpoints/pods.api.ts:482
Returns: string
getSelectors#
▸ getSelectors(): string[]
Inherited from Pod.getSelectors
Defined in src/renderer/api/workload-kube-object.ts:52
Returns: string[]
getStartupProbe#
▸ getStartupProbe(container
: IPodContainer): string[]
Defined in src/renderer/api/endpoints/pods.api.ts:436
Parameters:
Name | Type |
---|---|
container |
IPodContainer |
Returns: string[]
getStatus#
▸ getStatus(): FAILED | PENDING | RUNNING | SUCCEEDED | EVICTED
Defined in src/renderer/api/endpoints/pods.api.ts:321
Returns: FAILED | PENDING | RUNNING | SUCCEEDED | EVICTED
getStatusMessage#
▸ getStatusMessage(): string
Defined in src/renderer/api/endpoints/pods.api.ts:348
Returns: string
getStatusPhase#
▸ getStatusPhase(): string
Defined in src/renderer/api/endpoints/pods.api.ts:377
Returns: string
getTemplateLabels#
▸ getTemplateLabels(): string[]
Inherited from Pod.getTemplateLabels
Defined in src/renderer/api/workload-kube-object.ts:64
Returns: string[]
getTolerations#
▸ getTolerations(): object[]
Overrides Deployment.getTolerations
Defined in src/renderer/api/endpoints/pods.api.ts:403
Returns: object[]
getVolumes#
▸ getVolumes(): object[]
Defined in src/renderer/api/endpoints/pods.api.ts:385
Returns: object[]
hasIssues#
▸ hasIssues(): boolean
Defined in src/renderer/api/endpoints/pods.api.ts:411
Returns: boolean
toPlainObject#
▸ toPlainObject(): object
Inherited from KubeObject.toPlainObject
Defined in src/renderer/api/kube-object.ts:178
Returns: object
update#
▸ update‹T›(data
: Partial‹T›): Promise‹T›
Inherited from KubeObject.update
Defined in src/renderer/api/kube-object.ts:183
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:73
Parameters:
Name | Type |
---|---|
data |
any |
Returns: KubeObject‹›
Static
isJsonApiData#
▸ isJsonApiData(object
: any): object is KubeJsonApiData
Inherited from KubeObject.isJsonApiData
Defined in src/renderer/api/kube-object.ts:81
Parameters:
Name | Type |
---|---|
object |
any |
Returns: object is KubeJsonApiData
Static
isJsonApiDataList#
▸ isJsonApiDataList(object
: any): object is KubeJsonApiDataList
Inherited from KubeObject.isJsonApiDataList
Defined in src/renderer/api/kube-object.ts:85
Parameters:
Name | Type |
---|---|
object |
any |
Returns: object is KubeJsonApiDataList
Static
isNonSystem#
▸ isNonSystem(item
: KubeJsonApiData | KubeObject): boolean
Inherited from KubeObject.isNonSystem
Defined in src/renderer/api/kube-object.ts:77
Parameters:
Name | Type |
---|---|
item |
KubeJsonApiData | KubeObject |
Returns: boolean
Static
stringifyLabels#
▸ stringifyLabels(labels
: object): string[]
Inherited from KubeObject.stringifyLabels
Defined in src/renderer/api/kube-object.ts:89
Parameters:
Name | Type |
---|---|
labels |
object |
Returns: string[]