Skip to content

Class: KubeObject ‹Metadata, Status, Spec›#

Type parameters#

▪ Metadata: IKubeObjectMetadata

▪ Status

▪ Spec

Hierarchy#

  • KubeObject

↳ Node

↳ CronJob

↳ ConfigMap

↳ Secret

↳ ResourceQuota

↳ LimitRange

↳ HorizontalPodAutoscaler

↳ PodDisruptionBudget

↳ Service

↳ Endpoint

↳ Ingress

↳ NetworkPolicy

↳ PersistentVolume

↳ PersistentVolumeClaim

↳ StorageClass

↳ Namespace

↳ KubeEvent

↳ ServiceAccount

↳ Role

↳ RoleBinding

↳ CustomResourceDefinition

Implements#

  • ItemObject

Index#

Constructors#

Properties#

Accessors#

Methods#

Constructors#

constructor#

+ new KubeObject(data: KubeJsonApiData): KubeObject

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

Parameters:

Name Type
data KubeJsonApiData

Returns: KubeObject

Properties#

apiVersion#

• apiVersion: string

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


kind#

• kind: string

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


metadata#

• metadata: Metadata

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


Optional spec#

• spec? : Spec

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


Optional status#

• status? : Status

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


Static kind#

▪ kind: string

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


Static namespaced#

▪ namespaced: boolean

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

Accessors#

• get selfLink(): string

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

Returns: string

Methods#

delete#

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

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

Parameters:

Name Type
params? JsonApiParams

Returns: Promise‹KubeJsonApiData›


getAge#

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

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


getAnnotations#

▸ getAnnotations(filter: boolean): string[]

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

Parameters:

Name Type Default
filter boolean false

Returns: string[]


getFinalizers#

▸ getFinalizers(): string[]

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

Returns: string[]


getId#

▸ getId(): string

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

Returns: string


getLabels#

▸ getLabels(): string[]

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

Returns: string[]


getName#

▸ getName(): string

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

Returns: string


getNs#

▸ getNs(): string

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

Returns: string


getOwnerRefs#

▸ getOwnerRefs(): object[]

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

Returns: object[]


getResourceVersion#

▸ getResourceVersion(): string

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

Returns: string


getSearchFields#

▸ getSearchFields(): string[]

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

Returns: string[]


getTimeDiffFromNow#

▸ getTimeDiffFromNow(): number

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

Returns: number


toPlainObject#

▸ toPlainObject(): object

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

Returns: object


update#

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

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›

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

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›

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

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

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

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›

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›

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

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

Parameters:

Name Type
labels? object

Returns: string[]