Class: Node

Renderer.K8sApi.Node

Hierarchy

• KubeObject

↳ Node

Table of contents

Constructors

• constructor

Properties

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

Accessors

• selfLink

Methods

• delete
• getActiveConditions
• getAge
• getAnnotations
• getConditions
• getCpuCapacity
• getFinalizers
• getId
• getKubeletVersion
• getLabels
• getMemoryCapacity
• getName
• getNodeConditionText
• getNs
• getOperatingSystem
• getOwnerRefs
• getResourceVersion
• getRoleLabels
• getSearchFields
• getTaints
• getTimeDiffFromNow
• getWarningConditions
• isUnschedulable
• toPlainObject
• update
• create
• isJsonApiData
• isJsonApiDataList
• isKubeJsonApiListMetadata
• isKubeJsonApiMetadata
• isNonSystem
• isPartialJsonApiData
• isPartialJsonApiMetadata
• stringifyLabels

Constructors

constructor

• new Node(data)

Parameters

Name	Type
data	KubeJsonApiData

Inherited from

KubeObject.constructor

Properties

apiVersion

• apiVersion: string

Inherited from

KubeObject.apiVersion

---

kind

• kind: string

Inherited from

KubeObject.kind

---

managedFields

• Optional managedFields: any

Inherited from

KubeObject.managedFields

---

metadata

• metadata: KubeObjectMetadata

Inherited from

KubeObject.metadata

---

spec

• spec: Object

Type declaration

Name	Type
externalID?	string
podCIDR?	string
podCIDRs?	string[]
providerID?	string
taints?	{ effect: string ; key: string ; timeAdded: string ; value: string }[]
unschedulable?	boolean

Inherited from

KubeObject.spec

---

status

• status: Object

Type declaration

Name	Type
addresses?	{ address: string ; type: string }[]
allocatable?	Object
allocatable.cpu	string
allocatable.ephemeral-storage	string
allocatable.hugepages-1Gi	string
allocatable.hugepages-2Mi	string
allocatable.memory	string
allocatable.pods	string
capacity?	Object
capacity.cpu	string
capacity.ephemeral-storage	string
capacity.hugepages-1Gi	string
capacity.hugepages-2Mi	string
capacity.memory	string
capacity.pods	string
conditions?	{ lastHeartbeatTime?: string ; lastTransitionTime?: string ; message?: string ; reason?: string ; status: string ; type: string }[]
daemonEndpoints?	Object
daemonEndpoints.kubeletEndpoint	Object
daemonEndpoints.kubeletEndpoint.Port	number
images?	{ names: string[] ; sizeBytes?: number }[]
nodeInfo?	Object
nodeInfo.architecture	string
nodeInfo.bootID	string
nodeInfo.containerRuntimeVersion	string
nodeInfo.kernelVersion	string
nodeInfo.kubeProxyVersion	string
nodeInfo.kubeletVersion	string
nodeInfo.machineID	string
nodeInfo.operatingSystem	string
nodeInfo.osImage	string
nodeInfo.systemUUID	string
volumesAttached?	{ devicePath: string ; name: string }[]
volumesInUse?	string[]

Inherited from

KubeObject.status

---

apiBase

▪ Static apiBase: string = "/api/v1/nodes"

---

kind

▪ Static kind: string = "Node"

Inherited from

KubeObject.kind

---

namespaced

▪ Static namespaced: boolean = false

Inherited from

KubeObject.namespaced

---

nonEditableFields

▪ Static Protected Readonly nonEditableFields: string[]

Inherited from

KubeObject.nonEditableFields

Accessors

selfLink

• get selfLink(): string

Returns

string

Methods

delete

▸ delete(params?): Promise<KubeJsonApiData>

Parameters

Name	Type
params?	JsonApiParams<any>

Returns

Promise<KubeJsonApiData>

Inherited from

KubeObject.delete

---

getActiveConditions

▸ getActiveConditions(): { lastHeartbeatTime?: string ; lastTransitionTime?: string ; message?: string ; reason?: string ; status: string ; type: string }[]

Returns

{ lastHeartbeatTime?: string ; lastTransitionTime?: string ; message?: string ; reason?: string ; status: string ; type: string }[]

---

getAge

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

Parameters

Name	Type	Default value
humanize	boolean	true
compact	boolean	true
fromNow	boolean	false

Returns

string | number

Inherited from

KubeObject.getAge

---

getAnnotations

▸ getAnnotations(filter?): string[]

