Class: RoleBindingsStore

Renderer.K8sApi.RoleBindingsStore

Hierarchy

• KubeObjectStore<RoleBinding, RoleBindingApi, RoleBindingData>

↳ RoleBindingsStore

Table of contents

Constructors

• constructor

Properties

• api
• bufferSize
• eventsBuffer
• failedLoading
• isLoaded
• isLoading
• items
• limit
• selectedItemsIds
• defaultContext

Accessors

• context
• contextItems
• contextReady
• namespacesReady
• query
• selectedItems

Methods

• [iterator]
• bindWatchEventsUpdater
• create
• createItem
• defaultSorting
• filterItemsOnLoad
• getAllByNs
• getById
• getByLabel
• getByName
• getByPath
• getIndexById
• getItems
• getTotalCount
• isSelected
• isSelectedAll
• load
• loadAll
• loadFromPath
• loadItem
• loadItems
• mergeItems
• patch
• pickOnlySelected
• reloadAll
• remove
• removeItem
• removeItems
• removeSelectedItems
• removeSubjects
• reset
• resetOnError
• resetSelection
• select
• sortItems
• subscribe
• toggleSelection
• toggleSelectionAll
• unselect
• update
• updateFromEventsBuffer
• updateItem
• updateSubjects

Constructors

constructor

• new RoleBindingsStore(api, opts?)

Parameters

Name	Type
api	RoleBindingApi
opts?	KubeObjectStoreOptions

Inherited from

KubeObjectStore.constructor

• new RoleBindingsStore()

deprecated Supply API instance through constructor

Inherited from

KubeObjectStore.constructor

Properties

api

• Readonly api: RoleBindingApi

Inherited from

KubeObjectStore.api

---

bufferSize

• Readonly bufferSize: number

Inherited from

KubeObjectStore.bufferSize

---

eventsBuffer

• Protected eventsBuffer: IObservableArray<IKubeWatchEvent<RoleBindingData>>

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<RoleBinding>

Inherited from

KubeObjectStore.items

---

limit

• Readonly limit: undefined | number

Inherited from

KubeObjectStore.limit

---

selectedItemsIds

• selectedItemsIds: ObservableSet<string>

Inherited from

KubeObjectStore.selectedItemsIds

---

defaultContext

▪ Static Readonly defaultContext: IObservableValue<undefined | ClusterContext>

Inherited from

KubeObjectStore.defaultContext

Accessors

context

• get context(): undefined | ClusterContext

Returns

undefined | ClusterContext

Inherited from

KubeObjectStore.context

---

contextItems

• get contextItems(): K[]

Returns

K[]

Inherited from

KubeObjectStore.contextItems

---

contextReady

• get contextReady(): Promise<void> & { cancel: () => void }

Returns

Promise<void> & { cancel: () => void }

Inherited from

KubeObjectStore.contextReady

---

namespacesReady

• get namespacesReady(): Promise<void> & { cancel: () => void }

Returns

Promise<void> & { cancel: () => void }

Inherited from

KubeObjectStore.namespacesReady

---

query

• get query(): KubeApiQueryParams

Returns

KubeApiQueryParams

Inherited from

KubeObjectStore.query

---

selectedItems

• get selectedItems(): Item[]

Returns

Item[]

Inherited from

KubeObjectStore.selectedItems

Methods

[iterator]

▸ [iterator](): Generator<RoleBinding, void, undefined>

Returns

Generator<RoleBinding, void, undefined>

Inherited from

KubeObjectStore.[iterator]

---

bindWatchEventsUpdater

▸ Protected bindWatchEventsUpdater(delay?): void

Parameters

Name	Type	Default value
delay	number	1000

Returns

void

Inherited from

KubeObjectStore.bindWatchEventsUpdater

---

create

▸ create(params, data?): Promise<RoleBinding>

Parameters

Name	Type
params	Object
params.name	string
params.namespace?	string
data?	PartialObjectDeep<RoleBinding>

