Globals / "src/renderer/api/kube-api" / KubeApi
Class: KubeApi\#
Type parameters#
| Name | Type | Default |
|---|---|---|
T |
KubeObject | any |
Hierarchy#
- KubeApi
↳ PodsApi
↳ NodesApi
Index#
Constructors#
Properties#
- apiBase
- apiGroup
- apiPrefix
- apiResource
- apiVersion
- apiVersionWithGroup
- isNamespaced
- kind
- objectConstructor
- options
- request
- resourceVersions
- parseApi
Methods#
- create
- delete
- get
- getResourceVersion
- getUrl
- getWatchUrl
- list
- parseResponse
- refreshResourceVersion
- setResourceVersion
- update
- watch
- watchAll
Constructors#
constructor#
+ new KubeApi(options: IKubeApiOptions\
Defined in src/renderer/api/kube-api.ts:67
Parameters:
| Name | Type |
|---|---|
options |
IKubeApiOptions\ |
Returns: KubeApi
Properties#
apiBase#
• Readonly apiBase: string
Defined in src/renderer/api/kube-api.ts:57
apiGroup#
• Readonly apiGroup: string
Defined in src/renderer/api/kube-api.ts:59
apiPrefix#
• Readonly apiPrefix: string
Defined in src/renderer/api/kube-api.ts:58
apiResource#
• Readonly apiResource: string
Defined in src/renderer/api/kube-api.ts:62
apiVersion#
• Readonly apiVersion: string
Defined in src/renderer/api/kube-api.ts:60
apiVersionWithGroup#
• Readonly apiVersionWithGroup: string
Defined in src/renderer/api/kube-api.ts:61
isNamespaced#
• Readonly isNamespaced: boolean
Defined in src/renderer/api/kube-api.ts:63
kind#
• Readonly kind: string
Defined in src/renderer/api/kube-api.ts:56
objectConstructor#
• objectConstructor: IKubeObjectConstructor\
Defined in src/renderer/api/kube-api.ts:65
options#
• Protected options: IKubeApiOptions\
Defined in src/renderer/api/kube-api.ts:69
request#
• Protected request: KubeJsonApi
Defined in src/renderer/api/kube-api.ts:66
resourceVersions#
• Protected resourceVersions: Map\
Defined in src/renderer/api/kube-api.ts:67
parseApi#
▪ Static parseApi: parseKubeApi = parseKubeApi
Defined in src/renderer/api/kube-api.ts:49
Methods#
create#
▸ create(__namedParameters?: { name: string = ""; namespace: string = "default" }, data?: Partial\
Defined in src/renderer/api/kube-api.ts:158
Parameters:
| Name | Type | Default value |
|---|---|---|
__namedParameters |
{ name: string = ""; namespace: string = "default" } | {} |
data? |
Partial\ |
- |
Returns: Promise\
delete#
▸ delete(__namedParameters: { name: string = ""; namespace: string = "default" }): Promise\<KubeJsonApiData>
Defined in src/renderer/api/kube-api.ts:182
Parameters:
| Name | Type |
|---|---|
__namedParameters |
{ name: string = ""; namespace: string = "default" } |
Returns: Promise\<KubeJsonApiData>
get#
▸ get(__namedParameters?: { name: string = ""; namespace: string = "default" }, query?: IKubeApiQueryParams): Promise\
Defined in src/renderer/api/kube-api.ts:152
Parameters:
| Name | Type | Default value |
|---|---|---|
__namedParameters |
{ name: string = ""; namespace: string = "default" } | {} |
query? |
IKubeApiQueryParams | - |
Returns: Promise\
getResourceVersion#
▸ getResourceVersion(namespace?: string): string
Defined in src/renderer/api/kube-api.ts:100
Parameters:
| Name | Type | Default value |
|---|---|---|
namespace |
string | "" |
Returns: string
getUrl#
▸ getUrl(__namedParameters?: { name: string = ""; namespace: string = "" }, query?: Partial\<IKubeApiQueryParams>): string
Defined in src/renderer/api/kube-api.ts:108
Parameters:
| Name | Type | Default value |
|---|---|---|
__namedParameters |
{ name: string = ""; namespace: string = "" } | {} |
query? |
Partial\<IKubeApiQueryParams> | - |
Returns: string
getWatchUrl#
▸ getWatchUrl(namespace?: string, query?: IKubeApiQueryParams): string
Defined in src/renderer/api/kube-api.ts:187
Parameters:
| Name | Type | Default value |
|---|---|---|
namespace |
string | "" |
query |
IKubeApiQueryParams | {} |
Returns: string
list#
▸ list(__namedParameters?: { namespace: string = "" }, query?: IKubeApiQueryParams): Promise\
Defined in src/renderer/api/kube-api.ts:146
Parameters:
| Name | Type | Default value |
|---|---|---|
__namedParameters |
{ namespace: string = "" } | {} |
query? |
IKubeApiQueryParams | - |
Returns: Promise\
parseResponse#
▸ ProtectedparseResponse(data: KubeJsonApiData | KubeJsonApiData[] | KubeJsonApiDataList, namespace?: string): any
Defined in src/renderer/api/kube-api.ts:120
Parameters:
| Name | Type |
|---|---|
data |
KubeJsonApiData | KubeJsonApiData[] | KubeJsonApiDataList |
namespace? |
string |
Returns: any
refreshResourceVersion#
▸ refreshResourceVersion(params?: { namespace: string }): Promise\
Defined in src/renderer/api/kube-api.ts:104
Parameters:
| Name | Type |
|---|---|
params? |
{ namespace: string } |
Returns: Promise\
setResourceVersion#
▸ setResourceVersion(namespace?: string, newVersion: string): void
Defined in src/renderer/api/kube-api.ts:96
Parameters:
| Name | Type | Default value |
|---|---|---|
namespace |
string | "" |
newVersion |
string | - |
Returns: void
update#
▸ update(__namedParameters?: { name: string = ""; namespace: string = "default" }, data?: Partial\
Defined in src/renderer/api/kube-api.ts:175
Parameters:
| Name | Type | Default value |
|---|---|---|
__namedParameters |
{ name: string = ""; namespace: string = "default" } | {} |
data? |
Partial\ |
- |
Returns: Promise\
watch#
▸ watch(): function
Defined in src/renderer/api/kube-api.ts:195
Returns: function
watchAll#
▸ StaticwatchAll(...apis: KubeApi[]): (Anonymous function)
Defined in src/renderer/api/kube-api.ts:51
Parameters:
| Name | Type |
|---|---|
...apis |
KubeApi[] |
Returns: (Anonymous function)