Interface: ApiClient<ResourceType>
Defined in: lib/k8s/api/v1/factories.ts:57
Type Parameters
| Type Parameter |
|---|
ResourceType extends KubeObjectInterface |
Properties
apiInfo
apiInfo: object[];
Defined in: lib/k8s/api/v1/factories.ts:97
group
group: string;
resource
resource: string;
version
version: string;
delete
delete: (name: string, deleteParams?: DeleteParameters, cluster?: string) => Promise<any>;
Defined in: lib/k8s/api/v1/factories.ts:95
Parameters
| Parameter | Type |
|---|---|
name | string |
deleteParams? | DeleteParameters |
cluster? | string |
Returns
Promise<any>
get
get: (name: string, cb: StreamResultsCb<ResourceType>, errCb: StreamErrCb, queryParams?: QueryParameters, cluster?: string) => Promise<CancelFunction>;
Defined in: lib/k8s/api/v1/factories.ts:64
Parameters
| Parameter | Type |
|---|---|
name | string |
cb | StreamResultsCb<ResourceType> |
errCb | StreamErrCb |
queryParams? | QueryParameters |
cluster? | string |
Returns
Promise<CancelFunction>
isNamespaced
isNamespaced: boolean;
Defined in: lib/k8s/api/v1/factories.ts:96
jsonPatch
jsonPatch: (body: OpPatch[], name: string, queryParams?: QueryParameters, cluster?: string) => Promise<ResourceType>;
Defined in: lib/k8s/api/v1/factories.ts:89
Parameters
| Parameter | Type |
|---|---|
body | OpPatch[] |
name | string |
queryParams? | QueryParameters |
cluster? | string |
Returns
Promise<ResourceType>
list
list: (cb: StreamResultsCb<ResourceType>, errCb: StreamErrCb, queryParams?: QueryParameters, cluster?: string) => Promise<CancelFunction>;
Defined in: lib/k8s/api/v1/factories.ts:58
Parameters
| Parameter | Type |
|---|---|
cb | StreamResultsCb<ResourceType> |
errCb | StreamErrCb |
queryParams? | QueryParameters |
cluster? | string |
Returns
Promise<CancelFunction>
patch
patch: (body: OpPatch[], name: string, queryParams?: QueryParameters, cluster?: string) => Promise<ResourceType>;
Defined in: lib/k8s/api/v1/factories.ts:83
Parameters
| Parameter | Type |
|---|---|
body | OpPatch[] |
name | string |
queryParams? | QueryParameters |
cluster? | string |
Returns
Promise<ResourceType>
post
post: (body: RecursivePartial<ResourceType>, queryParams?: QueryParameters, cluster?: string) => Promise<ResourceType>;
Defined in: lib/k8s/api/v1/factories.ts:71
Parameters
| Parameter | Type |
|---|---|
body | RecursivePartial<ResourceType> |
queryParams? | QueryParameters |
cluster? | string |
Returns
Promise<ResourceType>
put
put: (body: ResourceType, queryParams?: QueryParameters, cluster?: string) => Promise<ResourceType>;
Defined in: lib/k8s/api/v1/factories.ts:76
Parameters
| Parameter | Type |
|---|---|
body | ResourceType |
queryParams? | QueryParameters |
cluster? | string |
Returns
Promise<ResourceType>