Skip to main content

Interface: ApiWithNamespaceClient<ResourceType>

Type Parameters

Type Parameter
ResourceType extends KubeObjectInterface

Properties

apiInfo

apiInfo: object[];

Defined in

src/lib/k8s/api/v1/factories.ts:136


delete()

delete: (namespace: string, name: string, deleteParams?: DeleteParameters, cluster?: string) => Promise<any>;

Parameters

ParameterType
namespacestring
namestring
deleteParams?DeleteParameters
cluster?string

Returns

Promise<any>

Defined in

src/lib/k8s/api/v1/factories.ts:129


get()

get: (namespace: string, name: string, cb: StreamResultsCb<ResourceType>, errCb: StreamErrCb, queryParams?: QueryParameters, cluster?: string) => Promise<CancelFunction>;

Parameters

ParameterType
namespacestring
namestring
cbStreamResultsCb<ResourceType>
errCbStreamErrCb
queryParams?QueryParameters
cluster?string

Returns

Promise<CancelFunction>

Defined in

src/lib/k8s/api/v1/factories.ts:104


isNamespaced

isNamespaced: boolean;

Defined in

src/lib/k8s/api/v1/factories.ts:135


list()

list: (namespace: string, cb: StreamResultsCb<ResourceType>, errCb: StreamErrCb, queryParams?: QueryParameters, cluster?: string) => Promise<CancelFunction>;

Parameters

ParameterType
namespacestring
cbStreamResultsCb<ResourceType>
errCbStreamErrCb
queryParams?QueryParameters
cluster?string

Returns

Promise<CancelFunction>

Defined in

src/lib/k8s/api/v1/factories.ts:97


patch()

patch: (body: OpPatch[], namespace: string, name: string, queryParams?: QueryParameters, cluster?: string) => Promise<any>;

Parameters

ParameterType
bodyOpPatch[]
namespacestring
namestring
queryParams?QueryParameters
cluster?string

Returns

Promise<any>

Defined in

src/lib/k8s/api/v1/factories.ts:122


post()

post: (body: RecursivePartial<KubeObjectInterface>, queryParams?: QueryParameters, cluster?: string) => Promise<any>;

Parameters

ParameterType
bodyRecursivePartial<KubeObjectInterface>
queryParams?QueryParameters
cluster?string

Returns

Promise<any>

Defined in

src/lib/k8s/api/v1/factories.ts:112


put()

put: (body: KubeObjectInterface, queryParams?: QueryParameters, cluster?: string) => Promise<ResourceType>;

Parameters

ParameterType
bodyKubeObjectInterface
queryParams?QueryParameters
cluster?string

Returns

Promise<ResourceType>

Defined in

src/lib/k8s/api/v1/factories.ts:117


scale?

optional scale: ScaleApi;

Defined in

src/lib/k8s/api/v1/factories.ts:141