Skip to content

@k8slens/extensions / Exports / Main / K8sApi / Pod

Class: Pod#

Main.K8sApi.Pod

Hierarchy#

↳ Pod

Table of contents#

Constructors#

Properties#

Accessors#

Methods#

Constructors#

constructor#

• new Pod(data)

Parameters#

Name Type
data KubeJsonApiData<NamespaceScopedMetadata, PodStatus, PodSpec>

Inherited from#

KubeObject.constructor

Properties#

apiVersion#

• apiVersion: string

Inherited from#

KubeObject.apiVersion

kind#

• kind: string

Inherited from#

KubeObject.kind

metadata#

• metadata: NamespaceScopedMetadata

Inherited from#

KubeObject.metadata

spec#

• spec: PodSpec

Inherited from#

KubeObject.spec

status#

• Optional status: PodStatus

Inherited from#

KubeObject.status

apiBase#

▪ Static apiBase: string

Overrides#

KubeObject.apiBase

kind#

▪ Static kind: string

Overrides#

KubeObject.kind

namespaced#

▪ Static namespaced: boolean

Overrides#

KubeObject.namespaced

Accessors#

• get selfLink(): string

Returns#

string

Inherited from#

KubeObject.selfLink

Methods#

delete#

▸ delete(params?): Promise<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

use KubeApi.delete instead

Parameters#

Name Type
params? object

Returns#

Promise<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Inherited from#

KubeObject.delete

getAffinity#

▸ getAffinity(): Affinity

Returns#

Affinity

getAffinityNumber#

▸ getAffinityNumber(): number

Returns#

number

getAge#

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

Deprecated

This function computes a new "now" on every call might cause subtle issues if called multiple times

NOTE: this function also is not reactive to updates in the current time so it should not be used for renderering

Parameters#

Name Type
humanize? boolean
compact? boolean
fromNow? boolean

Returns#

string | number

Inherited from#

KubeObject.getAge

getAllContainers#

▸ getAllContainers(): IPodContainer[]

Returns#

IPodContainer[]

getAnnotations#

▸ getAnnotations(filter?): string[]

Parameters#

Name Type
filter? boolean

Returns#

string[]

Inherited from#

KubeObject.getAnnotations

getConditions#

▸ getConditions(): PodCondition[]

Returns#

PodCondition[]

getContainerStatuses#

▸ getContainerStatuses(includeInitContainers?): IPodContainerStatus[]

Parameters#

Name Type
includeInitContainers? boolean

Returns#

IPodContainerStatus[]

getContainers#

▸ getContainers(): IPodContainer[]

Returns#

IPodContainer[]

getCreationTimestamp#

▸ getCreationTimestamp(): number

This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.

Returns#

number

Inherited from#

KubeObject.getCreationTimestamp

getFinalizers#

▸ getFinalizers(): string[]

Returns#

string[]

Inherited from#

KubeObject.getFinalizers

getIPs#

▸ getIPs(): string[]

Returns#

string[]

getId#

▸ getId(): string

Returns#

string

Inherited from#

KubeObject.getId

getInitContainers#

▸ getInitContainers(): IPodContainer[]

Returns#

IPodContainer[]

getLabels#

▸ getLabels(): string[]

Returns#

string[]

Inherited from#

KubeObject.getLabels

getLivenessProbe#

▸ getLivenessProbe(container): string[]

Parameters#

Name Type
container IPodContainer

Returns#

string[]

getName#

▸ getName(): string

Returns#

string

Inherited from#

KubeObject.getName

getNodeName#

▸ getNodeName(): undefined | string

Returns#

undefined | string

getNodeSelectors#

▸ getNodeSelectors(): string[]

Returns#

string[]

getNs#

▸ getNs(): string

Returns#

string

Inherited from#

KubeObject.getNs

getOwnerRefs#

▸ getOwnerRefs(): { apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]

Returns#

{ apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: string ; uid: string }[]

Inherited from#

KubeObject.getOwnerRefs

getPriorityClassName#

▸ getPriorityClassName(): string

Returns#

string

getQosClass#

▸ getQosClass(): string

Returns#

string

getReadinessProbe#

▸ getReadinessProbe(container): string[]

Parameters#

Name Type
container IPodContainer

Returns#

string[]

getReason#

▸ getReason(): string

Returns#

string

getResourceVersion#

▸ getResourceVersion(): string

Returns#

string

Inherited from#

KubeObject.getResourceVersion

getRestartsCount#

▸ getRestartsCount(): number

Returns#

number

getRunningContainers#

▸ getRunningContainers(): IPodContainer[]

Returns#

IPodContainer[]

