Skip to content

Class: Pod#

Hierarchy#

  • WorkloadKubeObject

↳ Pod

Implements#

  • ItemObject

Index#

Constructors#

Properties#

Accessors#

Methods#

Constructors#

constructor#

+ new Pod(data: KubeJsonApiData): Pod

Inherited from KubeObject.constructor

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

Parameters:

Name Type
data KubeJsonApiData

Returns: Pod

Properties#

apiVersion#

• apiVersion: string

Inherited from KubeObject.apiVersion

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

kind#

• kind: string

Inherited from KubeObject.kind

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

metadata#

• metadata: IKubeObjectMetadata

Inherited from KubeObject.metadata

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

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#

• 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›

getAffinity#

▸ getAffinity(): IAffinity

Overrides Deployment.getAffinity

Defined in src/renderer/api/endpoints/pods.api.ts:390

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:174

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:195

Parameters:

Name Type Default
filter boolean false

Returns: string[]

getConditions#

▸ getConditions(): object[]

Defined in src/renderer/api/endpoints/pods.api.ts:366

Returns: object[]

getContainerStatuses#

▸ getContainerStatuses(includeInitContainers: boolean): IPodContainerStatus[]

Defined in src/renderer/api/endpoints/pods.api.ts:287

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:187

Returns: string[]

getId#

▸ getId(): string

Inherited from KubeObject.getId

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

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:191

Returns: string[]

getLivenessProbe#

▸ getLivenessProbe(container: IPodContainer): string[]

Defined in src/renderer/api/endpoints/pods.api.ts:410

Parameters:

Name Type
container IPodContainer

Returns: string[]

getName#

▸ getName(): string

Inherited from KubeObject.getName

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

Returns: string

getNodeName#

▸ getNodeName(): string

Defined in src/renderer/api/endpoints/pods.api.ts:460

Returns: string

getNodeSelectors#

▸ getNodeSelectors(): string[]

Overrides Deployment.getNodeSelectors

Defined in src/renderer/api/endpoints/pods.api.ts:380

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[]

getPriorityClassName#

▸ getPriorityClassName(): string

Defined in src/renderer/api/endpoints/pods.api.ts:311

Returns: string

getProbe#

▸ getProbe(probeData: IContainerProbe): string[]

Defined in src/renderer/api/endpoints/pods.api.ts:422

Parameters:

Name Type
probeData IContainerProbe

Returns: string[]

getQosClass#

▸ getQosClass(): string

Defined in src/renderer/api/endpoints/pods.api.ts:303

Returns: string

getReadinessProbe#

▸ getReadinessProbe(container: IPodContainer): string[]

Defined in src/renderer/api/endpoints/pods.api.ts:414

Parameters:

Name Type
container IPodContainer

Returns: string[]

getReason#

▸ getReason(): string

Defined in src/renderer/api/endpoints/pods.api.ts:307

Returns: string

getResourceVersion#

▸ getResourceVersion(): string

Inherited from KubeObject.getResourceVersion

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

Returns: string

getRestartsCount#

▸ getRestartsCount(): number

Defined in src/renderer/api/endpoints/pods.api.ts:297

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:214

Returns: string[]

getSecrets#

▸ getSecrets(): string[]

Defined in src/renderer/api/endpoints/pods.api.ts:374

Returns: string[]

getSelectedNodeOs#

▸ getSelectedNodeOs(): string | undefined

Defined in src/renderer/api/endpoints/pods.api.ts:464

Returns: string | undefined

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:418

Parameters:

Name Type
container IPodContainer

Returns: string[]

getStatus#

▸ getStatus(): PodStatus

Defined in src/renderer/api/endpoints/pods.api.ts:315

Returns: PodStatus

getStatusMessage#

▸ getStatusMessage(): string

Defined in src/renderer/api/endpoints/pods.api.ts:343

Returns: string

getStatusPhase#

▸ getStatusPhase(): string

Defined in src/renderer/api/endpoints/pods.api.ts:362

Returns: string

getTemplateLabels#

▸ getTemplateLabels(): string[]

Inherited from Pod.getTemplateLabels

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

Returns: string[]

getTimeDiffFromNow#

▸ getTimeDiffFromNow(): number

Inherited from KubeObject.getTimeDiffFromNow

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

Returns: number

getTolerations#

▸ getTolerations(): object[]

Overrides Deployment.getTolerations

Defined in src/renderer/api/endpoints/pods.api.ts:386

Returns: object[]

getVolumes#

▸ getVolumes(): object[]

Defined in src/renderer/api/endpoints/pods.api.ts:370

Returns: object[]

hasIssues#

▸ hasIssues(): boolean

Defined in src/renderer/api/endpoints/pods.api.ts:394

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[]