@k8slens/extensions

Globals / "src/renderer/api/endpoints/cluster.api" / ClusterApi

Class: ClusterApi

Hierarchy

• KubeApi\<Cluster>

↳ ClusterApi

Index

Constructors

• constructor

Properties

• apiBase
• apiGroup
• apiPrefix
• apiResource
• apiVersion
• apiVersionWithGroup
• isNamespaced
• kind
• objectConstructor
• options
• request
• resourceVersions
• kind
• namespaced
• parseApi

Methods

• create
• delete
• get
• getMetrics
• getResourceVersion
• getUrl
• getWatchUrl
• list
• parseResponse
• refreshResourceVersion
• setResourceVersion
• update
• watch
• watchAll

Constructors

constructor

+ new ClusterApi(options: IKubeApiOptions\<Cluster>): ClusterApi

Inherited from KubeApi.constructor

Defined in src/renderer/api/kube-api.ts:67

Parameters:

Name	Type
options	IKubeApiOptions\<Cluster>

Returns: ClusterApi

Properties

apiBase

• Readonly apiBase: string

Inherited from KubeApi.apiBase

Defined in src/renderer/api/kube-api.ts:57

---

apiGroup

• Readonly apiGroup: string

Inherited from KubeApi.apiGroup

Defined in src/renderer/api/kube-api.ts:59

---

apiPrefix

• Readonly apiPrefix: string

Inherited from KubeApi.apiPrefix

Defined in src/renderer/api/kube-api.ts:58

---

apiResource

• Readonly apiResource: string

Inherited from KubeApi.apiResource

Defined in src/renderer/api/kube-api.ts:62

---

apiVersion

• Readonly apiVersion: string

Inherited from KubeApi.apiVersion

Defined in src/renderer/api/kube-api.ts:60

---

apiVersionWithGroup

• Readonly apiVersionWithGroup: string

Inherited from KubeApi.apiVersionWithGroup

Defined in src/renderer/api/kube-api.ts:61

---

isNamespaced

• Readonly isNamespaced: boolean

Inherited from KubeApi.isNamespaced

Defined in src/renderer/api/kube-api.ts:63

---

kind

• Readonly kind: string

Inherited from KubeApi.kind

Defined in src/renderer/api/kube-api.ts:56

---

objectConstructor

• objectConstructor: IKubeObjectConstructor\<Cluster>

Inherited from KubeApi.objectConstructor

Defined in src/renderer/api/kube-api.ts:65

---

options

• Protected options: IKubeApiOptions\<Cluster>

Inherited from KubeApi.options

Defined in src/renderer/api/kube-api.ts:69

---

request

• Protected request: KubeJsonApi

Inherited from KubeApi.request

Defined in src/renderer/api/kube-api.ts:66

---

resourceVersions

• Protected resourceVersions: Map\ = new Map\()

Inherited from KubeApi.resourceVersions

Defined in src/renderer/api/kube-api.ts:67

---

kind

▪ Static kind: string = "Cluster"

Defined in src/renderer/api/endpoints/cluster.api.ts:6

---

namespaced

▪ Static namespaced: boolean = true

Defined in src/renderer/api/endpoints/cluster.api.ts:7

---

parseApi

▪ Static parseApi: parseKubeApi = parseKubeApi

Inherited from KubeApi.parseApi

Defined in src/renderer/api/kube-api.ts:49

Methods

create

▸ create(__namedParameters?: { name: string = ""; namespace: string = "default" }, data?: Partial\<Cluster>): Promise\<Cluster>

Inherited from KubeApi.create

Defined in src/renderer/api/kube-api.ts:158

Parameters:

Name	Type	Default value
__namedParameters	{ name: string = ""; namespace: string = "default" }	{}
data?	Partial\<Cluster>	-

Returns: Promise\<Cluster>

---

delete

▸ delete(__namedParameters: { name: string = ""; namespace: string = "default" }): Promise\<KubeJsonApiData>

Inherited from KubeApi.delete

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\<Cluster>

Inherited from KubeApi.get

Defined in src/renderer/api/kube-api.ts:152

Parameters:

Name	Type	Default value
__namedParameters	{ name: string = ""; namespace: string = "default" }	{}
query?	IKubeApiQueryParams	-

Returns: Promise\<Cluster>

---

getMetrics

▸ getMetrics(nodeNames: string[], params?: IMetricsReqParams): Promise\<IClusterMetrics>

Defined in src/renderer/api/endpoints/cluster.api.ts:9

Parameters:

Name	Type
nodeNames	string[]
params?	IMetricsReqParams

Returns: Promise\<IClusterMetrics>

---

getResourceVersion

▸ getResourceVersion(namespace?: string): string

Inherited from KubeApi.getResourceVersion

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

Inherited from KubeApi.getUrl

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

Inherited from KubeApi.getWatchUrl

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\<Cluster[]>

Inherited from KubeApi.list

Defined in src/renderer/api/kube-api.ts:146

Parameters:

Name	Type	Default value
__namedParameters	{ namespace: string = "" }	{}
query?	IKubeApiQueryParams	-

Returns: Promise\<Cluster[]>

---

parseResponse

▸ ProtectedparseResponse(data: KubeJsonApiData | KubeJsonApiData[] | KubeJsonApiDataList, namespace?: string): any

Inherited from KubeApi.parseResponse

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\

Inherited from KubeApi.refreshResourceVersion

Defined in src/renderer/api/kube-api.ts:104

Parameters:

Name	Type
params?	{ namespace: string }

Returns: Promise\

---

setResourceVersion

▸ setResourceVersion(namespace?: string, newVersion: string): void

Inherited from KubeApi.setResourceVersion

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\<Cluster>): Promise\<Cluster>

Inherited from KubeApi.update

Defined in src/renderer/api/kube-api.ts:175

Parameters:

Name	Type	Default value
__namedParameters	{ name: string = ""; namespace: string = "default" }	{}
data?	Partial\<Cluster>	-

Returns: Promise\<Cluster>

---

watch

▸ watch(): function

Inherited from KubeApi.watch

Defined in src/renderer/api/kube-api.ts:195

Returns: function

---

watchAll

▸ StaticwatchAll(...apis: KubeApi[]): (Anonymous function)

Inherited from KubeApi.watchAll

Defined in src/renderer/api/kube-api.ts:51

Parameters:

Name	Type
...apis	KubeApi[]

Returns: (Anonymous function)

---

Last update: November 10, 2020