Parameters

Name	Type	Default value
filter	boolean	false

Returns

string[]

Inherited from

KubeObject.getAnnotations

---

getConditions

▸ getConditions(): { lastHeartbeatTime?: string ; lastTransitionTime?: string ; message?: string ; reason?: string ; status: string ; type: string }[]

Returns

{ lastHeartbeatTime?: string ; lastTransitionTime?: string ; message?: string ; reason?: string ; status: string ; type: string }[]

---

getCpuCapacity

▸ getCpuCapacity(): number

Returns

number

---

getFinalizers

▸ getFinalizers(): string[]

Returns

string[]

Inherited from

KubeObject.getFinalizers

---

getId

▸ getId(): string

Returns

string

Inherited from

KubeObject.getId

---

getKubeletVersion

▸ getKubeletVersion(): string

Returns

string

---

getLabels

▸ getLabels(): string[]

Returns

string[]

Inherited from

KubeObject.getLabels

---

getMemoryCapacity

▸ getMemoryCapacity(): number

Returns

number

---

getName

▸ getName(): string

Returns

string

Inherited from

KubeObject.getName

---

getNodeConditionText

▸ getNodeConditionText(): string

Returns

string

---

getNs

▸ getNs(): string

Returns

string

Inherited from

KubeObject.getNs

---

getOperatingSystem

▸ getOperatingSystem(): string

Returns

string

---

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

---

getResourceVersion

▸ getResourceVersion(): string

Returns

string

Inherited from

KubeObject.getResourceVersion

---

getRoleLabels

▸ getRoleLabels(): string

Returns

string

---

getSearchFields

▸ getSearchFields(): string[]

Returns

string[]

Inherited from

KubeObject.getSearchFields

---

getTaints

▸ getTaints(): { effect: string ; key: string ; timeAdded: string ; value: string }[]

Returns

{ effect: string ; key: string ; timeAdded: string ; value: string }[]

---

getTimeDiffFromNow

▸ getTimeDiffFromNow(): number

Returns

number

Inherited from

KubeObject.getTimeDiffFromNow

---

getWarningConditions

▸ getWarningConditions(): { lastHeartbeatTime?: string ; lastTransitionTime?: string ; message?: string ; reason?: string ; status: string ; type: string }[]

Returns

{ lastHeartbeatTime?: string ; lastTransitionTime?: string ; message?: string ; reason?: string ; status: string ; type: string }[]

---

isUnschedulable

▸ isUnschedulable(): boolean

Returns

boolean

---

toPlainObject

▸ toPlainObject(): object

Returns

object

Inherited from

KubeObject.toPlainObject

---

update

▸ update(data): Promise<KubeJsonApiData>

Parameters

Name	Type
data	Partial<Node>

Returns

Promise<KubeJsonApiData>

Inherited from

KubeObject.update

---

create

▸ Static create(data): KubeObject<KubeObjectMetadata, any, any>

Parameters

Name	Type
data	KubeJsonApiData

Returns

KubeObject<KubeObjectMetadata, any, any>

Inherited from

KubeObject.create

---

isJsonApiData

▸ Static isJsonApiData(object): object is KubeJsonApiData

Parameters

Name	Type
object	unknown

Returns

object is KubeJsonApiData

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 KubeJsonApiMetadata

Parameters

Name	Type
object	unknown

Returns

object is KubeJsonApiMetadata

Inherited from

KubeObject.isKubeJsonApiMetadata

---

isNonSystem

▸ Static isNonSystem(item): boolean

Parameters

Name	Type
item	KubeObject<KubeObjectMetadata, any, any> | KubeJsonApiData

Returns

boolean

Inherited from

KubeObject.isNonSystem

---

isPartialJsonApiData

▸ Static isPartialJsonApiData(object): object is Partial<KubeJsonApiData>

Parameters

Name	Type
object	unknown

Returns

object is Partial<KubeJsonApiData>

Inherited from

KubeObject.isPartialJsonApiData

---

isPartialJsonApiMetadata

▸ Static isPartialJsonApiMetadata(object): object is Partial<KubeJsonApiMetadata>

Parameters

Name	Type
object	unknown

Returns

object is Partial<KubeJsonApiMetadata>

Inherited from

KubeObject.isPartialJsonApiMetadata

---

stringifyLabels

▸ Static stringifyLabels(labels?): string[]

Parameters

Name	Type
labels?	Object

Returns

string[]

Inherited from

KubeObject.stringifyLabels