Class: DeploymentApi

Renderer.K8sApi.DeploymentApi

Hierarchy

• KubeApi<Deployment>

↳ DeploymentApi

Table of contents

Constructors

• constructor

Properties

• apiBase
• apiGroup
• apiPrefix
• apiResource
• apiVersion
• apiVersionPreferred
• doCheckPreferredVersion
• fallbackApiBases
• fullApiPathname
• isNamespaced
• kind
• objectConstructor
• request
• resourceVersions
• watchDisposer

Accessors

• apiVersionWithGroup

Methods

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

Constructors

constructor

• new DeploymentApi(opts?)

Parameters

Name	Type
opts?	DerivedKubeApiOptions

Overrides

KubeApi.constructor

Properties

apiBase

• apiBase: string

Inherited from

KubeApi.apiBase

---

apiGroup

• apiGroup: string

Inherited from

KubeApi.apiGroup

---

apiPrefix

• apiPrefix: string

Inherited from

KubeApi.apiPrefix

---

apiResource

• Readonly apiResource: string

Inherited from

KubeApi.apiResource

---

apiVersion

• Readonly apiVersion: string

Inherited from

KubeApi.apiVersion

---

apiVersionPreferred

• apiVersionPreferred: undefined | string

Inherited from

KubeApi.apiVersionPreferred

---

doCheckPreferredVersion

• Protected Readonly doCheckPreferredVersion: boolean

Inherited from

KubeApi.doCheckPreferredVersion

---

fallbackApiBases

• Protected Readonly fallbackApiBases: undefined | string[]

Inherited from

KubeApi.fallbackApiBases

---

fullApiPathname

• Protected Readonly fullApiPathname: string

Inherited from

KubeApi.fullApiPathname

---

isNamespaced

• Readonly isNamespaced: boolean

Inherited from

KubeApi.isNamespaced

---

kind

• Readonly kind: string

Inherited from

KubeApi.kind

---

objectConstructor

• Readonly objectConstructor: KubeObjectConstructor<Deployment, KubeJsonApiData<NamespaceScopedMetadata, DeploymentStatus, DeploymentSpec>>

Inherited from

KubeApi.objectConstructor

---

request

• Protected Readonly request: KubeJsonApi

Inherited from

KubeApi.request

---

resourceVersions

• Protected Readonly resourceVersions: Map<string, string>

Inherited from

KubeApi.resourceVersions

---

watchDisposer

• Protected Readonly watchDisposer: undefined | Disposer

Inherited from

KubeApi.watchDisposer

Accessors

apiVersionWithGroup

• get apiVersionWithGroup(): string

Returns

string

Inherited from

KubeApi.apiVersionWithGroup

Methods

checkPreferredVersion

▸ Protected checkPreferredVersion(): Promise<void>

Returns

Promise<void>

Inherited from

KubeApi.checkPreferredVersion

---

create

▸ create(__namedParameters, partialData?): Promise<null | Deployment>

Parameters

Name	Type
__namedParameters	Partial<ResourceDescriptor>
partialData?	PartialObjectDeep<Deployment>

Returns

Promise<null | Deployment>

Inherited from

KubeApi.create

---

delete

▸ delete(__namedParameters): Promise<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Parameters

Name	Type
__namedParameters	DeleteResourceDescriptor

Returns

Promise<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Inherited from

KubeApi.delete

---

get

▸ get(desc, query?): Promise<null | Deployment>

Parameters

Name	Type
desc	ResourceDescriptor
query?	KubeApiQueryParams

Returns

Promise<null | Deployment>

Inherited from

KubeApi.get

---

getReplicas

▸ getReplicas(params): Promise<number>

Parameters

Name	Type
params	Object
params.name	string
params.namespace	string

Returns

Promise<number>

---

getResourceVersion

▸ getResourceVersion(namespace?): undefined | string

Parameters

Name	Type	Default value
namespace	string	""

Returns

undefined | string

Inherited from

KubeApi.getResourceVersion

---

getScaleApiUrl

▸ Protected getScaleApiUrl(params): string

Parameters

Name	Type
params	Object
params.name	string
params.namespace	string

Returns

string

---

getUrl

▸ getUrl(__namedParameters?, query?): string

Parameters

Name	Type
__namedParameters	Partial<ResourceDescriptor>
query?	Partial<KubeApiQueryParams>

Returns

string

Inherited from

KubeApi.getUrl

---

getWatchUrl

▸ getWatchUrl(namespace?, query?): string

Parameters

Name	Type	Default value
namespace	string	""
query	KubeApiQueryParams	{}

Returns

string

Inherited from

KubeApi.getWatchUrl

---

list

▸ list(__namedParameters?, query?): Promise<null | Deployment[]>

Parameters

Name	Type
__namedParameters	KubeApiListOptions
query?	KubeApiQueryParams

Returns

Promise<null | Deployment[]>

Inherited from

KubeApi.list

---

modifyWatchEvent

▸ Protected modifyWatchEvent(event): void

Parameters

Name	Type
event	IKubeWatchEvent<KubeJsonApiData<KubeObjectMetadata<KubeObjectScope>, unknown, unknown>>

Returns

void

Inherited from

KubeApi.modifyWatchEvent

---

normalizeQuery

▸ Protected normalizeQuery(query?): Partial<KubeApiQueryParams>

Parameters

Name	Type
query	Partial<KubeApiQueryParams>

Returns

Partial<KubeApiQueryParams>

Inherited from

KubeApi.normalizeQuery

---

parseResponse

▸ Protected parseResponse(data, namespace?): null | Deployment | Deployment[]

Parameters

Name	Type
data	unknown
namespace?	string

Returns

null | Deployment | Deployment[]

Inherited from

KubeApi.parseResponse

---

patch

▸ patch(desc, data, strategy?): Promise<null | Deployment>

Parameters

Name	Type	Default value
desc	ResourceDescriptor	undefined
data	Patch | PartialObjectDeep<Deployment>	undefined
strategy	KubeApiPatchType	"strategic"

Returns

Promise<null | Deployment>

Inherited from

KubeApi.patch

---

refreshResourceVersion

▸ refreshResourceVersion(params?): Promise<null | Deployment[]>

Parameters

Name	Type
params?	KubeApiListOptions

Returns

Promise<null | Deployment[]>

Inherited from

KubeApi.refreshResourceVersion

---

restart

▸ restart(params): Promise<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Parameters

Name	Type
params	Object
params.name	string
params.namespace	string

Returns

Promise<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

---

scale

▸ scale(params, replicas): Promise<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

Parameters

Name	Type
params	Object
params.name	string
params.namespace	string
replicas	number

Returns

Promise<KubeJsonApiData<KubeJsonApiObjectMetadata<KubeObjectScope>, unknown, unknown>>

---

setResourceVersion

▸ setResourceVersion(namespace?, newVersion): void

Parameters

Name	Type	Default value
namespace	string	""
newVersion	string	undefined

Returns

void

Inherited from

KubeApi.setResourceVersion

---

update

▸ update(__namedParameters, data): Promise<null | Deployment>

Parameters

Name	Type
__namedParameters	ResourceDescriptor
data	PartialObjectDeep<Deployment>

Returns

Promise<null | Deployment>

Inherited from

KubeApi.update

---

watch

▸ watch(opts?): () => void

Parameters

Name	Type
opts	KubeApiWatchOptions<Deployment, KubeJsonApiData<NamespaceScopedMetadata, DeploymentStatus, DeploymentSpec>>

Returns

fn

▸ (): void

Returns

void

Inherited from

KubeApi.watch