Skip to content

Class: KubeObject#

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

Parameters:

Name Type
data KubeJsonApiData

Returns: KubeObject

Properties#

apiVersion#

• apiVersion: string

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

kind#

• kind: string

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

metadata#

• metadata: IKubeObjectMetadata

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

Optional status#

• status? : any

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

Static kind#

▪ kind: string

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

Static namespaced#

▪ namespaced: boolean

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

Accessors#

• get selfLink(): string

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

Returns: string

Methods#

delete#

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

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

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

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

Parameters:

Name Type Default
filter boolean false

Returns: string[]

getFinalizers#

▸ getFinalizers(): string[]

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

Returns: string[]

getId#

▸ getId(): string

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

Returns: string

getLabels#

▸ getLabels(): string[]

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

Returns: string[]

getName#

▸ getName(): string

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

Returns: string

getNs#

▸ getNs(): string

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

Returns: string

getOwnerRefs#

▸ getOwnerRefs(): object[]

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

Returns: object[]

getResourceVersion#

▸ getResourceVersion(): string

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

Returns: string

getSearchFields#

▸ getSearchFields(): string[]

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

Returns: string[]

getTimeDiffFromNow#

▸ getTimeDiffFromNow(): number

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

Returns: number

toPlainObject#

▸ toPlainObject(): object

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

Returns: object

update#

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

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

Type parameters:

▪ T: KubeObject

Parameters:

Name Type
data Partial‹T›

Returns: Promise‹T›

Static create#

▸ create(data: any): KubeObject‹›

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

Parameters:

Name Type
data any

Returns: KubeObject‹›

Static isJsonApiData#

▸ isJsonApiData(object: unknown): object is KubeJsonApiData

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

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

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

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

Parameters:

Name Type
object unknown

Returns: object is KubeJsonApiMetadata

Static isNonSystem#

▸ isNonSystem(item: KubeJsonApiData | KubeObject): boolean

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

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

Parameters:

Name Type
object unknown

Returns: object is Partial‹KubeJsonApiData›

Static stringifyLabels#

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

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

Parameters:

Name Type
labels? object

Returns: string[]