Globals / "src/renderer/api/endpoints/crd.api" / CustomResourceDefinition
Class: CustomResourceDefinition#
Hierarchy#
↳ CustomResourceDefinition
Implements#
Index#
Constructors#
Properties#
Accessors#
Methods#
- delete
- getAge
- getAnnotations
- getConditions
- getConversion
- getFinalizers
- getGroup
- getId
- getLabels
- getName
- getNames
- getNs
- getOwnerRefs
- getPluralName
- getPrinterColumns
- getResourceApiBase
- getResourceKind
- getResourceTitle
- getResourceUrl
- getResourceVersion
- getScope
- getSearchFields
- getStoredVersions
- getValidation
- getVersion
- isNamespaced
- toPlainObject
- update
- create
- isJsonApiData
- isJsonApiDataList
- isNonSystem
- stringifyLabels
Constructors#
constructor#
+ new CustomResourceDefinition(data: KubeJsonApiData): CustomResourceDefinition
Inherited from KubeObject.constructor
Defined in src/renderer/api/kube-object.ts:69
Parameters:
| Name | Type |
|---|---|
data |
KubeJsonApiData |
Returns: CustomResourceDefinition
Properties#
apiVersion#
• apiVersion: string
Inherited from KubeObject.apiVersion
Defined in src/renderer/api/kube-object.ts:75
kind#
• kind: string
Inherited from KubeObject.kind
Defined in src/renderer/api/kube-object.ts:76
metadata#
• metadata: IKubeObjectMetadata
Inherited from KubeObject.metadata
Defined in src/renderer/api/kube-object.ts:77
spec#
• spec: { additionalPrinterColumns?: AdditionalPrinterColumnsV1Beta[] ; conversion: { strategy?: string ; webhook?: any } ; group: string ; names: { kind: string ; listKind: string ; plural: string ; singular: string } ; scope: \"Namespaced\" | \"Cluster\" | string ; validation?: any ; version?: string ; versions: { additionalPrinterColumns?: AdditionalPrinterColumnsV1[] ; name: string ; schema?: unknown ; served: boolean ; storage: boolean }[] }
Defined in src/renderer/api/endpoints/crd.api.ts:25
Type declaration:
| Name | Type |
|---|---|
additionalPrinterColumns? |
AdditionalPrinterColumnsV1Beta[] |
conversion |
{ strategy?: string ; webhook?: any } |
group |
string |
names |
{ kind: string ; listKind: string ; plural: string ; singular: string } |
scope |
\"Namespaced\" | \"Cluster\" | string |
validation? |
any |
version? |
string |
versions |
{ additionalPrinterColumns?: AdditionalPrinterColumnsV1[] ; name: string ; schema?: unknown ; served: boolean ; storage: boolean }[] |
status#
• status: { acceptedNames: { kind: string ; listKind: string ; plural: string ; shortNames: string[] ; singular: string } ; conditions: { lastTransitionTime: string ; message: string ; reason: string ; status: string ; type?: string }[] ; storedVersions: string[] }
Overrides KubeObject.status
Defined in src/renderer/api/endpoints/crd.api.ts:49
Type declaration:
| Name | Type |
|---|---|
acceptedNames |
{ kind: string ; listKind: string ; plural: string ; shortNames: string[] ; singular: string } |
conditions |
{ lastTransitionTime: string ; message: string ; reason: string ; status: string ; type?: string }[] |
storedVersions |
string[] |
apiBase#
▪ Static apiBase: string = "/apis/apiextensions.k8s.io/v1/customresourcedefinitions"
Defined in src/renderer/api/endpoints/crd.api.ts:23
kind#
▪ Static kind: string = "CustomResourceDefinition"
Overrides KubeObject.kind
Defined in src/renderer/api/endpoints/crd.api.ts:21
namespaced#
▪ Static namespaced: boolean = false
Overrides KubeObject.namespaced
Defined in src/renderer/api/endpoints/crd.api.ts:22
Accessors#
selfLink#
• get selfLink(): string
Inherited from KubeObject.selfLink
Defined in src/renderer/api/kube-object.ts:80
Returns: string
Methods#
delete#
▸ delete(params?: JsonApiParams): CancelablePromise\<KubeJsonApiData>
Inherited from KubeObject.delete
Defined in src/renderer/api/kube-object.ts:160
Parameters:
| Name | Type |
|---|---|
params? |
JsonApiParams |
Returns: CancelablePromise\<KubeJsonApiData>
getAge#
▸ getAge(humanize?: boolean, compact?: boolean, fromNow?: boolean): string | number
Inherited from KubeObject.getAge
Defined in src/renderer/api/kube-object.ts:102
Parameters:
| Name | Type | Default value |
|---|---|---|
humanize |
boolean | true |
compact |
boolean | true |
fromNow |
boolean | false |
Returns: string | number
getAnnotations#
▸ getAnnotations(filter?: boolean): string[]
Inherited from KubeObject.getAnnotations
Defined in src/renderer/api/kube-object.ts:121
Parameters:
| Name | Type | Default value |
|---|---|---|
filter |
boolean | false |
Returns: string[]
getConditions#
▸ getConditions(): { isReady: boolean = status === "True"; tooltip: string = `${message || reason} (${lastTransitionTime})` }[]
Defined in src/renderer/api/endpoints/crd.api.ts:136
Returns: { isReady: boolean = status === "True"; tooltip: string = `${message || reason} (${lastTransitionTime})` }[]
getConversion#
▸ getConversion(): string
Defined in src/renderer/api/endpoints/crd.api.ts:119
Returns: string
getFinalizers#
▸ getFinalizers(): string[]
Inherited from KubeObject.getFinalizers
Defined in src/renderer/api/kube-object.ts:113
Returns: string[]
getGroup#
▸ getGroup(): string
Defined in src/renderer/api/endpoints/crd.api.ts:94
Returns: string
getId#
▸ getId(): string
Implementation of ItemObject
Inherited from KubeObject.getId
Defined in src/renderer/api/kube-object.ts:84
Returns: string
getLabels#
▸ getLabels(): string[]
Inherited from KubeObject.getLabels
Defined in src/renderer/api/kube-object.ts:117
Returns: string[]
getName#
▸ getName(): string
Implementation of ItemObject
Inherited from KubeObject.getName
Defined in src/renderer/api/kube-object.ts:92
Returns: string
getNames#
▸ getNames(): object
Defined in src/renderer/api/endpoints/crd.api.ts:115
Returns: object
| Name | Type |
|---|---|
kind |
string |
listKind |
string |
plural |
string |
singular |
string |
getNs#
▸ getNs(): string
Inherited from KubeObject.getNs
Defined in src/renderer/api/kube-object.ts:96
Returns: string
getOwnerRefs#
▸ getOwnerRefs(): { namespace: string = this.getNs() }[]
Inherited from KubeObject.getOwnerRefs
Defined in src/renderer/api/kube-object.ts:129
Returns: { namespace: string = this.getNs() }[]
getPluralName#
▸ getPluralName(): string
Defined in src/renderer/api/endpoints/crd.api.ts:81
Returns: string
getPrinterColumns#
▸ getPrinterColumns(ignorePriority?: boolean): AdditionalPrinterColumnsV1[]
Defined in src/renderer/api/endpoints/crd.api.ts:123
Parameters:
| Name | Type | Default value |
|---|---|---|
ignorePriority |
boolean | true |
Returns: AdditionalPrinterColumnsV1[]
getResourceApiBase#
▸ getResourceApiBase(): string
Defined in src/renderer/api/endpoints/crd.api.ts:76
Returns: string
getResourceKind#
▸ getResourceKind(): string
Defined in src/renderer/api/endpoints/crd.api.ts:85
Returns: string
getResourceTitle#
▸ getResourceTitle(): string
Defined in src/renderer/api/endpoints/crd.api.ts:89
Returns: string
getResourceUrl#
▸ getResourceUrl(): string
Defined in src/renderer/api/endpoints/crd.api.ts:67
Returns: string
getResourceVersion#
▸ getResourceVersion(): string
Inherited from KubeObject.getResourceVersion
Defined in src/renderer/api/kube-object.ts:88
Returns: string
getScope#
▸ getScope(): string
Defined in src/renderer/api/endpoints/crd.api.ts:98
Returns: string
getSearchFields#
▸ getSearchFields(): string[]
Inherited from KubeObject.getSearchFields
Defined in src/renderer/api/kube-object.ts:137
Returns: string[]
getStoredVersions#
▸ getStoredVersions(): string
Defined in src/renderer/api/endpoints/crd.api.ts:111
Returns: string
getValidation#
▸ getValidation(): string
Defined in src/renderer/api/endpoints/crd.api.ts:132
Returns: string
getVersion#
▸ getVersion(): string
Defined in src/renderer/api/endpoints/crd.api.ts:102
Returns: string
isNamespaced#
▸ isNamespaced(): boolean
Defined in src/renderer/api/endpoints/crd.api.ts:107
Returns: boolean
toPlainObject#
▸ toPlainObject(): object
Inherited from KubeObject.toPlainObject
Defined in src/renderer/api/kube-object.ts:148
Returns: object
update#
▸ update\data: Partial\
Inherited from KubeObject.update
Defined in src/renderer/api/kube-object.ts:153
Type parameters:
| Name | Type |
|---|---|
T |
KubeObject |
Parameters:
| Name | Type |
|---|---|
data |
Partial\ |
Returns: Promise\
create#
▸ Staticcreate(data: any): KubeObject
Inherited from KubeObject.create
Defined in src/renderer/api/kube-object.ts:50
Parameters:
| Name | Type |
|---|---|
data |
any |
Returns: KubeObject
isJsonApiData#
▸ StaticisJsonApiData(object: any): object is KubeJsonApiData
Inherited from KubeObject.isJsonApiData
Defined in src/renderer/api/kube-object.ts:58
Parameters:
| Name | Type |
|---|---|
object |
any |
Returns: object is KubeJsonApiData
isJsonApiDataList#
▸ StaticisJsonApiDataList(object: any): object is KubeJsonApiDataList
Inherited from KubeObject.isJsonApiDataList
Defined in src/renderer/api/kube-object.ts:62
Parameters:
| Name | Type |
|---|---|
object |
any |
Returns: object is KubeJsonApiDataList
isNonSystem#
▸ StaticisNonSystem(item: KubeJsonApiData | KubeObject): boolean
Inherited from KubeObject.isNonSystem
Defined in src/renderer/api/kube-object.ts:54
Parameters:
| Name | Type |
|---|---|
item |
KubeJsonApiData | KubeObject |
Returns: boolean
stringifyLabels#
▸ StaticstringifyLabels(labels: { [name:string]: string; }): string[]
Inherited from KubeObject.stringifyLabels
Defined in src/renderer/api/kube-object.ts:66
Parameters:
| Name | Type |
|---|---|
labels |
{ [name:string]: string; } |
Returns: string[]