Class: PriorityClass#
+ +Hierarchy#
+-
+
KubeObject<ClusterScopedMetadata,void,void>
+
↳ PriorityClass
Table of contents#
+Constructors#
+-
+
- constructor +
Properties#
+-
+
- apiVersion +
- description +
- globalDefault +
- kind +
- metadata +
- preemptionPolicy +
- spec +
- status +
- value +
- apiBase +
- kind +
- namespaced +
Accessors#
+-
+
- selfLink +
Methods#
+-
+
- delete +
- getAge +
- getAnnotations +
- getCreationTimestamp +
- getDescription +
- getFinalizers +
- getGlobalDefault +
- getId +
- getLabels +
- getName +
- getNs +
- getOwnerRefs +
- getPreemptionPolicy +
- getResourceVersion +
- getScopedName +
- getSearchFields +
- getTimeDiffFromNow +
- getValue +
- patch +
- toPlainObject +
- update +
- create +
- isJsonApiData +
- isJsonApiDataList +
- isKubeJsonApiListMetadata +
- isKubeJsonApiMetadata +
- isNonSystem +
- isPartialJsonApiData +
- isPartialJsonApiMetadata +
- stringifyLabels +
Constructors#
+constructor#
+• new PriorityClass(__namedParameters)
Parameters#
+| Name | +Type | +
|---|---|
__namedParameters |
+PriorityClassData |
+
Overrides#
+ +Properties#
+apiVersion#
+• apiVersion: string
Inherited from#
+ ++
description#
+• Optional description: string
+
globalDefault#
+• Optional globalDefault: boolean
+
kind#
+• kind: string
Inherited from#
+ ++
metadata#
+• metadata: ClusterScopedMetadata
Inherited from#
+ ++
preemptionPolicy#
+• Optional preemptionPolicy: PreemptionPolicy
+
spec#
+• spec: void
Inherited from#
+ ++
status#
+• Optional status: void
Inherited from#
+ ++
value#
+• Optional value: number
+
apiBase#
+▪ Static Readonly apiBase: "/apis/scheduling.k8s.io/v1/priorityclasses"
Overrides#
+ ++
kind#
+▪ Static Readonly kind: "PriorityClass"
Overrides#
+ ++
namespaced#
+▪ Static Readonly namespaced: false
Overrides#
+ +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#
+ ++
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#
+ ++
getAnnotations#
+▸ getAnnotations(filter?): string[]
Parameters#
+| Name | +Type | +Default value | +
|---|---|---|
filter |
+boolean |
+false |
+
Returns#
+string[]
Inherited from#
+ ++
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
++
getDescription#
+▸ getDescription(): string
Returns#
+string
+
getFinalizers#
+▸ getFinalizers(): string[]
Returns#
+string[]
Inherited from#
+ ++
getGlobalDefault#
+▸ getGlobalDefault(): string
Returns#
+string
+
getId#
+▸ getId(): string
Returns#
+string
Inherited from#
+ ++
getLabels#
+▸ getLabels(): string[]
Returns#
+string[]
Inherited from#
+ ++
getName#
+▸ getName(): string
Returns#
+string
Inherited from#
+ ++
getNs#
+▸ getNs(): undefined
Returns#
+undefined
Inherited from#
+ ++
getOwnerRefs#
+▸ getOwnerRefs(): { apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: undefined ; uid: string }[]
Returns#
+{ apiVersion: string ; blockOwnerDeletion?: boolean ; controller?: boolean ; kind: string ; name: string ; namespace: undefined ; uid: string }[]
Inherited from#
+ ++
getPreemptionPolicy#
+▸ getPreemptionPolicy(): PreemptionPolicy
Returns#
+PreemptionPolicy
+
getResourceVersion#
+▸ getResourceVersion(): string
Returns#
+string
Inherited from#
+ ++
getScopedName#
+▸ getScopedName(): string
Returns#
+string
Inherited from#
+ ++
getSearchFields#
+▸ getSearchFields(): (undefined | string)[]
Returns#
+(undefined | string)[]
Inherited from#
+ ++
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#
+ ++
getValue#
+▸ getValue(): undefined | number
Returns#
+undefined | number
+
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#
+ ++
toPlainObject#
+▸ toPlainObject(): JsonObject
Returns#
+JsonObject
Inherited from#
+ ++
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<PriorityClass> |
+
Returns#
+Promise<null | KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>
Inherited from#
+ ++
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#
+ ++
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#
+ ++
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#
+ ++
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#
+ ++
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[]