Class: HorizontalPodAutoscaler#

Renderer.K8sApi.HorizontalPodAutoscaler

Hierarchy#

KubeObject<NamespaceScopedMetadata, HorizontalPodAutoscalerStatus, HorizontalPodAutoscalerSpec>

↳ HorizontalPodAutoscaler

Table of contents#

Constructors#

constructor

Properties#

Accessors#

selfLink

Methods#

Constructors#

constructor#

• new HorizontalPodAutoscaler(data)

Parameters#

Name	Type
`data`	`KubeJsonApiData`<`NamespaceScopedMetadata`, `HorizontalPodAutoscalerStatus`, `HorizontalPodAutoscalerSpec`>

Inherited from#

KubeObject.constructor

Properties#

apiVersion#

• apiVersion: string

Inherited from#

KubeObject.apiVersion

kind#

• kind: string

spec#

• spec: HorizontalPodAutoscalerSpec

Inherited from#

KubeObject.spec

status#

• Optional status: HorizontalPodAutoscalerStatus

Inherited from#

KubeObject.status

apiBase#

▪ Static Readonly apiBase: "/apis/autoscaling/v2beta1/horizontalpodautoscalers"

Overrides#

KubeObject.apiBase

kind#

▪ Static Readonly kind: "HorizontalPodAutoscaler"

Overrides#

KubeObject.kind

namespaced#

▪ Static Readonly namespaced: true

Overrides#

KubeObject.namespaced

Accessors#

selfLink#

• 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

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

Inherited from#

KubeObject.getAge

getAnnotations#

▸ getAnnotations(filter?): string[]

Parameters#

Name	Type	Default value
`filter`	`boolean`	`false`

Returns#

string[]

Inherited from#

KubeObject.getAnnotations

getConditions#

▸ getConditions(): { isReady: boolean ; lastTransitionTime?: string ; message?: string ; reason?: string ; status: "True" | "False" | "Unknown" ; tooltip: string ; type: string }[]

Returns#

{ isReady: boolean ; lastTransitionTime?: string ; message?: string ; reason?: string ; status: "True" | "False" | "Unknown" ; tooltip: string ; type: string }[]

getContainerResourceMetricValue#

▸ Protected getContainerResourceMetricValue(currentMetric, targetMetric): MetricCurrentTarget

Parameters#

Name	Type
`currentMetric`	`undefined` \| `ContainerResourceMetricSource`
`targetMetric`	`ContainerResourceMetricSource`

Returns#

MetricCurrentTarget

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

getCurrentMetrics#

▸ getCurrentMetrics(): HorizontalPodAutoscalerMetricSpec[]

Returns#

HorizontalPodAutoscalerMetricSpec[]

getExternalMetricValue#

▸ Protected getExternalMetricValue(currentMetric, targetMetric): MetricCurrentTarget

Parameters#

Name	Type
`currentMetric`	`undefined` \| `ExternalMetricSource`
`targetMetric`	`ExternalMetricSource`

Returns#

MetricCurrentTarget

getFinalizers#

▸ getFinalizers(): string[]

Returns#

string[]

Inherited from#

KubeObject.getFinalizers

getId#

▸ getId(): string

Returns#

string

Inherited from#

KubeObject.getId

getLabels#

▸ getLabels(): string[]

Returns#

string[]

Inherited from#

KubeObject.getLabels

getMaxPods#

▸ getMaxPods(): number

Returns#

number

getMetricCurrentTarget#

▸ Protected getMetricCurrentTarget(metric): MetricCurrentTarget

Parameters#

Name	Type
`metric`	`HorizontalPodAutoscalerMetricSpec`

Returns#

MetricCurrentTarget

getMetricName#

▸ Protected getMetricName(metric): string

Parameters#

Name	Type
`metric`	`HorizontalPodAutoscalerMetricSpec`

Returns#

string

getMetricValues#

