@stolostron/multicluster-sdk/lib/types/fleet.d.ts

Provides extensions and APIs that dynamic plugins can use to leverage multicluster capabilities provided by Red Hat Advanced Cluster Management.

import { AccessReviewResourceAttributes, K8sResourceCommon, ResourceLinkProps, WatchK8sResource, WatchK8sResult } from '@openshift-console/dynamic-plugin-sdk';
import { AdvancedSearchFilter, SearchResult } from './search';
export type Fleet<T> = T & {
    cluster?: string;
};
export type FleetWatchK8sResource = Fleet<WatchK8sResource>;
export type FleetK8sResourceCommon = Fleet<K8sResourceCommon>;
export type FleetAccessReviewResourceAttributes = Fleet<AccessReviewResourceAttributes>;
export type UseHubClusterName = () => [hubClusterName: string | undefined, loaded: boolean, error: any];
export type UseFleetK8sAPIPath = (cluster?: string) => [k8sAPIPath: string | undefined, loaded: boolean, error: Error | undefined];
export type FleetResourceLinkProps = Fleet<ResourceLinkProps>;
export type UseFleetK8sWatchResource = <R extends FleetK8sResourceCommon | FleetK8sResourceCommon[]>(initResource: FleetWatchK8sResource | null) => WatchK8sResult<R> | [undefined, boolean, any];
export type UseFleetClusterNames = () => [string[], boolean, any];
/** Signature of the `useIsFleetAvailable` hook */
export type UseIsFleetAvailable = () => boolean;
export type UseFleetSearchPoll = <T extends K8sResourceCommon | K8sResourceCommon[]>(watchOptions: WatchK8sResource, advancedSearchFilters?: AdvancedSearchFilter, pollInterval?: number | false) => [SearchResult<T> | undefined, boolean, Error | undefined, () => void];
/**
 * Signature of the `UseIsFleet ObservabilityInstalled` hook.
 *
 * @returns A tuple containing a boolean indicating if the observability controller is installed, a boolean indicating if loaded, and an error if any.
 */
export type UseIsFleetObservabilityInstalled = () => [
    isObservabilityInstalled: boolean | undefined,
    loaded: boolean,
    error: any
];
//# sourceMappingURL=fleet.d.ts.map