Skip to content

@k8slens/extensions

Globals / "src/renderer/api/endpoints/pods.api" / Pod

Class: Pod#

Hierarchy#

Pod

Implements#

Index#

Constructors#

Properties#

Accessors#

Methods#

Constructors#

constructor#

+ new Pod(data: KubeJsonApiData): Pod

Inherited from KubeObject.constructor

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

Parameters:

Name Type
data KubeJsonApiData

Returns: Pod

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: { affinity: IAffinity ; containers: IPodContainer[] ; dnsPolicy: string ; initContainers: IPodContainer[] ; nodeName: string ; nodeSelector?: { [selector:string]: string; } ; priority: number ; priorityClassName: string ; restartPolicy: string ; schedulerName: string ; securityContext: {} ; serviceAccount: string ; serviceAccountName: string ; terminationGracePeriodSeconds: number ; tolerations: { effect: string ; key: string ; operator: string ; tolerationSeconds: number }[] ; volumes?: { configMap: { name: string } ; emptyDir: { medium?: string ; sizeLimit?: string } ; name: string ; persistentVolumeClaim: { claimName: string } ; secret: { defaultMode: number ; secretName: string } }[] }

Overrides WorkloadKubeObject.spec

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

Type declaration:

Name Type
affinity IAffinity
containers IPodContainer[]
dnsPolicy string
initContainers IPodContainer[]
nodeName string
nodeSelector? { [selector:string]: string; }
priority number
priorityClassName string
restartPolicy string
schedulerName string
securityContext {}
serviceAccount string
serviceAccountName string
terminationGracePeriodSeconds number
tolerations { effect: string ; key: string ; operator: string ; tolerationSeconds: number }[]
volumes? { configMap: { name: string } ; emptyDir: { medium?: string ; sizeLimit?: string } ; name: string ; persistentVolumeClaim: { claimName: string } ; secret: { defaultMode: number ; secretName: string } }[]

status#

status: { conditions: { lastProbeTime: number ; lastTransitionTime: string ; status: string ; type: string }[] ; containerStatuses?: IPodContainerStatus[] ; hostIP: string ; initContainerStatuses?: IPodContainerStatus[] ; phase: string ; podIP: string ; qosClass: string ; reason?: string ; startTime: string }

Overrides KubeObject.status

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

Type declaration:

Name Type
conditions { lastProbeTime: number ; lastTransitionTime: string ; status: string ; type: string }[]
containerStatuses? IPodContainerStatus[]
hostIP string
initContainerStatuses? IPodContainerStatus[]
phase string
podIP string
qosClass string
reason? string
startTime string

apiBase#

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

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


kind#

Static kind: string = "Pod"

Overrides KubeObject.kind

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


namespaced#

Static namespaced: boolean = true

Overrides KubeObject.namespaced

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

Accessors#

• get selfLink(): string

Inherited from KubeObject.selfLink

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

Returns: string

Methods#

delete#

delete(params?: JsonApiParams): CancelablePromise\<KubeJsonApiData>

Inherited from KubeObject.delete

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

Parameters:

Name Type
params? JsonApiParams

Returns: CancelablePromise\<KubeJsonApiData>


getAffinity#

getAffinity(): IAffinity

Overrides WorkloadKubeObject.getAffinity

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

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


getAllContainers#

getAllContainers(): IPodContainer[]

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

Returns: IPodContainer[]


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


getConditions#

getConditions(): { lastProbeTime: number ; lastTransitionTime: string ; status: string ; type: string }[]

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

Returns: { lastProbeTime: number ; lastTransitionTime: string ; status: string ; type: string }[]


getContainerStatuses#

getContainerStatuses(includeInitContainers?: boolean): IPodContainerStatus[]

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

Parameters:

Name Type Default value
includeInitContainers boolean true

Returns: IPodContainerStatus[]


getContainers#

getContainers(): IPodContainer[]

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

Returns: IPodContainer[]


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


getInitContainers#

getInitContainers(): IPodContainer[]

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

Returns: IPodContainer[]


getLabels#

getLabels(): string[]

Inherited from KubeObject.getLabels

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

Returns: string[]


getLivenessProbe#

getLivenessProbe(container: IPodContainer): string[]

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

Parameters:

Name Type
container IPodContainer

Returns: string[]


getName#

getName(): string

Implementation of ItemObject

Inherited from KubeObject.getName

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

Returns: string


getNodeName#

getNodeName(): string

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

Returns: string


getNodeSelectors#

getNodeSelectors(): string[]

Overrides WorkloadKubeObject.getNodeSelectors

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

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() }[]


getPriorityClassName#

getPriorityClassName(): string

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

Returns: string


getProbe#

getProbe(probeData: IContainerProbe): string[]

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

Parameters:

Name Type
probeData IContainerProbe

Returns: string[]


getQosClass#

getQosClass(): string

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

Returns: string


getReadinessProbe#

getReadinessProbe(container: IPodContainer): string[]

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

Parameters:

Name Type
container IPodContainer

Returns: string[]


getReason#

getReason(): string

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

Returns: string


getResourceVersion#

getResourceVersion(): string

Inherited from KubeObject.getResourceVersion

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

Returns: string


getRestartsCount#

getRestartsCount(): number

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

Returns: number


getRunningContainers#

getRunningContainers(): IPodContainer[]

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

Returns: IPodContainer[]


getSearchFields#

getSearchFields(): string[]

Inherited from KubeObject.getSearchFields

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

Returns: string[]


getSecrets#

getSecrets(): string[]

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

Returns: string[]


getSelectedNodeOs#

getSelectedNodeOs(): string

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

Returns: string


getSelectors#

getSelectors(): string[]

Inherited from WorkloadKubeObject.getSelectors

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

Returns: string[]


getStatus#

getStatus(): FAILED | PENDING | RUNNING | SUCCEEDED | EVICTED

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

Returns: FAILED | PENDING | RUNNING | SUCCEEDED | EVICTED


getStatusMessage#

getStatusMessage(): string

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

Returns: string


getStatusPhase#

getStatusPhase(): string

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

Returns: string


getTemplateLabels#

getTemplateLabels(): string[]

Inherited from WorkloadKubeObject.getTemplateLabels

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

Returns: string[]


getTolerations#

getTolerations(): { effect: string ; key: string ; operator: string ; tolerationSeconds: number }[]

Overrides WorkloadKubeObject.getTolerations

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

Returns: { effect: string ; key: string ; operator: string ; tolerationSeconds: number }[]


getVolumes#

getVolumes(): { configMap: { name: string } ; emptyDir: { medium?: string ; sizeLimit?: string } ; name: string ; persistentVolumeClaim: { claimName: string } ; secret: { defaultMode: number ; secretName: string } }[]

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

Returns: { configMap: { name: string } ; emptyDir: { medium?: string ; sizeLimit?: string } ; name: string ; persistentVolumeClaim: { claimName: string } ; secret: { defaultMode: number ; secretName: string } }[]


hasIssues#

hasIssues(): boolean

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

Returns: boolean


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