Class: DeploymentApi

Hierarchy

• KubeApi‹Deployment›

↳ DeploymentApi

Index

Constructors

• constructor

Properties

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

Accessors

• apiVersionWithGroup

Methods

• checkPreferredVersion
• create
• delete
• get
• getReplicas
• getResourceVersion
• getScaleApiUrl
• getUrl
• getWatchUrl
• list
• normalizeQuery
• parseResponse
• refreshResourceVersion
• restart
• scale
• setResourceVersion
• update
• watch
• watchAll

Constructors

constructor

+ new DeploymentApi(options: IKubeApiOptions‹Deployment›): DeploymentApi

Inherited from KubeApi.constructor

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

Parameters:

Name	Type
options	IKubeApiOptions‹Deployment›

Returns: DeploymentApi

Properties

apiBase

• apiBase: string

Inherited from KubeApi.apiBase

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

---

apiGroup

• apiGroup: string

Inherited from KubeApi.apiGroup

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

---

apiPrefix

• apiPrefix: string

Inherited from KubeApi.apiPrefix

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

---

apiResource

• apiResource: string

Inherited from KubeApi.apiResource

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

---

apiVersion

• apiVersion: string

Inherited from KubeApi.apiVersion

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

---

Optional apiVersionPreferred

• apiVersionPreferred? : string

Inherited from KubeApi.apiVersionPreferred

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

---

isNamespaced

• isNamespaced: boolean

Inherited from KubeApi.isNamespaced

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

---

kind

• kind: string

Inherited from KubeApi.kind

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

---

objectConstructor

• objectConstructor: IKubeObjectConstructor‹Deployment›

Inherited from KubeApi.objectConstructor

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

---

Protected options

• options: IKubeApiOptions‹Deployment›

Inherited from KubeApi.options

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

---

Protected request

• request: KubeJsonApi

Inherited from KubeApi.request

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

---

Protected resourceVersions

• resourceVersions: Map‹string, string› = new Map()

Inherited from KubeApi.resourceVersions

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

---

Static parseApi

▪ parseApi: parseKubeApi = parseKubeApi

Inherited from KubeApi.parseApi

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

Accessors

apiVersionWithGroup

• get apiVersionWithGroup(): string

Inherited from KubeApi.apiVersionWithGroup

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

Returns: string

Methods

Protected checkPreferredVersion

▸ checkPreferredVersion(): Promise‹void›

Inherited from KubeApi.checkPreferredVersion

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

Returns: Promise‹void›

---

create

▸ create(__namedParameters: object, data?: Partial‹Deployment›): Promise‹Deployment›

Inherited from KubeApi.create

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

Parameters:

▪Default value __namedParameters: object= {}

Name	Type	Default
name	string	""
namespace	string	"default"

▪Optional data: Partial‹Deployment›

Returns: Promise‹Deployment›

---

delete

▸ delete(__namedParameters: object): Promise‹KubeJsonApiData›

Inherited from KubeApi.delete

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

Parameters:

▪ __namedParameters: object

Name	Type	Default
name	string	""
namespace	string	"default"

Returns: Promise‹KubeJsonApiData›

---

get

▸ get(__namedParameters: object, query?: IKubeApiQueryParams): Promise‹Deployment›

Inherited from KubeApi.get

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

Parameters:

▪Default value __namedParameters: object= {}

Name	Type	Default
name	string	""
namespace	string	"default"

▪Optional query: IKubeApiQueryParams

Returns: Promise‹Deployment›

---

getReplicas

▸ getReplicas(params: object): Promise‹number›

Defined in src/renderer/api/endpoints/deployment.api.ts:12

Parameters:

▪ params: object

Name	Type
name	string
namespace	string

Returns: Promise‹number›

---

getResourceVersion

▸ getResourceVersion(namespace: string): string

Inherited from KubeApi.getResourceVersion

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

Parameters:

Name	Type	Default
namespace	string	""

Returns: string

---

Protected getScaleApiUrl

▸ getScaleApiUrl(params: object): string

Defined in src/renderer/api/endpoints/deployment.api.ts:8

Parameters:

▪ params: object

Name	Type
name	string
namespace	string

Returns: string

---

getUrl

▸ getUrl(__namedParameters: object, query?: Partial‹IKubeApiQueryParams›): string

Inherited from KubeApi.getUrl

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

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

Inherited from KubeApi.getWatchUrl

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

Parameters:

Name	Type	Default
namespace	string	""
query	IKubeApiQueryParams	{}

Returns: string

---

list

▸ list(__namedParameters: object, query?: IKubeApiQueryParams): Promise‹Deployment[]›

Inherited from KubeApi.list

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

Parameters:

▪Default value __namedParameters: object= {}

Name	Type	Default
namespace	string	""

▪Optional query: IKubeApiQueryParams

Returns: Promise‹Deployment[]›

---

Protected normalizeQuery

▸ normalizeQuery(query: Partial‹IKubeApiQueryParams›): object

Inherited from KubeApi.normalizeQuery

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

Parameters:

Name	Type	Default
query	Partial‹IKubeApiQueryParams›	{}

Returns: object

---

Protected parseResponse

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

Inherited from KubeApi.parseResponse

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

Parameters:

Name	Type
data	KubeJsonApiData | KubeJsonApiData[] | KubeJsonApiDataList
namespace?	string

Returns: any

---

refreshResourceVersion

▸ refreshResourceVersion(params?: object): Promise‹T[]›

Inherited from KubeApi.refreshResourceVersion

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

Parameters:

▪Optional params: object

Name	Type
namespace	string

Returns: Promise‹T[]›

---

restart

▸ restart(params: object): CancelablePromise‹KubeJsonApiData›

Defined in src/renderer/api/endpoints/deployment.api.ts:29

Parameters:

▪ params: object

Name	Type
name	string
namespace	string

Returns: CancelablePromise‹KubeJsonApiData›

---

scale

▸ scale(params: object, replicas: number): CancelablePromise‹KubeJsonApiData›

Defined in src/renderer/api/endpoints/deployment.api.ts:18

Parameters:

▪ params: object

Name	Type
name	string
namespace	string

▪ replicas: number

Returns: CancelablePromise‹KubeJsonApiData›

---

setResourceVersion

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

Inherited from KubeApi.setResourceVersion

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

Parameters:

Name	Type	Default
namespace	string	""
newVersion	string	-

Returns: void

---

update

▸ update(__namedParameters: object, data?: Partial‹Deployment›): Promise‹Deployment›

Inherited from KubeApi.update

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

Parameters:

▪Default value __namedParameters: object= {}

Name	Type	Default
name	string	""
namespace	string	"default"

▪Optional data: Partial‹Deployment›

Returns: Promise‹Deployment›

---

watch

▸ watch(): function

Inherited from KubeApi.watch

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

Returns: function

▸ (): void

---

Static watchAll

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

Inherited from KubeApi.watchAll

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

Parameters:

Name	Type
...apis	KubeApi[]

Returns: (Anonymous function)