Class: KubeObject<Metadata, Status, Spec>

Renderer.K8sApi.KubeObject

Type parameters

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

Hierarchy

• KubeObject

↳ Pod

↳ Node

↳ Deployment

↳ DaemonSet

↳ StatefulSet

↳ Job

↳ CronJob

↳ ConfigMap

↳ Secret

↳ ReplicaSet

↳ ResourceQuota

↳ LimitRange

↳ HorizontalPodAutoscaler

↳ PodDisruptionBudget

↳ PriorityClass

↳ Service

↳ Endpoint

↳ Ingress

↳ NetworkPolicy

↳ PersistentVolume

↳ PersistentVolumeClaim

↳ StorageClass

↳ Namespace

↳ KubeEvent

↳ ServiceAccount

↳ Role

↳ RoleBinding

↳ ClusterRole

↳ ClusterRoleBinding

↳ CustomResourceDefinition

Implements

• ItemObject

Table of contents

Constructors

• constructor

Properties

• apiVersion
• kind
• metadata
• spec
• status
• apiBase
• kind
• namespaced

Accessors

• selfLink

Methods

• delete
• getAge
• getAnnotations
• getCreationTimestamp
• getFinalizers
• getId
• getLabels
• getName
• getNs
• getOwnerRefs
• getResourceVersion
• getScopedName
• getSearchFields
• getTimeDiffFromNow
• patch
• toPlainObject
• update
• create
• isJsonApiData
• isJsonApiDataList
• isKubeJsonApiListMetadata
• isKubeJsonApiMetadata
• isNonSystem
• isPartialJsonApiData
• isPartialJsonApiMetadata
• stringifyLabels

Constructors

constructor

• new KubeObject<Metadata, Status, Spec>(data)

Type parameters

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

Parameters

Name	Type
data	KubeJsonApiData<Metadata, Status, Spec>

Properties

apiVersion

• apiVersion: string

---

kind

• kind: string

---

metadata

• metadata: Metadata

---

spec

• spec: Spec

---

status

• Optional status: Status

---

apiBase

▪ Static Optional Readonly apiBase: string

---

kind

▪ Static Optional Readonly kind: string

---

namespaced

▪ Static Optional Readonly namespaced: boolean

Accessors

selfLink

• get selfLink(): string

Returns

string

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

---

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	Default value
humanize	boolean	true
compact	boolean	true
fromNow	boolean	false

Returns

string | number

---

getAnnotations

▸ getAnnotations(filter?): string[]

Parameters

Name	Type	Default value
filter	boolean	false

Returns

string[]

---

getCreationTimestamp

▸ getCreationTimestamp(): number

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

Returns

number

---

getFinalizers

▸ getFinalizers(): string[]

Returns

string[]

---

getId

▸ getId(): string

Returns

string

Implementation of

ItemObject.getId

---

getLabels

▸ getLabels(): string[]

Returns

string[]

---

getName

▸ getName(): string

Returns

string

Implementation of

ItemObject.getName

---

getNs

▸ getNs(): Metadata["namespace"]

Returns

Metadata["namespace"]

---

getOwnerRefs

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

Returns

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

---

getResourceVersion

▸ getResourceVersion(): string

Returns

string

---

getScopedName

▸ getScopedName(): string

Returns

string

---

getSearchFields

▸ getSearchFields(): (string | Metadata["namespace"])[]

Returns

(string | Metadata["namespace"])[]

---

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

---

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

---

toPlainObject

▸ toPlainObject(): JsonObject

Returns

JsonObject

---

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<KubeObject<Metadata, Status, Spec>>

Returns

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

---

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>

---

isJsonApiData

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

Parameters

Name	Type
object	unknown

Returns

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

---

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>

---

isKubeJsonApiListMetadata

▸ Static isKubeJsonApiListMetadata(object): object is KubeJsonApiListMetadata

Parameters

Name	Type
object	unknown

Returns

object is KubeJsonApiListMetadata

---

isKubeJsonApiMetadata

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

Parameters

Name	Type
object	unknown

Returns

object is KubeJsonApiObjectMetadata<KubeObjectScope>

---

isNonSystem

▸ Static isNonSystem(item): boolean

Parameters

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

Returns

boolean

---

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

---

isPartialJsonApiMetadata

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

Parameters

Name	Type
object	unknown

Returns

object is Partial<KubeJsonApiObjectMetadata<KubeObjectScope>>

---

stringifyLabels

▸ Static stringifyLabels(labels?): string[]

Parameters

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

Returns

string[]