Returns

Promise<RoleBinding>

Inherited from

KubeObjectStore.create

---

createItem

▸ Protected createItem(params, data?): Promise<null | RoleBinding>

Parameters

Name	Type
params	Object
params.name	string
params.namespace?	string
data?	PartialObjectDeep<RoleBinding>

Returns

Promise<null | RoleBinding>

Inherited from

KubeObjectStore.createItem

---

defaultSorting

▸ Protected defaultSorting(item): string

Parameters

Name	Type
item	Item

Returns

string

Inherited from

KubeObjectStore.defaultSorting

---

filterItemsOnLoad

▸ Protected filterItemsOnLoad(items): RoleBinding[]

Parameters

Name	Type
items	RoleBinding[]

Returns

RoleBinding[]

Inherited from

KubeObjectStore.filterItemsOnLoad

---

getAllByNs

▸ getAllByNs(namespace, strict?): RoleBinding[]

Parameters

Name	Type	Default value
namespace	string | string[]	undefined
strict	boolean	false

Returns

RoleBinding[]

Inherited from

KubeObjectStore.getAllByNs

---

getById

▸ getById(id): undefined | RoleBinding

Parameters

Name	Type
id	string

Returns

undefined | RoleBinding

Inherited from

KubeObjectStore.getById

---

getByLabel

▸ getByLabel(labels): RoleBinding[]

Parameters

Name	Type
labels	string[] | Partial<Record<string, string>>

Returns

RoleBinding[]

Inherited from

KubeObjectStore.getByLabel

---

getByName

▸ getByName(name, namespace?): undefined | RoleBinding

Parameters

Name	Type
name	string
namespace?	string

Returns

undefined | RoleBinding

Inherited from

KubeObjectStore.getByName

---

getByPath

▸ getByPath(path): undefined | RoleBinding

Parameters

Name	Type
path	string

Returns

undefined | RoleBinding

Inherited from

KubeObjectStore.getByPath

---

getIndexById

▸ getIndexById(id): number

Parameters

Name	Type
id	string

Returns

number

Inherited from

KubeObjectStore.getIndexById

---

getItems

▸ getItems(): RoleBinding[]

Returns

RoleBinding[]

Inherited from

KubeObjectStore.getItems

---

getTotalCount

▸ getTotalCount(): number

Returns

number

Inherited from

KubeObjectStore.getTotalCount

---

isSelected

▸ isSelected(item): boolean

Parameters

Name	Type
item	RoleBinding

Returns

boolean

Inherited from

KubeObjectStore.isSelected

---

isSelectedAll

▸ isSelectedAll(visibleItems?): boolean

Parameters

Name	Type
visibleItems	RoleBinding[]

Returns

boolean

Inherited from

KubeObjectStore.isSelectedAll

---

load

▸ load(params): Promise<RoleBinding>

Parameters

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

Returns

Promise<RoleBinding>

Inherited from

KubeObjectStore.load

---

loadAll

▸ loadAll(__namedParameters?): Promise<undefined | RoleBinding[]>

Parameters

Name	Type
__namedParameters	KubeObjectStoreLoadAllParams

Returns

Promise<undefined | RoleBinding[]>

Inherited from

KubeObjectStore.loadAll

---

loadFromPath

▸ loadFromPath(resourcePath): Promise<RoleBinding>

Parameters

Name	Type
resourcePath	string

Returns

Promise<RoleBinding>

Inherited from

KubeObjectStore.loadFromPath

---

loadItem

▸ Protected loadItem(params): Promise<null | RoleBinding>

Parameters

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

Returns

Promise<null | RoleBinding>

Inherited from

KubeObjectStore.loadItem

---

loadItems

▸ Protected loadItems(__namedParameters): Promise<RoleBinding[]>

Parameters

Name	Type
__namedParameters	KubeObjectStoreLoadingParams

Returns

Promise<RoleBinding[]>

Inherited from

