Skip to content

Class: Pod ‹Metadata, Status, Spec›#

Type parameters#

▪ Metadata: IKubeObjectMetadata

▪ Status

▪ Spec

Hierarchy#

  • WorkloadKubeObject

↳ Pod

Implements#

  • ItemObject

Index#

Constructors#

Properties#

Accessors#

Methods#

Constructors#

constructor#

+ new Pod(data: KubeJsonApiData): Pod

Overrides KubeObject.constructor

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

Parameters:

Name Type
data KubeJsonApiData

Returns: Pod

Properties#

apiVersion#

• apiVersion: string

Inherited from KubeObject.apiVersion

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


kind#

• kind: string

Inherited from KubeObject.kind

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


metadata#

• metadata: Metadata

Inherited from KubeObject.metadata

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


spec#

• spec: object

Overrides KubeObject.spec

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

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

Type declaration:#

  • conditions: object[]

  • containerStatuses? : IPodContainerStatus[]

  • hostIP: string

  • initContainerStatuses? : IPodContainerStatus[]

  • phase: string

  • podIP: string

  • podIPs? : object[]

  • qosClass? : string

  • reason? : string

  • startTime: string


Static apiBase#

▪ apiBase: string = "/api/v1/pods"

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


Static kind#

▪ kind: string = "Pod"

Overrides KubeObject.kind

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


Static namespaced#

▪ namespaced: boolean = true

Overrides KubeObject.namespaced

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

Accessors#

• get selfLink(): string

Inherited from KubeObject.selfLink

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

Returns: string

Methods#

delete#

▸ delete(params?: JsonApiParams): Promise‹KubeJsonApiData›

Inherited from KubeObject.delete

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

Parameters:

Name Type
params? JsonApiParams

Returns: Promise‹KubeJsonApiData›


getAffinity#

▸ getAffinity(): IAffinity

Overrides Deployment.getAffinity

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

Returns: IAffinity


getAffinityNumber#

▸ getAffinityNumber(): number

Inherited from Pod.getAffinityNumber

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

Returns: number


getAge#

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

Inherited from KubeObject.getAge

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

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

Returns: IPodContainer[]


getAnnotations#

▸ getAnnotations(filter: boolean): string[]

Inherited from KubeObject.getAnnotations

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

Parameters:

Name Type Default
filter boolean false

Returns: string[]


getConditions#

▸ getConditions(): object[]

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

Returns: object[]


getContainerStatuses#

▸ getContainerStatuses(includeInitContainers: boolean): IPodContainerStatus[]

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

Parameters:

Name Type Default
includeInitContainers boolean true

Returns: IPodContainerStatus[]


getContainers#

▸ getContainers(): IPodContainer[]

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

Returns: IPodContainer[]


getFinalizers#

▸ getFinalizers(): string[]

Inherited from KubeObject.getFinalizers

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

Returns: string[]


getIPs#

▸ getIPs(): string[]

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

Returns: string[]


getId#

▸ getId(): string

Inherited from KubeObject.getId

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

Returns: string


getInitContainers#

▸ getInitContainers(): IPodContainer[]

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

Returns: IPodContainer[]


getLabels#

▸ getLabels(): string[]

Inherited from KubeObject.getLabels

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

Returns: string[]


getLivenessProbe#

▸ getLivenessProbe(container: IPodContainer): string[]

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

Parameters:

Name Type
container IPodContainer

Returns: string[]


getName#

▸ getName(): string

Inherited from KubeObject.getName

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

Returns: string


getNodeName#

▸ getNodeName(): string

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

Returns: string


getNodeSelectors#

▸ getNodeSelectors(): string[]

Overrides Deployment.getNodeSelectors

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

Returns: string[]


getNs#

▸ getNs(): string

Inherited from KubeObject.getNs

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

Returns: string


getOwnerRefs#

▸ getOwnerRefs(): object[]

Inherited from KubeObject.getOwnerRefs

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

Returns: object[]


getPriorityClassName#

▸ getPriorityClassName(): string

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

Returns: string


getProbe#

▸ getProbe(probeData: IContainerProbe): string[]

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

Parameters:

Name Type
probeData IContainerProbe

Returns: string[]


getQosClass#

▸ getQosClass(): string

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

Returns: string


getReadinessProbe#

▸ getReadinessProbe(container: IPodContainer): string[]

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

Parameters:

Name Type
container IPodContainer

Returns: string[]


getReason#

▸ getReason(): string

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

Returns: string


getResourceVersion#

▸ getResourceVersion(): string

Inherited from KubeObject.getResourceVersion

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

Returns: string


getRestartsCount#

▸ getRestartsCount(): number

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

Returns: number


getRunningContainers#

▸ getRunningContainers(): IPodContainer[]

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

Returns: IPodContainer[]


getSearchFields#

▸ getSearchFields(): string[]

Inherited from KubeObject.getSearchFields

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

Returns: string[]


getSecrets#

▸ getSecrets(): string[]

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

Returns: string[]


getSelectedNodeOs#

▸ getSelectedNodeOs(): string | undefined

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

Returns: string | undefined


getSelectors#

▸ getSelectors(): string[]

Inherited from Pod.getSelectors

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

Returns: string[]


getStartupProbe#

▸ getStartupProbe(container: IPodContainer): string[]

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

Parameters:

Name Type
container IPodContainer

Returns: string[]


getStatus#

▸ getStatus(): PodStatus

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

Returns: PodStatus


getStatusMessage#

▸ getStatusMessage(): string

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

Returns: string


getStatusPhase#

▸ getStatusPhase(): string

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

Returns: string


getTemplateLabels#

▸ getTemplateLabels(): string[]

Inherited from Pod.getTemplateLabels

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

Returns: string[]


getTimeDiffFromNow#

▸ getTimeDiffFromNow(): number

Inherited from KubeObject.getTimeDiffFromNow

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

Returns: number


getTolerations#

▸ getTolerations(): object[]

Overrides Deployment.getTolerations

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

Returns: object[]


getVolumes#

▸ getVolumes(): object[]

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

Returns: object[]


hasIssues#

▸ hasIssues(): boolean

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

Returns: boolean


toPlainObject#

▸ toPlainObject(): object

Inherited from KubeObject.toPlainObject

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

Returns: object


update#

▸ update‹T›(data: Partial‹T›): Promise‹T›

Inherited from KubeObject.update

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

Type parameters:

▪ T: KubeObject

Parameters:

Name Type
data Partial‹T›

Returns: Promise‹T›


Static create#

▸ create(data: KubeJsonApiData): KubeObject‹IKubeObjectMetadata, any, any›

Inherited from KubeObject.create

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

Parameters:

Name Type
data KubeJsonApiData

Returns: KubeObject‹IKubeObjectMetadata, any, any›


Static isJsonApiData#

▸ isJsonApiData(object: unknown): object is KubeJsonApiData

Inherited from KubeObject.isJsonApiData

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

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

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

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

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

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

Parameters:

Name Type
object unknown

Returns: object is Partial‹KubeJsonApiData›


Static isPartialJsonApiMetadata#

▸ isPartialJsonApiMetadata(object: unknown): object is Partial‹KubeJsonApiMetadata›

Inherited from KubeObject.isPartialJsonApiMetadata

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

Parameters:

Name Type
object unknown

Returns: object is Partial‹KubeJsonApiMetadata›


Static stringifyLabels#

▸ stringifyLabels(labels?: object): string[]

Inherited from KubeObject.stringifyLabels

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

Parameters:

Name Type
labels? object

Returns: string[]