@stolostron/multicluster-sdk
Version:
Provides extensions and APIs that dynamic plugins can use to leverage multicluster capabilities provided by Red Hat Advanced Cluster Management.
39 lines • 1.72 kB
TypeScript
import { FleetK8sListOptions, FleetK8sResourceCommon } from '../types';
import { K8sModel, QueryParams, Selector } from '@openshift-console/dynamic-plugin-sdk';
export type FleetK8sAPIOptions = {
model: K8sModel;
name?: string;
ns?: string;
path?: string;
cluster?: string;
queryParams?: QueryParams;
};
export type FleetK8sAPIOptionsWithData<R extends FleetK8sResourceCommon> = FleetK8sAPIOptions & {
data: R;
};
export type FleetK8sAPIOptionsWithResource<R extends FleetK8sResourceCommon> = FleetK8sAPIOptions & {
resource: R;
};
export declare const getResourcePath: (options: FleetK8sAPIOptions) => string;
export declare const buildResourceURL: (params: {
model: K8sModel;
ns?: string;
name?: string;
cluster?: string;
queryParams?: QueryParams;
basePath: string;
}) => string;
export declare function getClusterFromOptions(options: FleetK8sAPIOptions): string | undefined;
export declare function getNamespaceFromOptions(options: FleetK8sAPIOptions): string | undefined;
export declare function getNameFromOptions(options: FleetK8sAPIOptions): string | undefined;
export declare function getOptionsWithoutCluster<O extends FleetK8sAPIOptions>(options: O): Omit<O, "cluster">;
export declare function getResourceURLFromOptions<O extends FleetK8sAPIOptions | FleetK8sListOptions>(options: O, collection?: boolean | undefined): Promise<string>;
export declare const fleetWatch: (model: K8sModel, query: {
labelSelector?: Selector;
resourceVersion?: string;
allowWatchBookmarks?: boolean;
ns?: string;
fieldSelector?: string;
cluster?: string;
} | undefined, backendURL: string) => WebSocket;
//# sourceMappingURL=apiRequests.d.ts.map