Skip to main content

Interface: ApiClient<ResourceType>

Type Parameters​

Type Parameter
ResourceType extends KubeObjectInterface

Properties​

apiInfo​

apiInfo: object[];

Defined in​

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


delete()​

delete: (name: string, queryParams?: QueryParameters, cluster?: string) => Promise<any>;

Parameters​

ParameterType
namestring
queryParams?QueryParameters
cluster?string

Returns​

Promise<any>

Defined in​

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


get()​

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

Parameters​

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

Returns​

Promise<CancelFunction>

Defined in​

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


isNamespaced​

isNamespaced: boolean;

Defined in​

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


list()​

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

Parameters​

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

Returns​

Promise<CancelFunction>

Defined in​

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


patch()​

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

Parameters​

ParameterType
bodyOpPatch[]
namestring
queryParams?QueryParameters
cluster?string

Returns​

Promise<ResourceType>

Defined in​

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


post()​

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

Parameters​

ParameterType
bodyRecursivePartial<ResourceType>
queryParams?QueryParameters
cluster?string

Returns​

Promise<ResourceType>

Defined in​

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


put()​

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

Parameters​

ParameterType
bodyResourceType
queryParams?QueryParameters
cluster?string

Returns​

Promise<ResourceType>

Defined in​

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