Skip to content

Class: Deployment#

Renderer.K8sApi.Deployment

Hierarchy#

↳ Deployment

Table of contents#

Constructors#

Properties#

Accessors#

Methods#

Constructors#

constructor#

• new Deployment(data)

Parameters#

Name Type
data KubeJsonApiData<NamespaceScopedMetadata, DeploymentStatus, DeploymentSpec>

Inherited from#

KubeObject.constructor

Properties#

apiVersion#

• apiVersion: string

Inherited from#

KubeObject.apiVersion

kind#

• kind: string

Inherited from#

KubeObject.kind

metadata#

• metadata: NamespaceScopedMetadata

Inherited from#

KubeObject.metadata

spec#

• spec: DeploymentSpec

Inherited from#

KubeObject.spec

status#

• Optional status: DeploymentStatus

Inherited from#

KubeObject.status

apiBase#

▪ Static apiBase: string = "/apis/apps/v1/deployments"

Overrides#

KubeObject.apiBase

kind#

▪ Static kind: string = "Deployment"

Overrides#

KubeObject.kind

namespaced#

▪ Static namespaced: boolean = true

Overrides#

KubeObject.namespaced

Accessors#

• 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

getAffinity#

▸ getAffinity(): undefined | Affinity

Returns#

undefined | Affinity

getAffinityNumber#

▸ getAffinityNumber(): number

Returns#

number

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(activeOnly?): BaseKubeObjectCondition[]

Parameters#

Name Type Default value
activeOnly boolean false

Returns#

BaseKubeObjectCondition[]

getConditionsText#

▸ getConditionsText(activeOnly?): string

Parameters#

Name Type Default value
activeOnly boolean true

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

Inherited from#

KubeObject.getCreationTimestamp

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

getName#

▸ getName(): string

Returns#

string

Inherited from#

KubeObject.getName

getNodeSelectors#

▸ getNodeSelectors(): string[]

Returns#

string[]

getNs#

▸ getNs(): string

Returns#

string

Inherited from#

KubeObject.getNs

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

getReplicas#

▸ getReplicas(): number

Returns#

number

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

getSelectors#

▸ getSelectors(): string[]

Returns#

string[]

getTemplateLabels#

▸ getTemplateLabels(): string[]

Returns#

string[]

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

getTolerations#

▸ getTolerations(): Toleration[]

Returns#

Toleration[]

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

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