@yugabytedb/perf-advisor-client 0.0.0-stage → 0.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +32 -2
- package/dist/generated/api/anomaly/anomaly.d.ts +228 -0
- package/dist/generated/api/customer/customer.d.ts +200 -0
- package/dist/generated/api/export-config/export-config.d.ts +175 -0
- package/dist/generated/api/graph/graph.d.ts +62 -0
- package/dist/generated/api/info/info.d.ts +30 -0
- package/dist/generated/api/runtime-config/runtime-config.d.ts +80 -0
- package/dist/generated/api/schema/schema.d.ts +214 -0
- package/dist/generated/api/support-bundle/support-bundle.d.ts +167 -0
- package/dist/generated/api/universe/universe.d.ts +267 -0
- package/dist/generated/api/user/user.d.ts +134 -0
- package/dist/generated/api/workload/workload.d.ts +178 -0
- package/dist/generated/api.d.ts +11 -0
- package/dist/generated/model/activityExclusions.d.ts +25 -0
- package/dist/generated/model/activityPeriod.d.ts +20 -0
- package/dist/generated/model/aggregatedLineSettings.d.ts +22 -0
- package/dist/generated/model/aggregatedLineSettingsAggregation.d.ts +18 -0
- package/dist/generated/model/anomaly.d.ts +18 -0
- package/dist/generated/model/anomalyDetails.d.ts +18 -0
- package/dist/generated/model/anomalyDetection.d.ts +18 -0
- package/dist/generated/model/anomalyDetectionInfo.d.ts +21 -0
- package/dist/generated/model/anomalyDetectionInfoState.d.ts +21 -0
- package/dist/generated/model/anomalyEntity.d.ts +23 -0
- package/dist/generated/model/anomalyEntityLabels.d.ts +17 -0
- package/dist/generated/model/anomalyFilter.d.ts +32 -0
- package/dist/generated/model/anomalyGraph.d.ts +27 -0
- package/dist/generated/model/anomalyGroup.d.ts +18 -0
- package/dist/generated/model/anomalyGroupInfo.d.ts +21 -0
- package/dist/generated/model/anomalyGroupPagedResp.d.ts +16 -0
- package/dist/generated/model/anomalyGroupsOfType.d.ts +28 -0
- package/dist/generated/model/anomalyIndexDetails.d.ts +24 -0
- package/dist/generated/model/anomalyInfo.d.ts +46 -0
- package/dist/generated/model/anomalyPagedResp.d.ts +16 -0
- package/dist/generated/model/anomalySortBy.d.ts +23 -0
- package/dist/generated/model/anomalyType.d.ts +30 -0
- package/dist/generated/model/badRequestResponse.d.ts +16 -0
- package/dist/generated/model/clusterRef.d.ts +19 -0
- package/dist/generated/model/clusterRefClusterType.d.ts +17 -0
- package/dist/generated/model/conflictResponse.d.ts +16 -0
- package/dist/generated/model/cpuStats.d.ts +24 -0
- package/dist/generated/model/credentials.d.ts +32 -0
- package/dist/generated/model/credentialsType.d.ts +23 -0
- package/dist/generated/model/customer.d.ts +20 -0
- package/dist/generated/model/customerInfo.d.ts +14 -0
- package/dist/generated/model/customerPagedResp.d.ts +16 -0
- package/dist/generated/model/customerSpec.d.ts +32 -0
- package/dist/generated/model/database.d.ts +18 -0
- package/dist/generated/model/databaseInfo.d.ts +16 -0
- package/dist/generated/model/databasePagedResp.d.ts +16 -0
- package/dist/generated/model/databaseSchema.d.ts +18 -0
- package/dist/generated/model/databaseSchemaInfo.d.ts +14 -0
- package/dist/generated/model/databaseSchemaPagedResp.d.ts +16 -0
- package/dist/generated/model/databaseStats.d.ts +18 -0
- package/dist/generated/model/databaseStatsFilter.d.ts +27 -0
- package/dist/generated/model/databaseStatsInfo.d.ts +27 -0
- package/dist/generated/model/databaseStatsPagedResp.d.ts +19 -0
- package/dist/generated/model/databaseStatsSortBy.d.ts +24 -0
- package/dist/generated/model/databaseType.d.ts +21 -0
- package/dist/generated/model/deleteSupportBundleParams.d.ts +17 -0
- package/dist/generated/model/deleteUniverseParams.d.ts +19 -0
- package/dist/generated/model/endpoint.d.ts +19 -0
- package/dist/generated/model/error.d.ts +37 -0
- package/dist/generated/model/estimateSupportBundleSizeParams.d.ts +23 -0
- package/dist/generated/model/exportConfig.d.ts +20 -0
- package/dist/generated/model/exportConfigCheck.d.ts +18 -0
- package/dist/generated/model/exportConfigInfo.d.ts +14 -0
- package/dist/generated/model/exportConfigMetrics.d.ts +19 -0
- package/dist/generated/model/exportConfigPagedResp.d.ts +16 -0
- package/dist/generated/model/exportConfigSpec.d.ts +34 -0
- package/dist/generated/model/exportConfigValidation.d.ts +20 -0
- package/dist/generated/model/exportConfigValidationSpec.d.ts +23 -0
- package/dist/generated/model/fieldError.d.ts +16 -0
- package/dist/generated/model/forbiddenResponse.d.ts +16 -0
- package/dist/generated/model/getAnomalyGroupParams.d.ts +18 -0
- package/dist/generated/model/getQueryStatsParams.d.ts +24 -0
- package/dist/generated/model/graph.d.ts +24 -0
- package/dist/generated/model/graphAxis.d.ts +19 -0
- package/dist/generated/model/graphAxisAlias.d.ts +17 -0
- package/dist/generated/model/graphCatalogEntry.d.ts +30 -0
- package/dist/generated/model/graphFilters.d.ts +18 -0
- package/dist/generated/model/graphGroupByOption.d.ts +17 -0
- package/dist/generated/model/graphLayout.d.ts +26 -0
- package/dist/generated/model/graphQuerySpec.d.ts +35 -0
- package/dist/generated/model/graphSeries.d.ts +32 -0
- package/dist/generated/model/graphSeriesLabels.d.ts +17 -0
- package/dist/generated/model/graphSettings.d.ts +25 -0
- package/dist/generated/model/graphSettingsAggregatedValueFunction.d.ts +18 -0
- package/dist/generated/model/graphSettingsSplitMode.d.ts +17 -0
- package/dist/generated/model/graphSettingsSplitType.d.ts +18 -0
- package/dist/generated/model/graphWindow.d.ts +19 -0
- package/dist/generated/model/index.d.ts +18 -0
- package/dist/generated/model/indexColumn.d.ts +21 -0
- package/dist/generated/model/indexDefinition.d.ts +19 -0
- package/dist/generated/model/indexFilter.d.ts +28 -0
- package/dist/generated/model/indexFlags.d.ts +23 -0
- package/dist/generated/model/indexInfo.d.ts +33 -0
- package/dist/generated/model/indexPagedResp.d.ts +16 -0
- package/dist/generated/model/indexSortBy.d.ts +19 -0
- package/dist/generated/model/internalErrorResponse.d.ts +16 -0
- package/dist/generated/model/kubernetesPod.d.ts +18 -0
- package/dist/generated/model/latencyStats.d.ts +22 -0
- package/dist/generated/model/listAnomaliesParams.d.ts +38 -0
- package/dist/generated/model/listAnomalyGroupsByTypeParams.d.ts +33 -0
- package/dist/generated/model/listAnomalyGroupsParams.d.ts +36 -0
- package/dist/generated/model/listCustomerRuntimeConfigsParams.d.ts +17 -0
- package/dist/generated/model/listCustomersParams.d.ts +18 -0
- package/dist/generated/model/listDatabaseSchemasParams.d.ts +18 -0
- package/dist/generated/model/listDatabaseStatsParams.d.ts +53 -0
- package/dist/generated/model/listDatabasesParams.d.ts +23 -0
- package/dist/generated/model/listExportConfigsParams.d.ts +18 -0
- package/dist/generated/model/listIndexesParams.d.ts +33 -0
- package/dist/generated/model/listMaterializedViewsParams.d.ts +33 -0
- package/dist/generated/model/listNodeStatsParams.d.ts +44 -0
- package/dist/generated/model/listQueriesParams.d.ts +33 -0
- package/dist/generated/model/listQueryStatsParams.d.ts +59 -0
- package/dist/generated/model/listRuntimeConfigsParams.d.ts +17 -0
- package/dist/generated/model/listSupportBundlesParams.d.ts +18 -0
- package/dist/generated/model/listTableStatsParams.d.ts +37 -0
- package/dist/generated/model/listTabletStatsParams.d.ts +58 -0
- package/dist/generated/model/listUniverseNodesParams.d.ts +28 -0
- package/dist/generated/model/listUniverseRuntimeConfigsParams.d.ts +17 -0
- package/dist/generated/model/listUniversesParams.d.ts +31 -0
- package/dist/generated/model/listUsersParams.d.ts +18 -0
- package/dist/generated/model/loadStats.d.ts +24 -0
- package/dist/generated/model/materializedView.d.ts +18 -0
- package/dist/generated/model/materializedViewFilter.d.ts +26 -0
- package/dist/generated/model/materializedViewInfo.d.ts +22 -0
- package/dist/generated/model/materializedViewPagedResp.d.ts +16 -0
- package/dist/generated/model/materializedViewSortBy.d.ts +18 -0
- package/dist/generated/model/metadataRefresh.d.ts +20 -0
- package/dist/generated/model/metadataRefreshResult.d.ts +24 -0
- package/dist/generated/model/metadataRefreshResultStatus.d.ts +22 -0
- package/dist/generated/model/metadataRefreshSpec.d.ts +19 -0
- package/dist/generated/model/metadataRefreshTarget.d.ts +18 -0
- package/dist/generated/model/metricsExportEndpoint.d.ts +21 -0
- package/dist/generated/model/metricsExportEndpointProtocol.d.ts +19 -0
- package/dist/generated/model/nodeFilter.d.ts +27 -0
- package/dist/generated/model/nodePlacement.d.ts +19 -0
- package/dist/generated/model/nodeStats.d.ts +18 -0
- package/dist/generated/model/nodeStatsInfo.d.ts +23 -0
- package/dist/generated/model/nodeStatsPagedResp.d.ts +16 -0
- package/dist/generated/model/nodeStatsSortBy.d.ts +19 -0
- package/dist/generated/model/notFoundResponse.d.ts +16 -0
- package/dist/generated/model/objectLifecycle.d.ts +22 -0
- package/dist/generated/model/objectNamespace.d.ts +20 -0
- package/dist/generated/model/objectRef.d.ts +19 -0
- package/dist/generated/model/pageRequest.d.ts +31 -0
- package/dist/generated/model/pagination.d.ts +22 -0
- package/dist/generated/model/perfAdvisor.d.ts +18 -0
- package/dist/generated/model/perfAdvisorInfo.d.ts +21 -0
- package/dist/generated/model/query.d.ts +18 -0
- package/dist/generated/model/queryFilter.d.ts +29 -0
- package/dist/generated/model/queryInfo.d.ts +29 -0
- package/dist/generated/model/queryPagedResp.d.ts +16 -0
- package/dist/generated/model/queryPlan.d.ts +26 -0
- package/dist/generated/model/queryPlanExecutionTime.d.ts +20 -0
- package/dist/generated/model/queryPlanUsage.d.ts +19 -0
- package/dist/generated/model/querySortBy.d.ts +19 -0
- package/dist/generated/model/queryStats.d.ts +18 -0
- package/dist/generated/model/queryStatsFilter.d.ts +35 -0
- package/dist/generated/model/queryStatsInfo.d.ts +40 -0
- package/dist/generated/model/queryStatsPagedResp.d.ts +16 -0
- package/dist/generated/model/queryStatsSortBy.d.ts +26 -0
- package/dist/generated/model/queryType.d.ts +21 -0
- package/dist/generated/model/rcaGuideline.d.ts +17 -0
- package/dist/generated/model/rcaRecommendation.d.ts +16 -0
- package/dist/generated/model/relationType.d.ts +21 -0
- package/dist/generated/model/replicationStatus.d.ts +25 -0
- package/dist/generated/model/runtimeConfig.d.ts +20 -0
- package/dist/generated/model/runtimeConfigInfo.d.ts +23 -0
- package/dist/generated/model/runtimeConfigInfoAllowedScopesItem.d.ts +17 -0
- package/dist/generated/model/runtimeConfigInfoType.d.ts +19 -0
- package/dist/generated/model/runtimeConfigSpec.d.ts +15 -0
- package/dist/generated/model/scrapedMetricsEndpoint.d.ts +19 -0
- package/dist/generated/model/serverType.d.ts +19 -0
- package/dist/generated/model/sortDirection.d.ts +16 -0
- package/dist/generated/model/statsSummary.d.ts +22 -0
- package/dist/generated/model/storageSize.d.ts +22 -0
- package/dist/generated/model/supportBundle.d.ts +20 -0
- package/dist/generated/model/supportBundleInfo.d.ts +21 -0
- package/dist/generated/model/supportBundleInfoState.d.ts +21 -0
- package/dist/generated/model/supportBundleMetricFormat.d.ts +19 -0
- package/dist/generated/model/supportBundlePagedResp.d.ts +16 -0
- package/dist/generated/model/supportBundleSizeEstimate.d.ts +19 -0
- package/dist/generated/model/supportBundleSpec.d.ts +28 -0
- package/dist/generated/model/supportBundleSpecMetricFormat.d.ts +20 -0
- package/dist/generated/model/syncStatus.d.ts +20 -0
- package/dist/generated/model/tableColumn.d.ts +16 -0
- package/dist/generated/model/tableRef.d.ts +23 -0
- package/dist/generated/model/tableStats.d.ts +18 -0
- package/dist/generated/model/tableStatsFilter.d.ts +29 -0
- package/dist/generated/model/tableStatsInfo.d.ts +43 -0
- package/dist/generated/model/tableStatsPagedResp.d.ts +19 -0
- package/dist/generated/model/tableStatsSortBy.d.ts +19 -0
- package/dist/generated/model/tabletPlacement.d.ts +19 -0
- package/dist/generated/model/tabletRelation.d.ts +24 -0
- package/dist/generated/model/tabletStats.d.ts +18 -0
- package/dist/generated/model/tabletStatsFilter.d.ts +33 -0
- package/dist/generated/model/tabletStatsInfo.d.ts +35 -0
- package/dist/generated/model/tabletStatsPagedResp.d.ts +19 -0
- package/dist/generated/model/tabletStatsSortBy.d.ts +18 -0
- package/dist/generated/model/timeWindow.d.ts +20 -0
- package/dist/generated/model/unauthorizedResponse.d.ts +16 -0
- package/dist/generated/model/universe.d.ts +20 -0
- package/dist/generated/model/universeClusterInfo.d.ts +17 -0
- package/dist/generated/model/universeCollectionInfo.d.ts +26 -0
- package/dist/generated/model/universeDatabaseSpec.d.ts +21 -0
- package/dist/generated/model/universeFeature.d.ts +19 -0
- package/dist/generated/model/universeFeatures.d.ts +29 -0
- package/dist/generated/model/universeInfo.d.ts +38 -0
- package/dist/generated/model/universeMetricsExportSpec.d.ts +22 -0
- package/dist/generated/model/universeNode.d.ts +18 -0
- package/dist/generated/model/universeNodeInfo.d.ts +28 -0
- package/dist/generated/model/universeNodePagedResp.d.ts +16 -0
- package/dist/generated/model/universePagedResp.d.ts +16 -0
- package/dist/generated/model/universeSortBy.d.ts +21 -0
- package/dist/generated/model/universeSpec.d.ts +30 -0
- package/dist/generated/model/universeSpecCollectionMode.d.ts +22 -0
- package/dist/generated/model/universeState.d.ts +18 -0
- package/dist/generated/model/universeSyncInfo.d.ts +22 -0
- package/dist/generated/model/universeSyncStatus.d.ts +21 -0
- package/dist/generated/model/universeSyncStatusProcess.d.ts +28 -0
- package/dist/generated/model/user.d.ts +20 -0
- package/dist/generated/model/userInfo.d.ts +14 -0
- package/dist/generated/model/userPagedResp.d.ts +16 -0
- package/dist/generated/model/userSpec.d.ts +16 -0
- package/dist/generated/model/waitEvent.d.ts +20 -0
- package/dist/generated/model/waitEventFilter.d.ts +20 -0
- package/dist/generated/model/waitEventGrouping.d.ts +16 -0
- package/dist/generated/model/waitEventLoad.d.ts +22 -0
- package/dist/generated/model/ybaInfo.d.ts +17 -0
- package/dist/generated/model/ybmClusterInfo.d.ts +18 -0
- package/dist/generated/model/ybmProject.d.ts +18 -0
- package/dist/generated/model.d.ts +220 -0
- package/dist/http.d.ts +13 -0
- package/dist/index.d.ts +3 -0
- package/dist/index.js +2234 -0
- package/package.json +39 -4
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
import type { QueryKey, UseMutationOptions, UseMutationResult, UseQueryOptions, UseQueryResult } from 'react-query';
|
|
2
|
+
import type { BadRequestResponse } from '../../model/badRequestResponse';
|
|
3
|
+
import type { ForbiddenResponse } from '../../model/forbiddenResponse';
|
|
4
|
+
import type { Graph } from '../../model/graph';
|
|
5
|
+
import type { GraphCatalogEntry } from '../../model/graphCatalogEntry';
|
|
6
|
+
import type { GraphQuerySpec } from '../../model/graphQuerySpec';
|
|
7
|
+
import type { InternalErrorResponse } from '../../model/internalErrorResponse';
|
|
8
|
+
import type { NotFoundResponse } from '../../model/notFoundResponse';
|
|
9
|
+
import type { UnauthorizedResponse } from '../../model/unauthorizedResponse';
|
|
10
|
+
import { paRequest } from '../../../http';
|
|
11
|
+
type SecondParameter<T extends (...args: never) => unknown> = Parameters<T>[1];
|
|
12
|
+
/**
|
|
13
|
+
* Lists the graphs Perf Advisor can draw, with the labels each can be filtered and split by.
|
|
14
|
+
* Ordered as the UI shows them.
|
|
15
|
+
* @summary List graphs
|
|
16
|
+
*/
|
|
17
|
+
export declare const listGraphs: (options?: SecondParameter<typeof paRequest>) => Promise<GraphCatalogEntry[]>;
|
|
18
|
+
export declare const getListGraphsQueryKey: () => readonly ["/graphs"];
|
|
19
|
+
export declare const getListGraphsQueryOptions: <TData = GraphCatalogEntry[], TError = import("../../model").Error>(options?: {
|
|
20
|
+
query?: UseQueryOptions<GraphCatalogEntry[], TError, TData, QueryKey> | undefined;
|
|
21
|
+
request?: SecondParameter<typeof paRequest>;
|
|
22
|
+
} | undefined) => UseQueryOptions<GraphCatalogEntry[], TError, TData, QueryKey> & {
|
|
23
|
+
queryKey: QueryKey;
|
|
24
|
+
};
|
|
25
|
+
export type ListGraphsQueryResult = NonNullable<Awaited<ReturnType<typeof listGraphs>>>;
|
|
26
|
+
export type ListGraphsQueryError = UnauthorizedResponse | InternalErrorResponse;
|
|
27
|
+
/**
|
|
28
|
+
* @summary List graphs
|
|
29
|
+
*/
|
|
30
|
+
export declare function useListGraphs<TData = Awaited<ReturnType<typeof listGraphs>>, TError = UnauthorizedResponse | InternalErrorResponse>(options?: {
|
|
31
|
+
query?: UseQueryOptions<Awaited<ReturnType<typeof listGraphs>>, TError, TData>;
|
|
32
|
+
request?: SecondParameter<typeof paRequest>;
|
|
33
|
+
}): UseQueryResult<TData, TError> & {
|
|
34
|
+
queryKey: QueryKey;
|
|
35
|
+
};
|
|
36
|
+
/**
|
|
37
|
+
* Returns the data of the given graphs for the universe, in the order they were requested. A
|
|
38
|
+
* graph that could not be drawn has `successful: false` and an `error_message`; the others
|
|
39
|
+
* are still returned.
|
|
40
|
+
* @summary Query graphs of a universe
|
|
41
|
+
*/
|
|
42
|
+
export declare const queryUniverseGraphs: (universeId: string, graphQuerySpec: GraphQuerySpec[], options?: SecondParameter<typeof paRequest>) => Promise<Graph[]>;
|
|
43
|
+
export declare const getQueryUniverseGraphsMutationKey: () => readonly ["queryUniverseGraphs"];
|
|
44
|
+
export declare const getQueryUniverseGraphsMutationOptions: <TError = import("../../model").Error, TContext = unknown>(options?: {
|
|
45
|
+
mutation?: UseMutationOptions<Graph[], TError, QueryUniverseGraphsMutationVariables, TContext> | undefined;
|
|
46
|
+
request?: SecondParameter<typeof paRequest>;
|
|
47
|
+
} | undefined) => UseMutationOptions<Graph[], TError, QueryUniverseGraphsMutationVariables, TContext>;
|
|
48
|
+
export type QueryUniverseGraphsMutationResult = NonNullable<Awaited<ReturnType<typeof queryUniverseGraphs>>>;
|
|
49
|
+
export type QueryUniverseGraphsMutationBody = GraphQuerySpec[];
|
|
50
|
+
export type QueryUniverseGraphsMutationError = BadRequestResponse | UnauthorizedResponse | ForbiddenResponse | NotFoundResponse | InternalErrorResponse;
|
|
51
|
+
export type QueryUniverseGraphsMutationVariables = {
|
|
52
|
+
universeId: string;
|
|
53
|
+
data: GraphQuerySpec[];
|
|
54
|
+
};
|
|
55
|
+
/**
|
|
56
|
+
* @summary Query graphs of a universe
|
|
57
|
+
*/
|
|
58
|
+
export declare const useQueryUniverseGraphs: <TError = import("../../model").Error, TContext = unknown>(options?: {
|
|
59
|
+
mutation?: UseMutationOptions<Graph[], TError, QueryUniverseGraphsMutationVariables, TContext> | undefined;
|
|
60
|
+
request?: SecondParameter<typeof paRequest>;
|
|
61
|
+
} | undefined) => UseMutationResult<Graph[], TError, QueryUniverseGraphsMutationVariables, TContext>;
|
|
62
|
+
export {};
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
import type { QueryKey, UseQueryOptions, UseQueryResult } from 'react-query';
|
|
2
|
+
import type { InternalErrorResponse } from '../../model/internalErrorResponse';
|
|
3
|
+
import type { PerfAdvisor } from '../../model/perfAdvisor';
|
|
4
|
+
import type { UnauthorizedResponse } from '../../model/unauthorizedResponse';
|
|
5
|
+
import { paRequest } from '../../../http';
|
|
6
|
+
type SecondParameter<T extends (...args: never) => unknown> = Parameters<T>[1];
|
|
7
|
+
/**
|
|
8
|
+
* Returns the version of this Perf Advisor instance and how it is deployed.
|
|
9
|
+
* @summary Get Perf Advisor information
|
|
10
|
+
*/
|
|
11
|
+
export declare const getPaInfo: (options?: SecondParameter<typeof paRequest>) => Promise<PerfAdvisor>;
|
|
12
|
+
export declare const getGetPaInfoQueryKey: () => readonly ["/pa-info"];
|
|
13
|
+
export declare const getGetPaInfoQueryOptions: <TData = PerfAdvisor, TError = import("../../model").Error>(options?: {
|
|
14
|
+
query?: UseQueryOptions<PerfAdvisor, TError, TData, QueryKey> | undefined;
|
|
15
|
+
request?: SecondParameter<typeof paRequest>;
|
|
16
|
+
} | undefined) => UseQueryOptions<PerfAdvisor, TError, TData, QueryKey> & {
|
|
17
|
+
queryKey: QueryKey;
|
|
18
|
+
};
|
|
19
|
+
export type GetPaInfoQueryResult = NonNullable<Awaited<ReturnType<typeof getPaInfo>>>;
|
|
20
|
+
export type GetPaInfoQueryError = UnauthorizedResponse | InternalErrorResponse;
|
|
21
|
+
/**
|
|
22
|
+
* @summary Get Perf Advisor information
|
|
23
|
+
*/
|
|
24
|
+
export declare function useGetPaInfo<TData = Awaited<ReturnType<typeof getPaInfo>>, TError = UnauthorizedResponse | InternalErrorResponse>(options?: {
|
|
25
|
+
query?: UseQueryOptions<Awaited<ReturnType<typeof getPaInfo>>, TError, TData>;
|
|
26
|
+
request?: SecondParameter<typeof paRequest>;
|
|
27
|
+
}): UseQueryResult<TData, TError> & {
|
|
28
|
+
queryKey: QueryKey;
|
|
29
|
+
};
|
|
30
|
+
export {};
|
|
@@ -0,0 +1,80 @@
|
|
|
1
|
+
import type { QueryKey, UseMutationOptions, UseMutationResult, UseQueryOptions, UseQueryResult } from 'react-query';
|
|
2
|
+
import type { BadRequestResponse } from '../../model/badRequestResponse';
|
|
3
|
+
import type { ConflictResponse } from '../../model/conflictResponse';
|
|
4
|
+
import type { InternalErrorResponse } from '../../model/internalErrorResponse';
|
|
5
|
+
import type { ListRuntimeConfigsParams } from '../../model/listRuntimeConfigsParams';
|
|
6
|
+
import type { RuntimeConfig } from '../../model/runtimeConfig';
|
|
7
|
+
import type { RuntimeConfigSpec } from '../../model/runtimeConfigSpec';
|
|
8
|
+
import type { UnauthorizedResponse } from '../../model/unauthorizedResponse';
|
|
9
|
+
import { paRequest } from '../../../http';
|
|
10
|
+
type SecondParameter<T extends (...args: never) => unknown> = Parameters<T>[1];
|
|
11
|
+
/**
|
|
12
|
+
* Lists the runtime configuration effective globally. Ordered by key.
|
|
13
|
+
* @summary List globally runtime configuration
|
|
14
|
+
*/
|
|
15
|
+
export declare const listRuntimeConfigs: (params?: ListRuntimeConfigsParams, options?: SecondParameter<typeof paRequest>) => Promise<RuntimeConfig[]>;
|
|
16
|
+
export declare const getListRuntimeConfigsQueryKey: (params?: ListRuntimeConfigsParams) => readonly ["/runtime-configs", ...ListRuntimeConfigsParams[]];
|
|
17
|
+
export declare const getListRuntimeConfigsQueryOptions: <TData = RuntimeConfig[], TError = import("../../model").Error>(params?: ListRuntimeConfigsParams, options?: {
|
|
18
|
+
query?: UseQueryOptions<RuntimeConfig[], TError, TData, QueryKey> | undefined;
|
|
19
|
+
request?: SecondParameter<typeof paRequest>;
|
|
20
|
+
} | undefined) => UseQueryOptions<RuntimeConfig[], TError, TData, QueryKey> & {
|
|
21
|
+
queryKey: QueryKey;
|
|
22
|
+
};
|
|
23
|
+
export type ListRuntimeConfigsQueryResult = NonNullable<Awaited<ReturnType<typeof listRuntimeConfigs>>>;
|
|
24
|
+
export type ListRuntimeConfigsQueryError = UnauthorizedResponse | InternalErrorResponse;
|
|
25
|
+
/**
|
|
26
|
+
* @summary List globally runtime configuration
|
|
27
|
+
*/
|
|
28
|
+
export declare function useListRuntimeConfigs<TData = Awaited<ReturnType<typeof listRuntimeConfigs>>, TError = UnauthorizedResponse | InternalErrorResponse>(params?: ListRuntimeConfigsParams, options?: {
|
|
29
|
+
query?: UseQueryOptions<Awaited<ReturnType<typeof listRuntimeConfigs>>, TError, TData>;
|
|
30
|
+
request?: SecondParameter<typeof paRequest>;
|
|
31
|
+
}): UseQueryResult<TData, TError> & {
|
|
32
|
+
queryKey: QueryKey;
|
|
33
|
+
};
|
|
34
|
+
/**
|
|
35
|
+
* Sets the value of the key globally.
|
|
36
|
+
* @summary Set a runtime configuration value globally
|
|
37
|
+
*/
|
|
38
|
+
export declare const setRuntimeConfig: (key: string, runtimeConfigSpec: RuntimeConfigSpec, options?: SecondParameter<typeof paRequest>) => Promise<RuntimeConfig>;
|
|
39
|
+
export declare const getSetRuntimeConfigMutationKey: () => readonly ["setRuntimeConfig"];
|
|
40
|
+
export declare const getSetRuntimeConfigMutationOptions: <TError = import("../../model").Error, TContext = unknown>(options?: {
|
|
41
|
+
mutation?: UseMutationOptions<RuntimeConfig, TError, SetRuntimeConfigMutationVariables, TContext> | undefined;
|
|
42
|
+
request?: SecondParameter<typeof paRequest>;
|
|
43
|
+
} | undefined) => UseMutationOptions<RuntimeConfig, TError, SetRuntimeConfigMutationVariables, TContext>;
|
|
44
|
+
export type SetRuntimeConfigMutationResult = NonNullable<Awaited<ReturnType<typeof setRuntimeConfig>>>;
|
|
45
|
+
export type SetRuntimeConfigMutationBody = RuntimeConfigSpec;
|
|
46
|
+
export type SetRuntimeConfigMutationError = BadRequestResponse | UnauthorizedResponse | ConflictResponse | InternalErrorResponse;
|
|
47
|
+
export type SetRuntimeConfigMutationVariables = {
|
|
48
|
+
key: string;
|
|
49
|
+
data: RuntimeConfigSpec;
|
|
50
|
+
};
|
|
51
|
+
/**
|
|
52
|
+
* @summary Set a runtime configuration value globally
|
|
53
|
+
*/
|
|
54
|
+
export declare const useSetRuntimeConfig: <TError = import("../../model").Error, TContext = unknown>(options?: {
|
|
55
|
+
mutation?: UseMutationOptions<RuntimeConfig, TError, SetRuntimeConfigMutationVariables, TContext> | undefined;
|
|
56
|
+
request?: SecondParameter<typeof paRequest>;
|
|
57
|
+
} | undefined) => UseMutationResult<RuntimeConfig, TError, SetRuntimeConfigMutationVariables, TContext>;
|
|
58
|
+
/**
|
|
59
|
+
* Removes the value set globally, so the inherited value or the default applies again.
|
|
60
|
+
* @summary Remove a runtime configuration value globally
|
|
61
|
+
*/
|
|
62
|
+
export declare const deleteRuntimeConfig: (key: string, options?: SecondParameter<typeof paRequest>) => Promise<void>;
|
|
63
|
+
export declare const getDeleteRuntimeConfigMutationKey: () => readonly ["deleteRuntimeConfig"];
|
|
64
|
+
export declare const getDeleteRuntimeConfigMutationOptions: <TError = import("../../model").Error, TContext = unknown>(options?: {
|
|
65
|
+
mutation?: UseMutationOptions<void, TError, DeleteRuntimeConfigMutationVariables, TContext> | undefined;
|
|
66
|
+
request?: SecondParameter<typeof paRequest>;
|
|
67
|
+
} | undefined) => UseMutationOptions<void, TError, DeleteRuntimeConfigMutationVariables, TContext>;
|
|
68
|
+
export type DeleteRuntimeConfigMutationResult = NonNullable<Awaited<ReturnType<typeof deleteRuntimeConfig>>>;
|
|
69
|
+
export type DeleteRuntimeConfigMutationError = UnauthorizedResponse | ConflictResponse | InternalErrorResponse;
|
|
70
|
+
export type DeleteRuntimeConfigMutationVariables = {
|
|
71
|
+
key: string;
|
|
72
|
+
};
|
|
73
|
+
/**
|
|
74
|
+
* @summary Remove a runtime configuration value globally
|
|
75
|
+
*/
|
|
76
|
+
export declare const useDeleteRuntimeConfig: <TError = import("../../model").Error, TContext = unknown>(options?: {
|
|
77
|
+
mutation?: UseMutationOptions<void, TError, DeleteRuntimeConfigMutationVariables, TContext> | undefined;
|
|
78
|
+
request?: SecondParameter<typeof paRequest>;
|
|
79
|
+
} | undefined) => UseMutationResult<void, TError, DeleteRuntimeConfigMutationVariables, TContext>;
|
|
80
|
+
export {};
|
|
@@ -0,0 +1,214 @@
|
|
|
1
|
+
import type { QueryKey, UseQueryOptions, UseQueryResult } from 'react-query';
|
|
2
|
+
import type { BadRequestResponse } from '../../model/badRequestResponse';
|
|
3
|
+
import type { DatabasePagedResp } from '../../model/databasePagedResp';
|
|
4
|
+
import type { DatabaseSchemaPagedResp } from '../../model/databaseSchemaPagedResp';
|
|
5
|
+
import type { ForbiddenResponse } from '../../model/forbiddenResponse';
|
|
6
|
+
import type { IndexPagedResp } from '../../model/indexPagedResp';
|
|
7
|
+
import type { InternalErrorResponse } from '../../model/internalErrorResponse';
|
|
8
|
+
import type { ListDatabaseSchemasParams } from '../../model/listDatabaseSchemasParams';
|
|
9
|
+
import type { ListDatabasesParams } from '../../model/listDatabasesParams';
|
|
10
|
+
import type { ListIndexesParams } from '../../model/listIndexesParams';
|
|
11
|
+
import type { ListMaterializedViewsParams } from '../../model/listMaterializedViewsParams';
|
|
12
|
+
import type { ListTableStatsParams } from '../../model/listTableStatsParams';
|
|
13
|
+
import type { ListTabletStatsParams } from '../../model/listTabletStatsParams';
|
|
14
|
+
import type { MaterializedViewPagedResp } from '../../model/materializedViewPagedResp';
|
|
15
|
+
import type { NotFoundResponse } from '../../model/notFoundResponse';
|
|
16
|
+
import type { TableStatsPagedResp } from '../../model/tableStatsPagedResp';
|
|
17
|
+
import type { TabletStatsPagedResp } from '../../model/tabletStatsPagedResp';
|
|
18
|
+
import type { UnauthorizedResponse } from '../../model/unauthorizedResponse';
|
|
19
|
+
import { paRequest } from '../../../http';
|
|
20
|
+
type SecondParameter<T extends (...args: never) => unknown> = Parameters<T>[1];
|
|
21
|
+
/**
|
|
22
|
+
* Lists the universe's active YSQL databases and YCQL keyspaces. YugabyteDB's own databases,
|
|
23
|
+
* such as `system_platform`, are typed `SYSTEM`, as in database statistics. Ordered by name,
|
|
24
|
+
* then type, ascending by default.
|
|
25
|
+
* @summary List databases
|
|
26
|
+
*/
|
|
27
|
+
export declare const listDatabases: (universeId: string, params?: ListDatabasesParams, options?: SecondParameter<typeof paRequest>) => Promise<DatabasePagedResp>;
|
|
28
|
+
export declare const getListDatabasesQueryKey: (universeId: string, params?: ListDatabasesParams) => readonly [`/universes/${string}/databases`, ...ListDatabasesParams[]];
|
|
29
|
+
export declare const getListDatabasesQueryOptions: <TData = import("../../model").Pagination & {
|
|
30
|
+
entities: import("../../model").Database[];
|
|
31
|
+
}, TError = import("../../model").Error>(universeId: string, params?: ListDatabasesParams, options?: {
|
|
32
|
+
query?: UseQueryOptions<import("../../model").Pagination & {
|
|
33
|
+
entities: import("../../model").Database[];
|
|
34
|
+
}, TError, TData, QueryKey> | undefined;
|
|
35
|
+
request?: SecondParameter<typeof paRequest>;
|
|
36
|
+
} | undefined) => UseQueryOptions<import("../../model").Pagination & {
|
|
37
|
+
entities: import("../../model").Database[];
|
|
38
|
+
}, TError, TData, QueryKey> & {
|
|
39
|
+
queryKey: QueryKey;
|
|
40
|
+
};
|
|
41
|
+
export type ListDatabasesQueryResult = NonNullable<Awaited<ReturnType<typeof listDatabases>>>;
|
|
42
|
+
export type ListDatabasesQueryError = BadRequestResponse | UnauthorizedResponse | ForbiddenResponse | NotFoundResponse | InternalErrorResponse;
|
|
43
|
+
/**
|
|
44
|
+
* @summary List databases
|
|
45
|
+
*/
|
|
46
|
+
export declare function useListDatabases<TData = Awaited<ReturnType<typeof listDatabases>>, TError = BadRequestResponse | UnauthorizedResponse | ForbiddenResponse | NotFoundResponse | InternalErrorResponse>(universeId: string, params?: ListDatabasesParams, options?: {
|
|
47
|
+
query?: UseQueryOptions<Awaited<ReturnType<typeof listDatabases>>, TError, TData>;
|
|
48
|
+
request?: SecondParameter<typeof paRequest>;
|
|
49
|
+
}): UseQueryResult<TData, TError> & {
|
|
50
|
+
queryKey: QueryKey;
|
|
51
|
+
};
|
|
52
|
+
/**
|
|
53
|
+
* Lists the schemas of a YSQL database that hold tables. Ordered by name, ascending by
|
|
54
|
+
* default.
|
|
55
|
+
* @summary List the schemas of a database
|
|
56
|
+
*/
|
|
57
|
+
export declare const listDatabaseSchemas: (universeId: string, databaseName: string, params?: ListDatabaseSchemasParams, options?: SecondParameter<typeof paRequest>) => Promise<DatabaseSchemaPagedResp>;
|
|
58
|
+
export declare const getListDatabaseSchemasQueryKey: (universeId: string, databaseName: string, params?: ListDatabaseSchemasParams) => readonly [`/universes/${string}/databases/${string}/schemas`, ...ListDatabaseSchemasParams[]];
|
|
59
|
+
export declare const getListDatabaseSchemasQueryOptions: <TData = import("../../model").Pagination & {
|
|
60
|
+
entities: import("../../model").DatabaseSchema[];
|
|
61
|
+
}, TError = import("../../model").Error>(universeId: string, databaseName: string, params?: ListDatabaseSchemasParams, options?: {
|
|
62
|
+
query?: UseQueryOptions<import("../../model").Pagination & {
|
|
63
|
+
entities: import("../../model").DatabaseSchema[];
|
|
64
|
+
}, TError, TData, QueryKey> | undefined;
|
|
65
|
+
request?: SecondParameter<typeof paRequest>;
|
|
66
|
+
} | undefined) => UseQueryOptions<import("../../model").Pagination & {
|
|
67
|
+
entities: import("../../model").DatabaseSchema[];
|
|
68
|
+
}, TError, TData, QueryKey> & {
|
|
69
|
+
queryKey: QueryKey;
|
|
70
|
+
};
|
|
71
|
+
export type ListDatabaseSchemasQueryResult = NonNullable<Awaited<ReturnType<typeof listDatabaseSchemas>>>;
|
|
72
|
+
export type ListDatabaseSchemasQueryError = BadRequestResponse | UnauthorizedResponse | ForbiddenResponse | NotFoundResponse | InternalErrorResponse;
|
|
73
|
+
/**
|
|
74
|
+
* @summary List the schemas of a database
|
|
75
|
+
*/
|
|
76
|
+
export declare function useListDatabaseSchemas<TData = Awaited<ReturnType<typeof listDatabaseSchemas>>, TError = BadRequestResponse | UnauthorizedResponse | ForbiddenResponse | NotFoundResponse | InternalErrorResponse>(universeId: string, databaseName: string, params?: ListDatabaseSchemasParams, options?: {
|
|
77
|
+
query?: UseQueryOptions<Awaited<ReturnType<typeof listDatabaseSchemas>>, TError, TData>;
|
|
78
|
+
request?: SecondParameter<typeof paRequest>;
|
|
79
|
+
}): UseQueryResult<TData, TError> & {
|
|
80
|
+
queryKey: QueryKey;
|
|
81
|
+
};
|
|
82
|
+
/**
|
|
83
|
+
* Lists YSQL tables and YCQL tables and indexes, with their size. A property only one type
|
|
84
|
+
* has is not set for the other: `table_id`, `columns`, `definition`,
|
|
85
|
+
* `definition_updated_time` and `colocated` are YSQL-only, `table_uuid`, `index` and `state`
|
|
86
|
+
* YCQL-only. YSQL and YCQL tables are read separately and merged in memory. Ordered by
|
|
87
|
+
* `sort_by`, descending by default. Tables without the sorted value (a YCQL table has no
|
|
88
|
+
* schema) come last in either direction. With `start_time`, the tables that existed in the
|
|
89
|
+
* window are listed and sizes cover it; without it, only the tables that still exist, with
|
|
90
|
+
* sizes over the day before `end_time`.
|
|
91
|
+
* @summary List tables
|
|
92
|
+
*/
|
|
93
|
+
export declare const listTableStats: (universeId: string, params?: ListTableStatsParams, options?: SecondParameter<typeof paRequest>) => Promise<TableStatsPagedResp>;
|
|
94
|
+
export declare const getListTableStatsQueryKey: (universeId: string, params?: ListTableStatsParams) => readonly [`/universes/${string}/table-stats`, ...ListTableStatsParams[]];
|
|
95
|
+
export declare const getListTableStatsQueryOptions: <TData = import("../../model").Pagination & {
|
|
96
|
+
summary?: import("../../model").StatsSummary | undefined;
|
|
97
|
+
entities: import("../../model").TableStats[];
|
|
98
|
+
}, TError = import("../../model").Error>(universeId: string, params?: ListTableStatsParams, options?: {
|
|
99
|
+
query?: UseQueryOptions<import("../../model").Pagination & {
|
|
100
|
+
summary?: import("../../model").StatsSummary | undefined;
|
|
101
|
+
entities: import("../../model").TableStats[];
|
|
102
|
+
}, TError, TData, QueryKey> | undefined;
|
|
103
|
+
request?: SecondParameter<typeof paRequest>;
|
|
104
|
+
} | undefined) => UseQueryOptions<import("../../model").Pagination & {
|
|
105
|
+
summary?: import("../../model").StatsSummary | undefined;
|
|
106
|
+
entities: import("../../model").TableStats[];
|
|
107
|
+
}, TError, TData, QueryKey> & {
|
|
108
|
+
queryKey: QueryKey;
|
|
109
|
+
};
|
|
110
|
+
export type ListTableStatsQueryResult = NonNullable<Awaited<ReturnType<typeof listTableStats>>>;
|
|
111
|
+
export type ListTableStatsQueryError = BadRequestResponse | UnauthorizedResponse | ForbiddenResponse | NotFoundResponse | InternalErrorResponse;
|
|
112
|
+
/**
|
|
113
|
+
* @summary List tables
|
|
114
|
+
*/
|
|
115
|
+
export declare function useListTableStats<TData = Awaited<ReturnType<typeof listTableStats>>, TError = BadRequestResponse | UnauthorizedResponse | ForbiddenResponse | NotFoundResponse | InternalErrorResponse>(universeId: string, params?: ListTableStatsParams, options?: {
|
|
116
|
+
query?: UseQueryOptions<Awaited<ReturnType<typeof listTableStats>>, TError, TData>;
|
|
117
|
+
request?: SecondParameter<typeof paRequest>;
|
|
118
|
+
}): UseQueryResult<TData, TError> & {
|
|
119
|
+
queryKey: QueryKey;
|
|
120
|
+
};
|
|
121
|
+
/**
|
|
122
|
+
* Lists YSQL indexes. With `start_time`, the indexes that existed in the window; without it,
|
|
123
|
+
* only the indexes that still exist. Ordered by `sort_by`, ascending by default.
|
|
124
|
+
* @summary List YSQL indexes
|
|
125
|
+
*/
|
|
126
|
+
export declare const listIndexes: (universeId: string, params?: ListIndexesParams, options?: SecondParameter<typeof paRequest>) => Promise<IndexPagedResp>;
|
|
127
|
+
export declare const getListIndexesQueryKey: (universeId: string, params?: ListIndexesParams) => readonly [`/universes/${string}/indexes`, ...ListIndexesParams[]];
|
|
128
|
+
export declare const getListIndexesQueryOptions: <TData = import("../../model").Pagination & {
|
|
129
|
+
entities: import("../../model").Index[];
|
|
130
|
+
}, TError = import("../../model").Error>(universeId: string, params?: ListIndexesParams, options?: {
|
|
131
|
+
query?: UseQueryOptions<import("../../model").Pagination & {
|
|
132
|
+
entities: import("../../model").Index[];
|
|
133
|
+
}, TError, TData, QueryKey> | undefined;
|
|
134
|
+
request?: SecondParameter<typeof paRequest>;
|
|
135
|
+
} | undefined) => UseQueryOptions<import("../../model").Pagination & {
|
|
136
|
+
entities: import("../../model").Index[];
|
|
137
|
+
}, TError, TData, QueryKey> & {
|
|
138
|
+
queryKey: QueryKey;
|
|
139
|
+
};
|
|
140
|
+
export type ListIndexesQueryResult = NonNullable<Awaited<ReturnType<typeof listIndexes>>>;
|
|
141
|
+
export type ListIndexesQueryError = BadRequestResponse | UnauthorizedResponse | ForbiddenResponse | NotFoundResponse | InternalErrorResponse;
|
|
142
|
+
/**
|
|
143
|
+
* @summary List YSQL indexes
|
|
144
|
+
*/
|
|
145
|
+
export declare function useListIndexes<TData = Awaited<ReturnType<typeof listIndexes>>, TError = BadRequestResponse | UnauthorizedResponse | ForbiddenResponse | NotFoundResponse | InternalErrorResponse>(universeId: string, params?: ListIndexesParams, options?: {
|
|
146
|
+
query?: UseQueryOptions<Awaited<ReturnType<typeof listIndexes>>, TError, TData>;
|
|
147
|
+
request?: SecondParameter<typeof paRequest>;
|
|
148
|
+
}): UseQueryResult<TData, TError> & {
|
|
149
|
+
queryKey: QueryKey;
|
|
150
|
+
};
|
|
151
|
+
/**
|
|
152
|
+
* Lists YSQL materialized views. With `start_time`, the views that existed in the window;
|
|
153
|
+
* without it, only the views that still exist. Ordered by `sort_by`, ascending by default.
|
|
154
|
+
* @summary List YSQL materialized views
|
|
155
|
+
*/
|
|
156
|
+
export declare const listMaterializedViews: (universeId: string, params?: ListMaterializedViewsParams, options?: SecondParameter<typeof paRequest>) => Promise<MaterializedViewPagedResp>;
|
|
157
|
+
export declare const getListMaterializedViewsQueryKey: (universeId: string, params?: ListMaterializedViewsParams) => readonly [`/universes/${string}/materialized-views`, ...ListMaterializedViewsParams[]];
|
|
158
|
+
export declare const getListMaterializedViewsQueryOptions: <TData = import("../../model").Pagination & {
|
|
159
|
+
entities: import("../../model").MaterializedView[];
|
|
160
|
+
}, TError = import("../../model").Error>(universeId: string, params?: ListMaterializedViewsParams, options?: {
|
|
161
|
+
query?: UseQueryOptions<import("../../model").Pagination & {
|
|
162
|
+
entities: import("../../model").MaterializedView[];
|
|
163
|
+
}, TError, TData, QueryKey> | undefined;
|
|
164
|
+
request?: SecondParameter<typeof paRequest>;
|
|
165
|
+
} | undefined) => UseQueryOptions<import("../../model").Pagination & {
|
|
166
|
+
entities: import("../../model").MaterializedView[];
|
|
167
|
+
}, TError, TData, QueryKey> & {
|
|
168
|
+
queryKey: QueryKey;
|
|
169
|
+
};
|
|
170
|
+
export type ListMaterializedViewsQueryResult = NonNullable<Awaited<ReturnType<typeof listMaterializedViews>>>;
|
|
171
|
+
export type ListMaterializedViewsQueryError = BadRequestResponse | UnauthorizedResponse | ForbiddenResponse | NotFoundResponse | InternalErrorResponse;
|
|
172
|
+
/**
|
|
173
|
+
* @summary List YSQL materialized views
|
|
174
|
+
*/
|
|
175
|
+
export declare function useListMaterializedViews<TData = Awaited<ReturnType<typeof listMaterializedViews>>, TError = BadRequestResponse | UnauthorizedResponse | ForbiddenResponse | NotFoundResponse | InternalErrorResponse>(universeId: string, params?: ListMaterializedViewsParams, options?: {
|
|
176
|
+
query?: UseQueryOptions<Awaited<ReturnType<typeof listMaterializedViews>>, TError, TData>;
|
|
177
|
+
request?: SecondParameter<typeof paRequest>;
|
|
178
|
+
}): UseQueryResult<TData, TError> & {
|
|
179
|
+
queryKey: QueryKey;
|
|
180
|
+
};
|
|
181
|
+
/**
|
|
182
|
+
* Lists tablets, with their load and size over the time range, which defaults to the day
|
|
183
|
+
* before `end_time`. Ordered by `sort_by`, descending by default.
|
|
184
|
+
* @summary List tablets
|
|
185
|
+
*/
|
|
186
|
+
export declare const listTabletStats: (universeId: string, params?: ListTabletStatsParams, options?: SecondParameter<typeof paRequest>) => Promise<TabletStatsPagedResp>;
|
|
187
|
+
export declare const getListTabletStatsQueryKey: (universeId: string, params?: ListTabletStatsParams) => readonly [`/universes/${string}/tablet-stats`, ...ListTabletStatsParams[]];
|
|
188
|
+
export declare const getListTabletStatsQueryOptions: <TData = import("../../model").Pagination & {
|
|
189
|
+
summary?: import("../../model").StatsSummary | undefined;
|
|
190
|
+
entities: import("../../model").TabletStats[];
|
|
191
|
+
}, TError = import("../../model").Error>(universeId: string, params?: ListTabletStatsParams, options?: {
|
|
192
|
+
query?: UseQueryOptions<import("../../model").Pagination & {
|
|
193
|
+
summary?: import("../../model").StatsSummary | undefined;
|
|
194
|
+
entities: import("../../model").TabletStats[];
|
|
195
|
+
}, TError, TData, QueryKey> | undefined;
|
|
196
|
+
request?: SecondParameter<typeof paRequest>;
|
|
197
|
+
} | undefined) => UseQueryOptions<import("../../model").Pagination & {
|
|
198
|
+
summary?: import("../../model").StatsSummary | undefined;
|
|
199
|
+
entities: import("../../model").TabletStats[];
|
|
200
|
+
}, TError, TData, QueryKey> & {
|
|
201
|
+
queryKey: QueryKey;
|
|
202
|
+
};
|
|
203
|
+
export type ListTabletStatsQueryResult = NonNullable<Awaited<ReturnType<typeof listTabletStats>>>;
|
|
204
|
+
export type ListTabletStatsQueryError = BadRequestResponse | UnauthorizedResponse | ForbiddenResponse | NotFoundResponse | InternalErrorResponse;
|
|
205
|
+
/**
|
|
206
|
+
* @summary List tablets
|
|
207
|
+
*/
|
|
208
|
+
export declare function useListTabletStats<TData = Awaited<ReturnType<typeof listTabletStats>>, TError = BadRequestResponse | UnauthorizedResponse | ForbiddenResponse | NotFoundResponse | InternalErrorResponse>(universeId: string, params?: ListTabletStatsParams, options?: {
|
|
209
|
+
query?: UseQueryOptions<Awaited<ReturnType<typeof listTabletStats>>, TError, TData>;
|
|
210
|
+
request?: SecondParameter<typeof paRequest>;
|
|
211
|
+
}): UseQueryResult<TData, TError> & {
|
|
212
|
+
queryKey: QueryKey;
|
|
213
|
+
};
|
|
214
|
+
export {};
|
|
@@ -0,0 +1,167 @@
|
|
|
1
|
+
import type { QueryKey, UseMutationOptions, UseMutationResult, UseQueryOptions, UseQueryResult } from 'react-query';
|
|
2
|
+
import type { BadRequestResponse } from '../../model/badRequestResponse';
|
|
3
|
+
import type { ConflictResponse } from '../../model/conflictResponse';
|
|
4
|
+
import type { DeleteSupportBundleParams } from '../../model/deleteSupportBundleParams';
|
|
5
|
+
import type { EstimateSupportBundleSizeParams } from '../../model/estimateSupportBundleSizeParams';
|
|
6
|
+
import type { ForbiddenResponse } from '../../model/forbiddenResponse';
|
|
7
|
+
import type { InternalErrorResponse } from '../../model/internalErrorResponse';
|
|
8
|
+
import type { ListSupportBundlesParams } from '../../model/listSupportBundlesParams';
|
|
9
|
+
import type { NotFoundResponse } from '../../model/notFoundResponse';
|
|
10
|
+
import type { SupportBundle } from '../../model/supportBundle';
|
|
11
|
+
import type { SupportBundlePagedResp } from '../../model/supportBundlePagedResp';
|
|
12
|
+
import type { SupportBundleSizeEstimate } from '../../model/supportBundleSizeEstimate';
|
|
13
|
+
import type { SupportBundleSpec } from '../../model/supportBundleSpec';
|
|
14
|
+
import type { UnauthorizedResponse } from '../../model/unauthorizedResponse';
|
|
15
|
+
import { paRequest } from '../../../http';
|
|
16
|
+
type SecondParameter<T extends (...args: never) => unknown> = Parameters<T>[1];
|
|
17
|
+
/**
|
|
18
|
+
* Lists the universe's support bundles. Ordered by scheduled time, newest first by default
|
|
19
|
+
* (`direction` `DESC`).
|
|
20
|
+
* @summary List a universe's support bundles
|
|
21
|
+
*/
|
|
22
|
+
export declare const listSupportBundles: (universeId: string, params?: ListSupportBundlesParams, options?: SecondParameter<typeof paRequest>) => Promise<SupportBundlePagedResp>;
|
|
23
|
+
export declare const getListSupportBundlesQueryKey: (universeId: string, params?: ListSupportBundlesParams) => readonly [`/universes/${string}/support-bundles`, ...ListSupportBundlesParams[]];
|
|
24
|
+
export declare const getListSupportBundlesQueryOptions: <TData = import("../../model").Pagination & {
|
|
25
|
+
entities: SupportBundle[];
|
|
26
|
+
}, TError = import("../../model").Error>(universeId: string, params?: ListSupportBundlesParams, options?: {
|
|
27
|
+
query?: UseQueryOptions<import("../../model").Pagination & {
|
|
28
|
+
entities: SupportBundle[];
|
|
29
|
+
}, TError, TData, QueryKey> | undefined;
|
|
30
|
+
request?: SecondParameter<typeof paRequest>;
|
|
31
|
+
} | undefined) => UseQueryOptions<import("../../model").Pagination & {
|
|
32
|
+
entities: SupportBundle[];
|
|
33
|
+
}, TError, TData, QueryKey> & {
|
|
34
|
+
queryKey: QueryKey;
|
|
35
|
+
};
|
|
36
|
+
export type ListSupportBundlesQueryResult = NonNullable<Awaited<ReturnType<typeof listSupportBundles>>>;
|
|
37
|
+
export type ListSupportBundlesQueryError = BadRequestResponse | UnauthorizedResponse | ForbiddenResponse | NotFoundResponse | InternalErrorResponse;
|
|
38
|
+
/**
|
|
39
|
+
* @summary List a universe's support bundles
|
|
40
|
+
*/
|
|
41
|
+
export declare function useListSupportBundles<TData = Awaited<ReturnType<typeof listSupportBundles>>, TError = BadRequestResponse | UnauthorizedResponse | ForbiddenResponse | NotFoundResponse | InternalErrorResponse>(universeId: string, params?: ListSupportBundlesParams, options?: {
|
|
42
|
+
query?: UseQueryOptions<Awaited<ReturnType<typeof listSupportBundles>>, TError, TData>;
|
|
43
|
+
request?: SecondParameter<typeof paRequest>;
|
|
44
|
+
}): UseQueryResult<TData, TError> & {
|
|
45
|
+
queryKey: QueryKey;
|
|
46
|
+
};
|
|
47
|
+
/**
|
|
48
|
+
* Starts collecting a support bundle of the universe's data for the time range.
|
|
49
|
+
* Returns once collection is scheduled; progress is in `info.state`.
|
|
50
|
+
* @summary Create a support bundle
|
|
51
|
+
*/
|
|
52
|
+
export declare const createSupportBundle: (universeId: string, supportBundleSpec: SupportBundleSpec, options?: SecondParameter<typeof paRequest>) => Promise<SupportBundle>;
|
|
53
|
+
export declare const getCreateSupportBundleMutationKey: () => readonly ["createSupportBundle"];
|
|
54
|
+
export declare const getCreateSupportBundleMutationOptions: <TError = import("../../model").Error, TContext = unknown>(options?: {
|
|
55
|
+
mutation?: UseMutationOptions<SupportBundle, TError, CreateSupportBundleMutationVariables, TContext> | undefined;
|
|
56
|
+
request?: SecondParameter<typeof paRequest>;
|
|
57
|
+
} | undefined) => UseMutationOptions<SupportBundle, TError, CreateSupportBundleMutationVariables, TContext>;
|
|
58
|
+
export type CreateSupportBundleMutationResult = NonNullable<Awaited<ReturnType<typeof createSupportBundle>>>;
|
|
59
|
+
export type CreateSupportBundleMutationBody = SupportBundleSpec;
|
|
60
|
+
export type CreateSupportBundleMutationError = BadRequestResponse | UnauthorizedResponse | ForbiddenResponse | NotFoundResponse | ConflictResponse | InternalErrorResponse;
|
|
61
|
+
export type CreateSupportBundleMutationVariables = {
|
|
62
|
+
universeId: string;
|
|
63
|
+
data: SupportBundleSpec;
|
|
64
|
+
};
|
|
65
|
+
/**
|
|
66
|
+
* @summary Create a support bundle
|
|
67
|
+
*/
|
|
68
|
+
export declare const useCreateSupportBundle: <TError = import("../../model").Error, TContext = unknown>(options?: {
|
|
69
|
+
mutation?: UseMutationOptions<SupportBundle, TError, CreateSupportBundleMutationVariables, TContext> | undefined;
|
|
70
|
+
request?: SecondParameter<typeof paRequest>;
|
|
71
|
+
} | undefined) => UseMutationResult<SupportBundle, TError, CreateSupportBundleMutationVariables, TContext>;
|
|
72
|
+
/**
|
|
73
|
+
* Estimates the size of a support bundle for this time window and metric format, without
|
|
74
|
+
* creating it. Both `start_time` and `end_time` are required, and the start must be before
|
|
75
|
+
* the end.
|
|
76
|
+
* @summary Estimate the size of a support bundle
|
|
77
|
+
*/
|
|
78
|
+
export declare const estimateSupportBundleSize: (universeId: string, params?: EstimateSupportBundleSizeParams, options?: SecondParameter<typeof paRequest>) => Promise<SupportBundleSizeEstimate>;
|
|
79
|
+
export declare const getEstimateSupportBundleSizeQueryKey: (universeId: string, params?: EstimateSupportBundleSizeParams) => readonly [`/universes/${string}/support-bundles/size-estimate`, ...EstimateSupportBundleSizeParams[]];
|
|
80
|
+
export declare const getEstimateSupportBundleSizeQueryOptions: <TData = SupportBundleSizeEstimate, TError = import("../../model").Error>(universeId: string, params?: EstimateSupportBundleSizeParams, options?: {
|
|
81
|
+
query?: UseQueryOptions<SupportBundleSizeEstimate, TError, TData, QueryKey> | undefined;
|
|
82
|
+
request?: SecondParameter<typeof paRequest>;
|
|
83
|
+
} | undefined) => UseQueryOptions<SupportBundleSizeEstimate, TError, TData, QueryKey> & {
|
|
84
|
+
queryKey: QueryKey;
|
|
85
|
+
};
|
|
86
|
+
export type EstimateSupportBundleSizeQueryResult = NonNullable<Awaited<ReturnType<typeof estimateSupportBundleSize>>>;
|
|
87
|
+
export type EstimateSupportBundleSizeQueryError = BadRequestResponse | UnauthorizedResponse | ForbiddenResponse | NotFoundResponse | InternalErrorResponse;
|
|
88
|
+
/**
|
|
89
|
+
* @summary Estimate the size of a support bundle
|
|
90
|
+
*/
|
|
91
|
+
export declare function useEstimateSupportBundleSize<TData = Awaited<ReturnType<typeof estimateSupportBundleSize>>, TError = BadRequestResponse | UnauthorizedResponse | ForbiddenResponse | NotFoundResponse | InternalErrorResponse>(universeId: string, params?: EstimateSupportBundleSizeParams, options?: {
|
|
92
|
+
query?: UseQueryOptions<Awaited<ReturnType<typeof estimateSupportBundleSize>>, TError, TData>;
|
|
93
|
+
request?: SecondParameter<typeof paRequest>;
|
|
94
|
+
}): UseQueryResult<TData, TError> & {
|
|
95
|
+
queryKey: QueryKey;
|
|
96
|
+
};
|
|
97
|
+
/**
|
|
98
|
+
* Returns a support bundle.
|
|
99
|
+
* @summary Get a support bundle
|
|
100
|
+
*/
|
|
101
|
+
export declare const getSupportBundle: (universeId: string, supportBundleId: string, options?: SecondParameter<typeof paRequest>) => Promise<SupportBundle>;
|
|
102
|
+
export declare const getGetSupportBundleQueryKey: (universeId: string, supportBundleId: string) => readonly [`/universes/${string}/support-bundles/${string}`];
|
|
103
|
+
export declare const getGetSupportBundleQueryOptions: <TData = SupportBundle, TError = import("../../model").Error>(universeId: string, supportBundleId: string, options?: {
|
|
104
|
+
query?: UseQueryOptions<SupportBundle, TError, TData, QueryKey> | undefined;
|
|
105
|
+
request?: SecondParameter<typeof paRequest>;
|
|
106
|
+
} | undefined) => UseQueryOptions<SupportBundle, TError, TData, QueryKey> & {
|
|
107
|
+
queryKey: QueryKey;
|
|
108
|
+
};
|
|
109
|
+
export type GetSupportBundleQueryResult = NonNullable<Awaited<ReturnType<typeof getSupportBundle>>>;
|
|
110
|
+
export type GetSupportBundleQueryError = UnauthorizedResponse | ForbiddenResponse | NotFoundResponse | InternalErrorResponse;
|
|
111
|
+
/**
|
|
112
|
+
* @summary Get a support bundle
|
|
113
|
+
*/
|
|
114
|
+
export declare function useGetSupportBundle<TData = Awaited<ReturnType<typeof getSupportBundle>>, TError = UnauthorizedResponse | ForbiddenResponse | NotFoundResponse | InternalErrorResponse>(universeId: string, supportBundleId: string, options?: {
|
|
115
|
+
query?: UseQueryOptions<Awaited<ReturnType<typeof getSupportBundle>>, TError, TData>;
|
|
116
|
+
request?: SecondParameter<typeof paRequest>;
|
|
117
|
+
}): UseQueryResult<TData, TError> & {
|
|
118
|
+
queryKey: QueryKey;
|
|
119
|
+
};
|
|
120
|
+
/**
|
|
121
|
+
* Deletes the support bundle and, unless `clean_data` is false, its file.
|
|
122
|
+
* @summary Delete a support bundle
|
|
123
|
+
*/
|
|
124
|
+
export declare const deleteSupportBundle: (universeId: string, supportBundleId: string, params?: DeleteSupportBundleParams, options?: SecondParameter<typeof paRequest>) => Promise<void>;
|
|
125
|
+
export declare const getDeleteSupportBundleMutationKey: () => readonly ["deleteSupportBundle"];
|
|
126
|
+
export declare const getDeleteSupportBundleMutationOptions: <TError = import("../../model").Error, TContext = unknown>(options?: {
|
|
127
|
+
mutation?: UseMutationOptions<void, TError, DeleteSupportBundleMutationVariables, TContext> | undefined;
|
|
128
|
+
request?: SecondParameter<typeof paRequest>;
|
|
129
|
+
} | undefined) => UseMutationOptions<void, TError, DeleteSupportBundleMutationVariables, TContext>;
|
|
130
|
+
export type DeleteSupportBundleMutationResult = NonNullable<Awaited<ReturnType<typeof deleteSupportBundle>>>;
|
|
131
|
+
export type DeleteSupportBundleMutationError = UnauthorizedResponse | ForbiddenResponse | NotFoundResponse | ConflictResponse | InternalErrorResponse;
|
|
132
|
+
export type DeleteSupportBundleMutationVariables = {
|
|
133
|
+
universeId: string;
|
|
134
|
+
supportBundleId: string;
|
|
135
|
+
params?: DeleteSupportBundleParams;
|
|
136
|
+
};
|
|
137
|
+
/**
|
|
138
|
+
* @summary Delete a support bundle
|
|
139
|
+
*/
|
|
140
|
+
export declare const useDeleteSupportBundle: <TError = import("../../model").Error, TContext = unknown>(options?: {
|
|
141
|
+
mutation?: UseMutationOptions<void, TError, DeleteSupportBundleMutationVariables, TContext> | undefined;
|
|
142
|
+
request?: SecondParameter<typeof paRequest>;
|
|
143
|
+
} | undefined) => UseMutationResult<void, TError, DeleteSupportBundleMutationVariables, TContext>;
|
|
144
|
+
/**
|
|
145
|
+
* Returns the bundle file. The bundle must be `COMPLETED`.
|
|
146
|
+
* @summary Download a support bundle
|
|
147
|
+
*/
|
|
148
|
+
export declare const downloadSupportBundle: (universeId: string, supportBundleId: string, options?: SecondParameter<typeof paRequest>) => Promise<Blob>;
|
|
149
|
+
export declare const getDownloadSupportBundleQueryKey: (universeId: string, supportBundleId: string) => readonly [`/universes/${string}/support-bundles/${string}/download`];
|
|
150
|
+
export declare const getDownloadSupportBundleQueryOptions: <TData = Blob, TError = import("../../model").Error>(universeId: string, supportBundleId: string, options?: {
|
|
151
|
+
query?: UseQueryOptions<Blob, TError, TData, QueryKey> | undefined;
|
|
152
|
+
request?: SecondParameter<typeof paRequest>;
|
|
153
|
+
} | undefined) => UseQueryOptions<Blob, TError, TData, QueryKey> & {
|
|
154
|
+
queryKey: QueryKey;
|
|
155
|
+
};
|
|
156
|
+
export type DownloadSupportBundleQueryResult = NonNullable<Awaited<ReturnType<typeof downloadSupportBundle>>>;
|
|
157
|
+
export type DownloadSupportBundleQueryError = BadRequestResponse | UnauthorizedResponse | ForbiddenResponse | NotFoundResponse | InternalErrorResponse;
|
|
158
|
+
/**
|
|
159
|
+
* @summary Download a support bundle
|
|
160
|
+
*/
|
|
161
|
+
export declare function useDownloadSupportBundle<TData = Awaited<ReturnType<typeof downloadSupportBundle>>, TError = BadRequestResponse | UnauthorizedResponse | ForbiddenResponse | NotFoundResponse | InternalErrorResponse>(universeId: string, supportBundleId: string, options?: {
|
|
162
|
+
query?: UseQueryOptions<Awaited<ReturnType<typeof downloadSupportBundle>>, TError, TData>;
|
|
163
|
+
request?: SecondParameter<typeof paRequest>;
|
|
164
|
+
}): UseQueryResult<TData, TError> & {
|
|
165
|
+
queryKey: QueryKey;
|
|
166
|
+
};
|
|
167
|
+
export {};
|