Class: CustomResourceDefinition#
Renderer.K8sApi.CustomResourceDefinition
Hierarchy#
↳ CustomResourceDefinition
Table of contents#
Constructors#
Properties#
Accessors#
Methods#
- delete
- getAge
- getAnnotations
- getConditions
- getConversion
- getFinalizers
- getGroup
- getId
- getLabels
- getName
- getNames
- getNs
- getOwnerRefs
- getPluralName
- getPreferedVersion
- getPrinterColumns
- getResourceApiBase
- getResourceKind
- getResourceTitle
- getResourceUrl
- getResourceVersion
- getScope
- getSearchFields
- getStoredVersions
- getTimeDiffFromNow
- getValidation
- getVersion
- isNamespaced
- patch
- toPlainObject
- update
- create
- isJsonApiData
- isJsonApiDataList
- isKubeJsonApiListMetadata
- isKubeJsonApiMetadata
- isNonSystem
- isPartialJsonApiData
- isPartialJsonApiMetadata
- stringifyLabels
Constructors#
constructor#
• new CustomResourceDefinition(data
)
Parameters#
Name | Type |
---|---|
data |
CRDApiData |
Inherited from#
Properties#
apiVersion#
• apiVersion: string
Inherited from#
kind#
• kind: string
Inherited from#
managedFields#
• Optional
managedFields: any
Inherited from#
metadata#
• metadata: KubeObjectMetadata
Inherited from#
spec#
• spec: Object
Type declaration#
Name | Type |
---|---|
additionalPrinterColumns? |
AdditionalPrinterColumnsV1Beta [] |
conversion |
Object |
conversion.strategy? |
string |
conversion.webhook? |
any |
group |
string |
names |
Object |
names.kind |
string |
names.listKind |
string |
names.plural |
string |
names.singular |
string |
scope |
string |
validation? |
object |
version? |
string |
versions? |
CRDVersion [] |
Inherited from#
status#
• status: Object
Type declaration#
Name | Type |
---|---|
acceptedNames |
Object |
acceptedNames.kind |
string |
acceptedNames.listKind |
string |
acceptedNames.plural |
string |
acceptedNames.shortNames |
string [] |
acceptedNames.singular |
string |
conditions |
{ lastTransitionTime : string ; message : string ; reason : string ; status : string ; type? : string }[] |
storedVersions |
string [] |
Inherited from#
apiBase#
▪ Static
apiBase: string
= "/apis/apiextensions.k8s.io/v1/customresourcedefinitions"
Inherited from#
kind#
▪ Static
kind: string
= "CustomResourceDefinition"
Inherited from#
namespaced#
▪ Static
namespaced: boolean
= false
Inherited from#
Accessors#
selfLink#
• get
selfLink(): string
Returns#
string
Methods#
delete#
▸ delete(params?
): Promise
<KubeJsonApiData
>
deprecated
use KubeApi.delete instead
Parameters#
Name | Type |
---|---|
params? |
JsonApiParams <any > |
Returns#
Promise
<KubeJsonApiData
>
Inherited from#
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#
getAnnotations#
▸ getAnnotations(filter?
): string
[]
Parameters#
Name | Type | Default value |
---|---|---|
filter |
boolean |
false |
Returns#
string
[]
Inherited from#
getConditions#
▸ getConditions(): { isReady
: boolean
; lastTransitionTime
: string
; message
: string
; reason
: string
; status
: string
; tooltip
: string
; type?
: string
}[]
Returns#
{ isReady
: boolean
; lastTransitionTime
: string
; message
: string
; reason
: string
; status
: string
; tooltip
: string
; type?
: string
}[]
getConversion#
▸ getConversion(): string
Returns#
string
getFinalizers#
▸ getFinalizers(): string
[]
Returns#
string
[]
Inherited from#
getGroup#
▸ getGroup(): string
Returns#
string
getId#
▸ getId(): string
Returns#
string
Inherited from#
getLabels#
▸ getLabels(): string
[]
Returns#
string
[]
Inherited from#
getName#
▸ getName(): string
Returns#
string
Inherited from#
getNames#
▸ getNames(): Object
Returns#
Object
Name | Type |
---|---|
kind |
string |
listKind |
string |
plural |
string |
singular |
string |
getNs#
▸ getNs(): string
Returns#
string
Inherited from#
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#
getPluralName#
▸ getPluralName(): string
Returns#
string
getPreferedVersion#
▸ getPreferedVersion(): CRDVersion
Returns#
CRDVersion
getPrinterColumns#
▸ getPrinterColumns(ignorePriority?
): AdditionalPrinterColumnsV1
[]
Parameters#
Name | Type | Default value |
---|---|---|
ignorePriority |
boolean |
true |
Returns#
AdditionalPrinterColumnsV1
[]
getResourceApiBase#
▸ getResourceApiBase(): string
Returns#
string
getResourceKind#
▸ getResourceKind(): string
Returns#
string
getResourceTitle#
▸ getResourceTitle(): string
Returns#
string
getResourceUrl#
▸ getResourceUrl(): string
Returns#
string
getResourceVersion#
▸ getResourceVersion(): string
Returns#
string
Inherited from#
getScope#
▸ getScope(): string
Returns#
string
getSearchFields#
▸ getSearchFields(): string
[]
Returns#
string
[]
Inherited from#
getStoredVersions#
▸ getStoredVersions(): string
Returns#
string
getTimeDiffFromNow#
▸ getTimeDiffFromNow(): number
Returns#
number
Inherited from#
getValidation#
▸ getValidation(): string
Returns#
string
getVersion#
▸ getVersion(): string
Returns#
string
isNamespaced#
▸ isNamespaced(): boolean
Returns#
boolean
patch#
▸ patch(patch
): Promise
<KubeJsonApiData
>
deprecated
use KubeApi.patch instead
Parameters#
Name | Type |
---|---|
patch |
Patch |
Returns#
Promise
<KubeJsonApiData
>
Inherited from#
toPlainObject#
▸ toPlainObject(): object
Returns#
object
Inherited from#
update#
▸ update(data
): Promise
<KubeJsonApiData
>
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 <CustomResourceDefinition > |
Returns#
Promise
<KubeJsonApiData
>
Inherited from#
create#
▸ Static
create(data
): KubeObject
<KubeObjectMetadata
, any
, any
>
Parameters#
Name | Type |
---|---|
data |
KubeJsonApiData |
Returns#
KubeObject
<KubeObjectMetadata
, any
, any
>
Inherited from#
isJsonApiData#
▸ Static
isJsonApiData(object
): object is KubeJsonApiData
Parameters#
Name | Type |
---|---|
object |
unknown |
Returns#
object is KubeJsonApiData
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 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#
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
[]