KubeObjectStore.loadItems

---

mergeItems

▸ Protected mergeItems(partialItems, __namedParameters): RoleBinding[]

Parameters

Name	Type
partialItems	RoleBinding[]
__namedParameters	MergeItemsOptions

Returns

RoleBinding[]

Inherited from

KubeObjectStore.mergeItems

---

patch

▸ patch(item, patch): Promise<RoleBinding>

Parameters

Name	Type
item	RoleBinding
patch	Patch

Returns

Promise<RoleBinding>

Inherited from

KubeObjectStore.patch

---

pickOnlySelected

▸ pickOnlySelected(items): RoleBinding[]

Parameters

Name	Type
items	RoleBinding[]

Returns

RoleBinding[]

Inherited from

KubeObjectStore.pickOnlySelected

---

reloadAll

▸ reloadAll(opts?): Promise<undefined | RoleBinding[]>

Parameters

Name	Type
opts	Object
opts.force?	boolean
opts.merge?	boolean
opts.namespaces?	string[]

Returns

Promise<undefined | RoleBinding[]>

Inherited from

KubeObjectStore.reloadAll

---

remove

▸ remove(item): Promise<void>

Parameters

Name	Type
item	RoleBinding

Returns

Promise<void>

Inherited from

KubeObjectStore.remove

---

removeItem

▸ Protected removeItem(item, request): Promise<void>

Parameters

Name	Type
item	RoleBinding
request	() => Promise<any>

Returns

Promise<void>

Inherited from

KubeObjectStore.removeItem

---

removeItems

▸ removeItems(items): Promise<void>

Parameters

Name	Type
items	RoleBinding[]

Returns

Promise<void>

Inherited from

KubeObjectStore.removeItems

---

removeSelectedItems

▸ removeSelectedItems(): Promise<void>

Returns

Promise<void>

Inherited from

KubeObjectStore.removeSelectedItems

---

removeSubjects

▸ removeSubjects(roleBinding, subjectsToRemove): Promise<RoleBinding>

Parameters

Name	Type
roleBinding	RoleBinding
subjectsToRemove	Iterable<Subject>

Returns

Promise<RoleBinding>

---

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	RoleBinding

Returns

void

Inherited from

KubeObjectStore.select

---

sortItems

▸ Protected sortItems(items): RoleBinding[]

Return items sorted by the given ordering functions. If two elements of items are sorted to the same "index" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort).

Parameters

Name	Type	Description
items	RoleBinding[]	the items to be sorted (default: the current items in this store)

Returns

RoleBinding[]

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	RoleBinding

Returns

void

Inherited from

KubeObjectStore.toggleSelection

---

toggleSelectionAll

▸ toggleSelectionAll(visibleItems?): void

Parameters

Name	Type
visibleItems	RoleBinding[]

Returns

void

Inherited from

KubeObjectStore.toggleSelectionAll

---

unselect

▸ unselect(item): void

Parameters

Name	Type
item	RoleBinding

Returns

void

Inherited from

KubeObjectStore.unselect

---

update

▸ update(item, data): Promise<RoleBinding>

Parameters

Name	Type
item	RoleBinding
data	PartialObjectDeep<RoleBinding>

Returns

Promise<RoleBinding>

Inherited from

KubeObjectStore.update

---

updateFromEventsBuffer

▸ Protected updateFromEventsBuffer(): void

Returns

void

Inherited from

KubeObjectStore.updateFromEventsBuffer

---

updateItem

▸ Protected updateItem(item, request): Promise<RoleBinding>

Parameters

Name	Type
item	RoleBinding
request	() => Promise<RoleBinding>

Returns

Promise<RoleBinding>

Inherited from

KubeObjectStore.updateItem

---

updateSubjects

▸ updateSubjects(roleBinding, subjects): Promise<RoleBinding>

Parameters

Name	Type
roleBinding	RoleBinding
subjects	Subject[]

Returns

Promise<RoleBinding>