getRuntimeClassName#

▸ getRuntimeClassName(): string

Returns#

string

getScopedName#

▸ getScopedName(): string

Returns#

string

Inherited from#

KubeObject.getScopedName

getSearchFields#

▸ getSearchFields(): string[]

Returns#

string[]

Inherited from#

KubeObject.getSearchFields

getSecrets#

▸ getSecrets(): string[]

Returns#

string[]

getSelectedNodeOs#

▸ getSelectedNodeOs(): undefined | string

Returns#

undefined | string

getServiceAccountName#

▸ getServiceAccountName(): string

Returns#

string

getStartupProbe#

▸ getStartupProbe(container): string[]

Parameters#

Name Type
container IPodContainer

Returns#

string[]

getStatus#

▸ getStatus(): PodStatusPhase

Returns#

PodStatusPhase

getStatusMessage#

▸ getStatusMessage(): string

Returns#

string

getStatusPhase#

▸ getStatusPhase(): undefined | string

Returns#

undefined | string

getTimeDiffFromNow#

▸ getTimeDiffFromNow(): number

Deprecated

This function computes a new "now" on every call which might cause subtle issues if called multiple times

NOTE: Generally you can use getCreationTimestamp instead.

Returns#

number

Inherited from#

KubeObject.getTimeDiffFromNow

getTolerations#

▸ getTolerations(): Toleration[]

Returns#

Toleration[]

getVolumes#

▸ getVolumes(): PodSpecVolume[]

Returns#

PodSpecVolume[]

hasIssues#

▸ hasIssues(): boolean

Returns#

boolean

patch#

▸ patch(patch): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Deprecated

use KubeApi.patch instead

Parameters#

Name Type
patch Patch

Returns#

Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Inherited from#

KubeObject.patch

toPlainObject#

▸ toPlainObject(): JsonObject

Returns#

JsonObject

Inherited from#

KubeObject.toPlainObject

update#

▸ update(data): Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Perform a full update (or more specifically a replace)

Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition.

Deprecated

use KubeApi.update instead

Parameters#

Name Type
data Partial<Pod>

Returns#

Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Inherited from#

KubeObject.update

create#

▸ Static create<Metadata, Status, Spec>(data): KubeObject<Metadata, Status, Spec>

Type parameters#

Name Type
Metadata extends KubeObjectMetadata<KubeObjectScope> = KubeObjectMetadata<KubeObjectScope>
Status unknown
Spec unknown

Parameters#

Name Type
data KubeJsonApiData<Metadata, Status, Spec>

Returns#

KubeObject<Metadata, Status, Spec>

Inherited from#

KubeObject.create

isJsonApiData#

▸ Static isJsonApiData(object): object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

Parameters#

Name Type
object unknown

Returns#

object is KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

Inherited from#

KubeObject.isJsonApiData

isJsonApiDataList#

▸ Static isJsonApiDataList<T>(object, verifyItem): object is KubeJsonApiDataList<T>

Type parameters#

Name
T

Parameters#

Name Type
object unknown
verifyItem (val: unknown) => val is T

Returns#

object is KubeJsonApiDataList<T>

Inherited from#

KubeObject.isJsonApiDataList

isKubeJsonApiListMetadata#

▸ Static isKubeJsonApiListMetadata(object): object is KubeJsonApiListMetadata

Parameters#

Name Type
object unknown

Returns#

object is KubeJsonApiListMetadata

Inherited from#

KubeObject.isKubeJsonApiListMetadata

isKubeJsonApiMetadata#

▸ Static isKubeJsonApiMetadata(object): object is KubeJsonApiObjectMetadata<KubeObjectScope>

Parameters#

Name Type
object unknown

Returns#

object is KubeJsonApiObjectMetadata<KubeObjectScope>

Inherited from#

KubeObject.isKubeJsonApiMetadata

isNonSystem#

▸ Static isNonSystem(item): boolean

Parameters#

Name Type
item KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>

Returns#

boolean

Inherited from#

KubeObject.isNonSystem

isPartialJsonApiData#

▸ Static isPartialJsonApiData(object): object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Parameters#

Name Type
object unknown

Returns#

object is Partial<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Inherited from#

KubeObject.isPartialJsonApiData

isPartialJsonApiMetadata#

▸ Static isPartialJsonApiMetadata(object): object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

Parameters#

Name Type
object unknown

Returns#

object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

Inherited from#

KubeObject.isPartialJsonApiMetadata

stringifyLabels#

▸ Static stringifyLabels(labels?): string[]

Parameters#

Name Type
labels? Partial<Record<string, string>>

Returns#

string[]

Inherited from#

KubeObject.stringifyLabels