Class: DeploymentStore#
Renderer.K8sApi.DeploymentStore
Hierarchy#
KubeObjectStore<Deployment,DeploymentApi>
↳ DeploymentStore
Table of contents#
Constructors#
Properties#
- api
- bufferSize
- dependencies
- eventsBuffer
- failedLoading
- isLoaded
- isLoading
- items
- limit
- selectedItemsIds
Accessors#
Methods#
- [iterator]
- bindWatchEventsUpdater
- create
- createItem
- defaultSorting
- filterItemsOnLoad
- getAllByNs
- getById
- getByLabel
- getByName
- getByPath
- getChildPods
- getIndexById
- getItems
- getStatuses
- getTotalCount
- isSelected
- isSelectedAll
- load
- loadAll
- loadFromPath
- loadItem
- loadItems
- mergeItems
- patch
- pickOnlySelected
- reloadAll
- remove
- removeItem
- removeItems
- removeSelectedItems
- reset
- resetOnError
- resetSelection
- select
- sortItems
- subscribe
- toggleSelection
- toggleSelectionAll
- unselect
- update
- updateFromEventsBuffer
- updateItem
Constructors#
constructor#
• new DeploymentStore(dependencies, api, opts?)
Parameters#
| Name | Type |
|---|---|
dependencies |
DeploymentStoreDependencies |
api |
DeploymentApi |
opts? |
KubeObjectStoreOptions |
Overrides#
KubeObjectStore<Deployment, DeploymentApi\>.constructor
Properties#
api#
• Readonly api: DeploymentApi
Inherited from#
KubeObjectStore.api
bufferSize#
• Readonly bufferSize: number
Inherited from#
KubeObjectStore.bufferSize
dependencies#
• Protected Readonly dependencies: DeploymentStoreDependencies
Inherited from#
KubeObjectStore.dependencies
eventsBuffer#
• Protected Readonly eventsBuffer: IObservableArray<IKubeWatchEvent<KubeJsonApiData<NamespaceScopedMetadata, DeploymentStatus, DeploymentSpec>>>
Inherited from#
KubeObjectStore.eventsBuffer
failedLoading#
• failedLoading: boolean = false
Inherited from#
KubeObjectStore.failedLoading
isLoaded#
• isLoaded: boolean = false
Inherited from#
KubeObjectStore.isLoaded
isLoading#
• isLoading: boolean = false
Inherited from#
KubeObjectStore.isLoading
items#
• items: IObservableArray<Deployment>
Inherited from#
KubeObjectStore.items
limit#
• Readonly limit: undefined | number
Inherited from#
KubeObjectStore.limit
selectedItemsIds#
• selectedItemsIds: ObservableSet<string>
Inherited from#
KubeObjectStore.selectedItemsIds
Accessors#
contextItems#
• get contextItems(): K[]
Returns#
K[]
Inherited from#
KubeObjectStore.contextItems
query#
• get query(): KubeApiQueryParams
Returns#
KubeApiQueryParams
Inherited from#
KubeObjectStore.query
selectedItems#
• get selectedItems(): Item[]
Returns#
Item[]
Inherited from#
KubeObjectStore.selectedItems
Methods#
[iterator]#
▸ [iterator](): Generator<Deployment, void, undefined>
Returns#
Generator<Deployment, void, undefined>
Inherited from#
KubeObjectStore.__@iterator@212
bindWatchEventsUpdater#
▸ Protected bindWatchEventsUpdater(delay?): void
Parameters#
| Name | Type | Default value |
|---|---|---|
delay |
number |
1000 |
Returns#
void
Inherited from#
KubeObjectStore.bindWatchEventsUpdater
create#
▸ create(params, data?): Promise<Deployment>
Parameters#
| Name | Type |
|---|---|
params |
Object |
params.name |
string |
params.namespace? |
string |
data? |
PartialObjectDeep<Deployment> |
Returns#
Promise<Deployment>
Inherited from#
KubeObjectStore.create
createItem#
▸ Protected createItem(params, data?): Promise<null | Deployment>
Parameters#
| Name | Type |
|---|---|
params |
Object |
params.name |
string |
params.namespace? |
string |
data? |
PartialObjectDeep<Deployment> |
Returns#
Promise<null | Deployment>
Inherited from#
KubeObjectStore.createItem
defaultSorting#
▸ Protected defaultSorting(item): string
Parameters#
| Name | Type |
|---|---|
item |
Item |
Returns#
string
Inherited from#
KubeObjectStore.defaultSorting
filterItemsOnLoad#
▸ Protected filterItemsOnLoad(items): Deployment[]
Parameters#
| Name | Type |
|---|---|
items |
Deployment[] |
Returns#
Inherited from#
KubeObjectStore.filterItemsOnLoad
getAllByNs#
▸ getAllByNs(namespace, strict?): Deployment[]
Parameters#
| Name | Type | Default value |
|---|---|---|
namespace |
string | string[] |
undefined |
strict |
boolean |
false |
Returns#
Inherited from#
KubeObjectStore.getAllByNs
getById#
▸ getById(id): undefined | Deployment
Parameters#
| Name | Type |
|---|---|
id |
string |
Returns#
undefined | Deployment
Inherited from#
KubeObjectStore.getById
getByLabel#
▸ getByLabel(labels): Deployment[]
Parameters#
| Name | Type |
|---|---|
labels |
string[] | Partial<Record<string, string>> |
Returns#
Inherited from#
KubeObjectStore.getByLabel
getByName#
▸ getByName(name, namespace?): undefined | Deployment
Parameters#
| Name | Type |
|---|---|
name |
string |
namespace? |
string |
Returns#
undefined | Deployment
Inherited from#
KubeObjectStore.getByName
getByPath#
▸ getByPath(path): undefined | Deployment
Parameters#
| Name | Type |
|---|---|
path |
string |
Returns#
undefined | Deployment
Inherited from#
KubeObjectStore.getByPath
getChildPods#
▸ getChildPods(deployment): Pod[]
Parameters#
| Name | Type |
|---|---|
deployment |
Deployment |
Returns#
Pod[]
getIndexById#
▸ getIndexById(id): number
Parameters#
| Name | Type |
|---|---|
id |
string |
Returns#
number
Inherited from#
KubeObjectStore.getIndexById
getItems#
▸ getItems(): Deployment[]
Returns#
Inherited from#
KubeObjectStore.getItems
getStatuses#
▸ getStatuses(deployments): DeploymentStatuses
Parameters#
| Name | Type |
|---|---|
deployments |
Deployment[] |
Returns#
DeploymentStatuses
▸ getStatuses(deployments): DeploymentStatuses
Deprecated
Parameters#
| Name | Type |
|---|---|
deployments |
undefined | Deployment[] |
Returns#
DeploymentStatuses
getTotalCount#
▸ getTotalCount(): number
Returns#
number
Inherited from#
KubeObjectStore.getTotalCount
isSelected#
▸ isSelected(item): boolean
Parameters#
| Name | Type |
|---|---|
item |
Deployment |
Returns#
boolean
Inherited from#
KubeObjectStore.isSelected
isSelectedAll#
▸ isSelectedAll(visibleItems?): boolean
Parameters#
| Name | Type |
|---|---|
visibleItems |
Deployment[] |
Returns#
boolean
Inherited from#
KubeObjectStore.isSelectedAll
load#
▸ load(params): Promise<Deployment>
Parameters#
| Name | Type |
|---|---|
params |
Object |
params.name |
string |
params.namespace? |
string |
Returns#
Promise<Deployment>
Inherited from#
KubeObjectStore.load
loadAll#
▸ loadAll(__namedParameters?): Promise<undefined | Deployment[]>
Parameters#
| Name | Type |
|---|---|
__namedParameters |
KubeObjectStoreLoadAllParams |
Returns#
Promise<undefined | Deployment[]>
Inherited from#
KubeObjectStore.loadAll
loadFromPath#
▸ loadFromPath(resourcePath): Promise<Deployment>
Parameters#
| Name | Type |
|---|---|
resourcePath |
string |
Returns#
Promise<Deployment>
Inherited from#
KubeObjectStore.loadFromPath
loadItem#
▸ Protected loadItem(params): Promise<null | Deployment>
Parameters#
| Name | Type |
|---|---|
params |
Object |
params.name |
string |
params.namespace? |
string |
Returns#
Promise<null | Deployment>
Inherited from#
KubeObjectStore.loadItem
loadItems#
▸ Protected loadItems(__namedParameters): Promise<Deployment[]>
Parameters#
| Name | Type |
|---|---|
__namedParameters |
KubeObjectStoreLoadingParams |
Returns#
Promise<Deployment[]>
Inherited from#
KubeObjectStore.loadItems
mergeItems#
▸ Protected mergeItems(partialItems, __namedParameters): Deployment[]
Parameters#
| Name | Type |
|---|---|
partialItems |
Deployment[] |
__namedParameters |
MergeItemsOptions |
Returns#
Inherited from#
KubeObjectStore.mergeItems
patch#
▸ patch(item, patch): Promise<Deployment>
Parameters#
| Name | Type |
|---|---|
item |
Deployment |
patch |
Patch |
Returns#
Promise<Deployment>
Inherited from#
KubeObjectStore.patch
pickOnlySelected#
▸ pickOnlySelected(items): Deployment[]
Parameters#
| Name | Type |
|---|---|
items |
Deployment[] |
Returns#
Inherited from#
KubeObjectStore.pickOnlySelected
reloadAll#
▸ reloadAll(opts?): Promise<undefined | Deployment[]>
Parameters#
| Name | Type |
|---|---|
opts |
Object |
opts.force? |
boolean |
opts.merge? |
boolean |
opts.namespaces? |
string[] |
Returns#
Promise<undefined | Deployment[]>
Inherited from#
KubeObjectStore.reloadAll
remove#
▸ remove(item): Promise<void>
Parameters#
| Name | Type |
|---|---|
item |
Deployment |
Returns#
Promise<void>
Inherited from#
KubeObjectStore.remove
removeItem#
▸ Protected removeItem(item, request): Promise<void>
Parameters#
| Name | Type |
|---|---|
item |
Deployment |
request |
() => Promise<any> |
Returns#
Promise<void>
Inherited from#
KubeObjectStore.removeItem
removeItems#
▸ removeItems(items): Promise<void>
Parameters#
| Name | Type |
|---|---|
items |
Deployment[] |
Returns#
Promise<void>
Inherited from#
KubeObjectStore.removeItems
removeSelectedItems#
▸ removeSelectedItems(): Promise<void>
Returns#
Promise<void>
Inherited from#
KubeObjectStore.removeSelectedItems
reset#
▸ reset(): void
Returns#
void
Inherited from#
KubeObjectStore.reset
resetOnError#
▸ Protected resetOnError(error): void
Parameters#
| Name | Type |
|---|---|
error |
any |
Returns#
void
Inherited from#
KubeObjectStore.resetOnError
resetSelection#
▸ resetSelection(): void
Returns#
void
Inherited from#
KubeObjectStore.resetSelection
select#
▸ select(item): void
Parameters#
| Name | Type |
|---|---|
item |
Deployment |
Returns#
void
Inherited from#
KubeObjectStore.select
sortItems#
▸ Protected sortItems(items): Deployment[]
Parameters#
| Name | Type |
|---|---|
items |
Deployment[] |
Returns#
Overrides#
KubeObjectStore.sortItems
subscribe#
▸ subscribe(__namedParameters?): Disposer
Parameters#
| Name | Type |
|---|---|
__namedParameters |
KubeObjectStoreSubscribeParams |
Returns#
Disposer
Inherited from#
KubeObjectStore.subscribe
toggleSelection#
▸ toggleSelection(item): void
Parameters#
| Name | Type |
|---|---|
item |
Deployment |
Returns#
void
Inherited from#
KubeObjectStore.toggleSelection
toggleSelectionAll#
▸ toggleSelectionAll(visibleItems?): void
Parameters#
| Name | Type |
|---|---|
visibleItems |
Deployment[] |
Returns#
void
Inherited from#
KubeObjectStore.toggleSelectionAll
unselect#
▸ unselect(item): void
Parameters#
| Name | Type |
|---|---|
item |
Deployment |
Returns#
void
Inherited from#
KubeObjectStore.unselect
update#
▸ update(item, data): Promise<Deployment>
Parameters#
| Name | Type |
|---|---|
item |
Deployment |
data |
PartialObjectDeep<Deployment> |
Returns#
Promise<Deployment>
Inherited from#
KubeObjectStore.update
updateFromEventsBuffer#
▸ Protected updateFromEventsBuffer(): void
Returns#
void
Inherited from#
KubeObjectStore.updateFromEventsBuffer
updateItem#
▸ Protected updateItem(item, request): Promise<Deployment>
Parameters#
| Name | Type |
|---|---|
item |
Deployment |
request |
() => Promise<Deployment> |
Returns#
Promise<Deployment>
Inherited from#
KubeObjectStore.updateItem