Interface: KubeObjectIface<T>
Type Parameters
Type Parameter |
---|
T extends KubeObjectInterface | KubeEvent |
Indexable
[prop
: string
]: any
Constructors
new KubeObjectIface()
new KubeObjectIface(json: T): any
Parameters
Parameter | Type |
---|---|
json | T |
Returns
any
Defined in
Properties
apiList()
apiList: (onList: (arg: any[]) => void, onError?: (err: ApiError) => void, opts?: ApiListSingleNamespaceOptions) => any;
Parameters
Parameter | Type |
---|---|
onList | (arg : any []) => void |
onError ? | (err : ApiError ) => void |
opts ? | ApiListSingleNamespaceOptions |
Returns
any
Defined in
className
className: string;
Defined in
getAuthorization()?
optional getAuthorization: (arg: string, resourceAttrs?: AuthRequestResourceAttrs) => any;
Parameters
Parameter | Type |
---|---|
arg | string |
resourceAttrs ? | AuthRequestResourceAttrs |
Returns
any
Defined in
getErrorMessage()
getErrorMessage: (err?: null | ApiError) => null | string;
Parameters
Parameter | Type |
---|---|
err ? | null | ApiError |
Returns
null
| string
Defined in
useApiGet()
useApiGet: (onGet: (...args: any) => void, name: string, namespace?: string, onError?: (err: ApiError) => void) => void;
Parameters
Parameter | Type |
---|---|
onGet | (...args : any ) => void |
name | string |
namespace ? | string |
onError ? | (err : ApiError ) => void |
Returns
void
Defined in
useApiList()
useApiList: (onList: (arg: any[]) => void, onError?: (err: ApiError) => void, opts?: ApiListOptions) => any;
Parameters
Parameter | Type |
---|---|
onList | (arg : any []) => void |
onError ? | (err : ApiError ) => void |
opts ? | ApiListOptions |
Returns
any
Defined in
useGet()
useGet: (name: string, namespace?: string, opts?: object) => [any, null | ApiError] & QueryResponse<any, ApiError>;
Parameters
Parameter | Type |
---|---|
name | string |
namespace ? | string |
opts ? | object |
opts.cluster ? | string |
opts.queryParams ? | QueryParameters |
Returns
[any
, null
| ApiError
] & QueryResponse
<any
, ApiError
>
Defined in
Methods
useList()
useList(options?: ApiListOptions): [null | any[], null | ApiError] & QueryListResponse<KubeList<any>, any, ApiError>
Parameters
Parameter | Type |
---|---|
options ? | ApiListOptions |
Returns
[null
| any
[], null
| ApiError
] & QueryListResponse
<KubeList
<any
>, any
, ApiError
>