▸ getMetricValues(metric): string

Parameters#

Name	Type
`metric`	`HorizontalPodAutoscalerMetricSpec`

Returns#

string

getMetrics#

▸ getMetrics(): HorizontalPodAutoscalerMetricSpec[]

Returns#

HorizontalPodAutoscalerMetricSpec[]

getMinPods#

▸ getMinPods(): number

Returns#

number

getName#

▸ getName(): string

Returns#

string

Inherited from#

KubeObject.getName

getNs#

▸ getNs(): string

Returns#

string

Inherited from#

KubeObject.getNs

getObjectMetricValue#

▸ Protected getObjectMetricValue(currentMetric, targetMetric): MetricCurrentTarget

Parameters#

Name	Type
`currentMetric`	`undefined` \| `ObjectMetricSource`
`targetMetric`	`ObjectMetricSource`

Returns#

MetricCurrentTarget

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

getPodsMetricValue#

▸ Protected getPodsMetricValue(currentMetric, targetMetric): MetricCurrentTarget

Parameters#

Name	Type
`currentMetric`	`undefined` \| `PodsMetricSource`
`targetMetric`	`PodsMetricSource`

Returns#

MetricCurrentTarget

getReadyConditions#

▸ getReadyConditions(): { isReady: boolean ; lastTransitionTime?: string ; message?: string ; reason?: string ; status: "True" | "False" | "Unknown" ; tooltip: string ; type: string }[]

Returns#

{ isReady: boolean ; lastTransitionTime?: string ; message?: string ; reason?: string ; status: "True" | "False" | "Unknown" ; tooltip: string ; type: string }[]

getReplicas#

▸ getReplicas(): number

Returns#

number

getResourceMetricValue#

▸ Protected getResourceMetricValue(currentMetric, targetMetric): MetricCurrentTarget

Parameters#

Name	Type
`currentMetric`	`undefined` \| `ResourceMetricSource`
`targetMetric`	`ResourceMetricSource`

Returns#

MetricCurrentTarget

getResourceVersion#

▸ getResourceVersion(): string

Returns#

string

Inherited from#

KubeObject.getResourceVersion

getScopedName#

▸ getScopedName(): string

Returns#

string

Inherited from#

KubeObject.getScopedName

getSearchFields#

▸ getSearchFields(): string[]

Returns#

string[]

Inherited from#

KubeObject.getSearchFields

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

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

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`	`KubeJsonApiData`<`KubeJsonApiObjectMetadata`<`KubeObjectScope`>, `unknown`, `unknown`> \| `KubeObject`<`KubeObjectMetadata`<`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

Class: HorizontalPodAutoscaler#

Hierarchy#

Table of contents#

Constructors#

Properties#

Accessors#

Methods#

Constructors#

constructor#

Parameters#

Inherited from#

Properties#

apiVersion#

Inherited from#

kind#

Inherited from#

metadata#

Inherited from#

spec#

Inherited from#

status#

Inherited from#

apiBase#

Overrides#

kind#

Overrides#

namespaced#

Overrides#

Accessors#

selfLink#

Returns#

Inherited from#

Methods#

delete#

Parameters#

Returns#

Inherited from#

getAge#

Parameters#

Returns#

Inherited from#

getAnnotations#

Parameters#

Returns#

Inherited from#

getConditions#

Returns#

getContainerResourceMetricValue#

Parameters#

Returns#

getCreationTimestamp#

Returns#

Inherited from#

getCurrentMetrics#

Returns#

getExternalMetricValue#

Parameters#

Returns#

getFinalizers#

Returns#

Inherited from#

getId#

Returns#

Inherited from#

getLabels#

Returns#

Inherited from#

getMaxPods#

Returns#

getMetricCurrentTarget#

Parameters#

Returns#

getMetricName#

Parameters#

Returns#

getMetricValues#

Parameters#

Returns#

getMetrics#

Returns#