Skip to main content

Class: ClusterRole

lib/k8s/clusterRole.ClusterRole

Hierarchy

  • Role

    ClusterRole

Constructors

constructor

new ClusterRole(json)

Parameters

NameType
jsonKubeRole

Inherited from

Role.constructor

Defined in

lib/k8s/cluster.ts:317

Properties

apiEndpoint

Static apiEndpoint: Object

Type declaration

NameType
apiInfo{ group: string ; resource: string ; version: string }[]
delete(name: string, queryParams?: QueryParameters, cluster?: string) => Promise<any>
get(name: string, cb: StreamResultsCb, errCb: StreamErrCb, queryParams?: QueryParameters, cluster?: string) => Promise<() => void>
isNamespacedboolean
list(cb: StreamResultsCb, errCb: StreamErrCb, queryParams?: QueryParameters, cluster?: string) => Promise<() => void>
patch(body: OpPatch[], name: string, queryParams?: QueryParameters, cluster?: string) => Promise<any>
post(body: KubeObjectInterface, queryParams?: QueryParameters, cluster?: string) => Promise<any>
put(body: KubeObjectInterface, queryParams?: QueryParameters, cluster?: string) => Promise<any>

Overrides

Role.apiEndpoint

Defined in

lib/k8s/clusterRole.ts:5

Accessors

detailsRoute

get detailsRoute(): string

Returns

string

Defined in

lib/k8s/clusterRole.ts:11


rules

get rules(): any

Returns

any

Inherited from

Role.rules

Defined in

lib/k8s/role.ts:17


className

Static get className(): string

Returns

string

Overrides

Role.className

Defined in

lib/k8s/clusterRole.ts:7

Methods

apiList

Static apiList(onList, onError?, opts?): any

Parameters

NameType
onList(arg: any[]) => void
onError?(err: ApiError) => void
opts?ApiListSingleNamespaceOptions

Returns

any

Inherited from

Role.apiList

Defined in

lib/k8s/cluster.ts:293


getAuthorization

Static Optional getAuthorization(arg, resourceAttrs?): any

Parameters

NameType
argstring
resourceAttrs?AuthRequestResourceAttrs

Returns

any

Inherited from

Role.getAuthorization

Defined in

lib/k8s/cluster.ts:320


getErrorMessage

Static getErrorMessage(err?): null | string

Parameters

NameType
err?null | ApiError

Returns

null | string

Inherited from

Role.getErrorMessage

Defined in

lib/k8s/cluster.ts:316


useApiGet

Static useApiGet(onGet, name, namespace?, onError?): void

Parameters

NameType
onGet(...args: any) => void
namestring
namespace?string
onError?(err: ApiError) => void

Returns

void

Inherited from

Role.useApiGet

Defined in

lib/k8s/cluster.ts:303


useApiList

Static useApiList(onList, onError?, opts?): any

Parameters

NameType
onList(arg: any[]) => void
onError?(err: ApiError) => void
opts?ApiListOptions

Returns

any

Inherited from

Role.useApiList

Defined in

lib/k8s/cluster.ts:298


useGet

Static useGet(name, namespace?): [any, null | ApiError, (item: any) => void, (err: null | ApiError) => void]

Parameters

NameType
namestring
namespace?string

Returns

[any, null | ApiError, (item: any) => void, (err: null | ApiError) => void]

Inherited from

Role.useGet

Defined in

lib/k8s/cluster.ts:312


useList

Static useList(opts?): [any[], null | ApiError, (items: any[]) => void, (err: null | ApiError) => void]

Parameters

NameType
opts?ApiListOptions

Returns

[any[], null | ApiError, (items: any[]) => void, (err: null | ApiError) => void]

Inherited from

Role.useList

Defined in

lib/k8s/cluster.ts:309