Class: KubeApi ‹T›#
Type parameters#
▪ T: KubeObject
Hierarchy#
- KubeApi
↳ PodsApi
↳ NodesApi
Index#
Constructors#
Properties#
- apiBase
- apiGroup
- apiPrefix
- apiResource
- apiVersion
- apiVersionPreferred
- isNamespaced
- kind
- objectConstructor
- options
- request
- resourceVersions
- watchDisposer
Accessors#
Methods#
- checkPreferredVersion
- create
- delete
- get
- getResourceVersion
- getUrl
- getWatchUrl
- list
- modifyWatchEvent
- normalizeQuery
- parseResponse
- refreshResourceVersion
- setResourceVersion
- update
- watch
Constructors#
constructor#
+ new KubeApi(options: IKubeApiOptions‹T›): KubeApi
Defined in src/renderer/api/kube-api.ts:117
Parameters:
| Name | Type |
|---|---|
options |
IKubeApiOptions‹T› |
Returns: KubeApi
Properties#
apiBase#
• apiBase: string
Defined in src/renderer/api/kube-api.ts:106
apiGroup#
• apiGroup: string
Defined in src/renderer/api/kube-api.ts:108
apiPrefix#
• apiPrefix: string
Defined in src/renderer/api/kube-api.ts:107
apiResource#
• apiResource: string
Defined in src/renderer/api/kube-api.ts:111
apiVersion#
• apiVersion: string
Defined in src/renderer/api/kube-api.ts:109
Optional apiVersionPreferred#
• apiVersionPreferred? : string
Defined in src/renderer/api/kube-api.ts:110
isNamespaced#
• isNamespaced: boolean
Defined in src/renderer/api/kube-api.ts:112
kind#
• kind: string
Defined in src/renderer/api/kube-api.ts:105
objectConstructor#
• objectConstructor: IKubeObjectConstructor‹T›
Defined in src/renderer/api/kube-api.ts:114
Protected options#
• options: IKubeApiOptions‹T›
Defined in src/renderer/api/kube-api.ts:119
Protected request#
• request: KubeJsonApi
Defined in src/renderer/api/kube-api.ts:115
Protected resourceVersions#
• resourceVersions: Map‹string, string› = new Map
Defined in src/renderer/api/kube-api.ts:116
Protected watchDisposer#
• watchDisposer: function
Defined in src/renderer/api/kube-api.ts:117
Type declaration:#
▸ (): void
Accessors#
apiVersionWithGroup#
• get apiVersionWithGroup(): string
Defined in src/renderer/api/kube-api.ts:147
Returns: string
Methods#
Protected checkPreferredVersion#
▸ checkPreferredVersion(): Promise‹void›
Defined in src/renderer/api/kube-api.ts:209
Returns: Promise‹void›
create#
▸ create(__namedParameters: object, data?: Partial‹T›): Promise‹T›
Defined in src/renderer/api/kube-api.ts:330
Parameters:
▪Default value __namedParameters: object= {}
| Name | Type | Default |
|---|---|---|
name |
string | "" |
namespace |
string | "default" |
▪Optional data: Partial‹T›
Returns: Promise‹T›
delete#
▸ delete(__namedParameters: object): Promise‹KubeJsonApiData›
Defined in src/renderer/api/kube-api.ts:357
Parameters:
▪ __namedParameters: object
| Name | Type | Default |
|---|---|---|
name |
string | "" |
namespace |
string | "default" |
Returns: Promise‹KubeJsonApiData›
get#
▸ get(__namedParameters: object, query?: IKubeApiQueryParams): Promise‹T›
Defined in src/renderer/api/kube-api.ts:322
Parameters:
▪Default value __namedParameters: object= {}
| Name | Type | Default |
|---|---|---|
name |
string | "" |
namespace |
string | "default" |
▪Optional query: IKubeApiQueryParams
Returns: Promise‹T›
getResourceVersion#
▸ getResourceVersion(namespace: string): string
Defined in src/renderer/api/kube-api.ts:242
Parameters:
| Name | Type | Default |
|---|---|---|
namespace |
string | "" |
Returns: string
getUrl#
▸ getUrl(__namedParameters: object, query?: Partial‹IKubeApiQueryParams›): string
Defined in src/renderer/api/kube-api.ts:250
Parameters:
▪Default value __namedParameters: object= {}
| Name | Type | Default |
|---|---|---|
name |
string | "" |
namespace |
string | "" |
▪Optional query: Partial‹IKubeApiQueryParams›
Returns: string
getWatchUrl#
▸ getWatchUrl(namespace: string, query: IKubeApiQueryParams): string
Defined in src/renderer/api/kube-api.ts:364
Parameters:
| Name | Type | Default |
|---|---|---|
namespace |
string | "" |
query |
IKubeApiQueryParams | {} |
Returns: string
list#
▸ list(__namedParameters: object, query?: IKubeApiQueryParams): Promise‹T[]›
Defined in src/renderer/api/kube-api.ts:314
Parameters:
▪Default value __namedParameters: object= {}
| Name | Type | Default |
|---|---|---|
namespace |
string | "" |
▪Optional query: IKubeApiQueryParams
Returns: Promise‹T[]›
Protected modifyWatchEvent#
▸ modifyWatchEvent(event: IKubeWatchEvent): void
Defined in src/renderer/api/kube-api.ts:447
Parameters:
| Name | Type |
|---|---|
event |
IKubeWatchEvent |
Returns: void
Protected normalizeQuery#
▸ normalizeQuery(query: Partial‹IKubeApiQueryParams›): object
Defined in src/renderer/api/kube-api.ts:262
Parameters:
| Name | Type | Default |
|---|---|---|
query |
Partial‹IKubeApiQueryParams› | {} |
Returns: object
Protected parseResponse#
▸ parseResponse(data: KubeJsonApiData | KubeJsonApiData[] | KubeJsonApiDataList, namespace?: string): any
Defined in src/renderer/api/kube-api.ts:274
Parameters:
| Name | Type |
|---|---|
data |
KubeJsonApiData | KubeJsonApiData[] | KubeJsonApiDataList |
namespace? |
string |
Returns: any
refreshResourceVersion#
▸ refreshResourceVersion(params?: object): Promise‹T[]›
Defined in src/renderer/api/kube-api.ts:246
Parameters:
▪Optional params: object
| Name | Type |
|---|---|
namespace |
string |
Returns: Promise‹T[]›
setResourceVersion#
▸ setResourceVersion(namespace: string, newVersion: string): void
Defined in src/renderer/api/kube-api.ts:238
Parameters:
| Name | Type | Default |
|---|---|---|
namespace |
string | "" |
newVersion |
string | - |
Returns: void
update#
▸ update(__namedParameters: object, data?: Partial‹T›): Promise‹T›
Defined in src/renderer/api/kube-api.ts:348
Parameters:
▪Default value __namedParameters: object= {}
| Name | Type | Default |
|---|---|---|
name |
string | "" |
namespace |
string | "default" |
▪Optional data: Partial‹T›
Returns: Promise‹T›
watch#
▸ watch(opts: KubeApiWatchOptions): function
Defined in src/renderer/api/kube-api.ts:372
Parameters:
| Name | Type | Default |
|---|---|---|
opts |
KubeApiWatchOptions | { namespace: "" } |
Returns: function
▸ (): void