@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,22 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Generated by orval 🍺
|
|
3
|
+
* Do not edit manually.
|
|
4
|
+
* Perf Advisor API
|
|
5
|
+
* Perf Advisor v2 REST API.
|
|
6
|
+
*
|
|
7
|
+
* Resources are returned as `{ spec, info }`: `spec` holds the properties a client sets,
|
|
8
|
+
* `info` holds read-only properties Perf Advisor computes.
|
|
9
|
+
*
|
|
10
|
+
* OpenAPI spec version: v2
|
|
11
|
+
*/
|
|
12
|
+
import type { AggregatedLineSettingsAggregation } from './aggregatedLineSettingsAggregation';
|
|
13
|
+
/**
|
|
14
|
+
* Adds a line that aggregates the graph's series over one label, for example the sum over wait events.
|
|
15
|
+
*/
|
|
16
|
+
export interface AggregatedLineSettings {
|
|
17
|
+
/** Graph label (snake_case) to aggregate over. */
|
|
18
|
+
aggregate_by: string;
|
|
19
|
+
aggregation: AggregatedLineSettingsAggregation;
|
|
20
|
+
/** Whether the line leaves out the values the graph's filters select. */
|
|
21
|
+
exclude_filtered?: boolean;
|
|
22
|
+
}
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Generated by orval 🍺
|
|
3
|
+
* Do not edit manually.
|
|
4
|
+
* Perf Advisor API
|
|
5
|
+
* Perf Advisor v2 REST API.
|
|
6
|
+
*
|
|
7
|
+
* Resources are returned as `{ spec, info }`: `spec` holds the properties a client sets,
|
|
8
|
+
* `info` holds read-only properties Perf Advisor computes.
|
|
9
|
+
*
|
|
10
|
+
* OpenAPI spec version: v2
|
|
11
|
+
*/
|
|
12
|
+
export type AggregatedLineSettingsAggregation = typeof AggregatedLineSettingsAggregation[keyof typeof AggregatedLineSettingsAggregation];
|
|
13
|
+
export declare const AggregatedLineSettingsAggregation: {
|
|
14
|
+
readonly MIN: "MIN";
|
|
15
|
+
readonly MAX: "MAX";
|
|
16
|
+
readonly AVG: "AVG";
|
|
17
|
+
readonly SUM: "SUM";
|
|
18
|
+
};
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Generated by orval 🍺
|
|
3
|
+
* Do not edit manually.
|
|
4
|
+
* Perf Advisor API
|
|
5
|
+
* Perf Advisor v2 REST API.
|
|
6
|
+
*
|
|
7
|
+
* Resources are returned as `{ spec, info }`: `spec` holds the properties a client sets,
|
|
8
|
+
* `info` holds read-only properties Perf Advisor computes.
|
|
9
|
+
*
|
|
10
|
+
* OpenAPI spec version: v2
|
|
11
|
+
*/
|
|
12
|
+
import type { AnomalyInfo } from './anomalyInfo';
|
|
13
|
+
/**
|
|
14
|
+
* An anomaly or insight Perf Advisor detected. Perf Advisor generates it entirely, so it has `info` only.
|
|
15
|
+
*/
|
|
16
|
+
export interface Anomaly {
|
|
17
|
+
info: AnomalyInfo;
|
|
18
|
+
}
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Generated by orval 🍺
|
|
3
|
+
* Do not edit manually.
|
|
4
|
+
* Perf Advisor API
|
|
5
|
+
* Perf Advisor v2 REST API.
|
|
6
|
+
*
|
|
7
|
+
* Resources are returned as `{ spec, info }`: `spec` holds the properties a client sets,
|
|
8
|
+
* `info` holds read-only properties Perf Advisor computes.
|
|
9
|
+
*
|
|
10
|
+
* OpenAPI spec version: v2
|
|
11
|
+
*/
|
|
12
|
+
import type { AnomalyIndexDetails } from './anomalyIndexDetails';
|
|
13
|
+
/**
|
|
14
|
+
* Details specific to the kind of anomaly. Each kind sets its own group.
|
|
15
|
+
*/
|
|
16
|
+
export interface AnomalyDetails {
|
|
17
|
+
index?: AnomalyIndexDetails;
|
|
18
|
+
}
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Generated by orval 🍺
|
|
3
|
+
* Do not edit manually.
|
|
4
|
+
* Perf Advisor API
|
|
5
|
+
* Perf Advisor v2 REST API.
|
|
6
|
+
*
|
|
7
|
+
* Resources are returned as `{ spec, info }`: `spec` holds the properties a client sets,
|
|
8
|
+
* `info` holds read-only properties Perf Advisor computes.
|
|
9
|
+
*
|
|
10
|
+
* OpenAPI spec version: v2
|
|
11
|
+
*/
|
|
12
|
+
import type { AnomalyDetectionInfo } from './anomalyDetectionInfo';
|
|
13
|
+
/**
|
|
14
|
+
* On-demand anomaly detection of a universe.
|
|
15
|
+
*/
|
|
16
|
+
export interface AnomalyDetection {
|
|
17
|
+
info: AnomalyDetectionInfo;
|
|
18
|
+
}
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Generated by orval 🍺
|
|
3
|
+
* Do not edit manually.
|
|
4
|
+
* Perf Advisor API
|
|
5
|
+
* Perf Advisor v2 REST API.
|
|
6
|
+
*
|
|
7
|
+
* Resources are returned as `{ spec, info }`: `spec` holds the properties a client sets,
|
|
8
|
+
* `info` holds read-only properties Perf Advisor computes.
|
|
9
|
+
*
|
|
10
|
+
* OpenAPI spec version: v2
|
|
11
|
+
*/
|
|
12
|
+
import type { AnomalyDetectionInfoState } from './anomalyDetectionInfoState';
|
|
13
|
+
export interface AnomalyDetectionInfo {
|
|
14
|
+
readonly universe_uuid: string;
|
|
15
|
+
/** State of the latest on-demand detection run. Not set if none was started. */
|
|
16
|
+
readonly state?: AnomalyDetectionInfoState;
|
|
17
|
+
readonly state_time?: string;
|
|
18
|
+
readonly last_success_time?: string;
|
|
19
|
+
/** End of the time window the latest successful run covered. */
|
|
20
|
+
readonly detection_end_time?: string;
|
|
21
|
+
}
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Generated by orval 🍺
|
|
3
|
+
* Do not edit manually.
|
|
4
|
+
* Perf Advisor API
|
|
5
|
+
* Perf Advisor v2 REST API.
|
|
6
|
+
*
|
|
7
|
+
* Resources are returned as `{ spec, info }`: `spec` holds the properties a client sets,
|
|
8
|
+
* `info` holds read-only properties Perf Advisor computes.
|
|
9
|
+
*
|
|
10
|
+
* OpenAPI spec version: v2
|
|
11
|
+
*/
|
|
12
|
+
/**
|
|
13
|
+
* State of the latest on-demand detection run. Not set if none was started.
|
|
14
|
+
*/
|
|
15
|
+
export type AnomalyDetectionInfoState = typeof AnomalyDetectionInfoState[keyof typeof AnomalyDetectionInfoState];
|
|
16
|
+
export declare const AnomalyDetectionInfoState: {
|
|
17
|
+
readonly SCHEDULED: "SCHEDULED";
|
|
18
|
+
readonly IN_PROGRESS: "IN_PROGRESS";
|
|
19
|
+
readonly SUCCESS: "SUCCESS";
|
|
20
|
+
readonly FAILURE: "FAILURE";
|
|
21
|
+
};
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Generated by orval 🍺
|
|
3
|
+
* Do not edit manually.
|
|
4
|
+
* Perf Advisor API
|
|
5
|
+
* Perf Advisor v2 REST API.
|
|
6
|
+
*
|
|
7
|
+
* Resources are returned as `{ spec, info }`: `spec` holds the properties a client sets,
|
|
8
|
+
* `info` holds read-only properties Perf Advisor computes.
|
|
9
|
+
*
|
|
10
|
+
* OpenAPI spec version: v2
|
|
11
|
+
*/
|
|
12
|
+
import type { AnomalyEntityLabels } from './anomalyEntityLabels';
|
|
13
|
+
/**
|
|
14
|
+
* The entity an anomaly is about.
|
|
15
|
+
*/
|
|
16
|
+
export interface AnomalyEntity {
|
|
17
|
+
/** Kind of entity: `NODE`, `TABLE`, `INDEX` or `QUERY`. New values may be added. */
|
|
18
|
+
readonly type: string;
|
|
19
|
+
readonly id?: string;
|
|
20
|
+
readonly display_name?: string;
|
|
21
|
+
/** Graph labels (snake_case) that identify the entity, for filtering its graphs. */
|
|
22
|
+
readonly labels?: AnomalyEntityLabels;
|
|
23
|
+
}
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Generated by orval 🍺
|
|
3
|
+
* Do not edit manually.
|
|
4
|
+
* Perf Advisor API
|
|
5
|
+
* Perf Advisor v2 REST API.
|
|
6
|
+
*
|
|
7
|
+
* Resources are returned as `{ spec, info }`: `spec` holds the properties a client sets,
|
|
8
|
+
* `info` holds read-only properties Perf Advisor computes.
|
|
9
|
+
*
|
|
10
|
+
* OpenAPI spec version: v2
|
|
11
|
+
*/
|
|
12
|
+
/**
|
|
13
|
+
* Graph labels (snake_case) that identify the entity, for filtering its graphs.
|
|
14
|
+
*/
|
|
15
|
+
export type AnomalyEntityLabels = {
|
|
16
|
+
[key: string]: string;
|
|
17
|
+
};
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Generated by orval 🍺
|
|
3
|
+
* Do not edit manually.
|
|
4
|
+
* Perf Advisor API
|
|
5
|
+
* Perf Advisor v2 REST API.
|
|
6
|
+
*
|
|
7
|
+
* Resources are returned as `{ spec, info }`: `spec` holds the properties a client sets,
|
|
8
|
+
* `info` holds read-only properties Perf Advisor computes.
|
|
9
|
+
*
|
|
10
|
+
* OpenAPI spec version: v2
|
|
11
|
+
*/
|
|
12
|
+
/**
|
|
13
|
+
* Which anomalies to list.
|
|
14
|
+
*/
|
|
15
|
+
export interface AnomalyFilter {
|
|
16
|
+
/** Only `PERF_ANOMALY` or only `INSIGHT`. */
|
|
17
|
+
anomaly_type?: string;
|
|
18
|
+
/** Only anomalies of this category, for example `SQL` or `NODE`. */
|
|
19
|
+
category?: string;
|
|
20
|
+
/** Only anomalies of this type, for example `HOT_NODE_CPU`. */
|
|
21
|
+
type?: string;
|
|
22
|
+
/** Only anomalies whose summary contains this text. */
|
|
23
|
+
summary?: string;
|
|
24
|
+
/** Only query anomalies whose query text contains this text. */
|
|
25
|
+
query?: string;
|
|
26
|
+
/** Only query, table and index anomalies in this database. */
|
|
27
|
+
database_name?: string;
|
|
28
|
+
/** Only table and index anomalies in this schema. */
|
|
29
|
+
schema_name?: string;
|
|
30
|
+
/** Only anomalies of this table. */
|
|
31
|
+
table_name?: string;
|
|
32
|
+
}
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Generated by orval 🍺
|
|
3
|
+
* Do not edit manually.
|
|
4
|
+
* Perf Advisor API
|
|
5
|
+
* Perf Advisor v2 REST API.
|
|
6
|
+
*
|
|
7
|
+
* Resources are returned as `{ spec, info }`: `spec` holds the properties a client sets,
|
|
8
|
+
* `info` holds read-only properties Perf Advisor computes.
|
|
9
|
+
*
|
|
10
|
+
* OpenAPI spec version: v2
|
|
11
|
+
*/
|
|
12
|
+
import type { AggregatedLineSettings } from './aggregatedLineSettings';
|
|
13
|
+
import type { GraphFilters } from './graphFilters';
|
|
14
|
+
/**
|
|
15
|
+
* A graph to show for an anomaly, with the filters that narrow it to the anomaly's entity.
|
|
16
|
+
*/
|
|
17
|
+
export interface AnomalyGraph {
|
|
18
|
+
/** Graph name, as in the graph catalog. */
|
|
19
|
+
readonly name: string;
|
|
20
|
+
readonly display_name?: string;
|
|
21
|
+
readonly threshold?: number;
|
|
22
|
+
filters?: GraphFilters;
|
|
23
|
+
exclude_filters?: GraphFilters;
|
|
24
|
+
readonly aggregated_line?: AggregatedLineSettings;
|
|
25
|
+
/** Graph labels (snake_case) to split the graph by. */
|
|
26
|
+
readonly group_by?: readonly string[];
|
|
27
|
+
}
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Generated by orval 🍺
|
|
3
|
+
* Do not edit manually.
|
|
4
|
+
* Perf Advisor API
|
|
5
|
+
* Perf Advisor v2 REST API.
|
|
6
|
+
*
|
|
7
|
+
* Resources are returned as `{ spec, info }`: `spec` holds the properties a client sets,
|
|
8
|
+
* `info` holds read-only properties Perf Advisor computes.
|
|
9
|
+
*
|
|
10
|
+
* OpenAPI spec version: v2
|
|
11
|
+
*/
|
|
12
|
+
import type { AnomalyGroupInfo } from './anomalyGroupInfo';
|
|
13
|
+
/**
|
|
14
|
+
* The anomalies of one type on one entity in the requested window.
|
|
15
|
+
*/
|
|
16
|
+
export interface AnomalyGroup {
|
|
17
|
+
info: AnomalyGroupInfo;
|
|
18
|
+
}
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Generated by orval 🍺
|
|
3
|
+
* Do not edit manually.
|
|
4
|
+
* Perf Advisor API
|
|
5
|
+
* Perf Advisor v2 REST API.
|
|
6
|
+
*
|
|
7
|
+
* Resources are returned as `{ spec, info }`: `spec` holds the properties a client sets,
|
|
8
|
+
* `info` holds read-only properties Perf Advisor computes.
|
|
9
|
+
*
|
|
10
|
+
* OpenAPI spec version: v2
|
|
11
|
+
*/
|
|
12
|
+
import type { AnomalyInfo } from './anomalyInfo';
|
|
13
|
+
import type { TimeWindow } from './timeWindow';
|
|
14
|
+
export interface AnomalyGroupInfo {
|
|
15
|
+
readonly group_id: string;
|
|
16
|
+
last_instance: AnomalyInfo;
|
|
17
|
+
/** When the group's anomalies were active. */
|
|
18
|
+
readonly intervals?: readonly TimeWindow[];
|
|
19
|
+
/** Relative severity, for ordering groups. Higher is more severe. */
|
|
20
|
+
readonly severity?: number;
|
|
21
|
+
}
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Generated by orval 🍺
|
|
3
|
+
* Do not edit manually.
|
|
4
|
+
* Perf Advisor API
|
|
5
|
+
* Perf Advisor v2 REST API.
|
|
6
|
+
*
|
|
7
|
+
* Resources are returned as `{ spec, info }`: `spec` holds the properties a client sets,
|
|
8
|
+
* `info` holds read-only properties Perf Advisor computes.
|
|
9
|
+
*
|
|
10
|
+
* OpenAPI spec version: v2
|
|
11
|
+
*/
|
|
12
|
+
import type { AnomalyGroup } from './anomalyGroup';
|
|
13
|
+
import type { Pagination } from './pagination';
|
|
14
|
+
export type AnomalyGroupPagedResp = Pagination & {
|
|
15
|
+
entities: AnomalyGroup[];
|
|
16
|
+
};
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Generated by orval 🍺
|
|
3
|
+
* Do not edit manually.
|
|
4
|
+
* Perf Advisor API
|
|
5
|
+
* Perf Advisor v2 REST API.
|
|
6
|
+
*
|
|
7
|
+
* Resources are returned as `{ spec, info }`: `spec` holds the properties a client sets,
|
|
8
|
+
* `info` holds read-only properties Perf Advisor computes.
|
|
9
|
+
*
|
|
10
|
+
* OpenAPI spec version: v2
|
|
11
|
+
*/
|
|
12
|
+
import type { AnomalyGroup } from './anomalyGroup';
|
|
13
|
+
import type { TimeWindow } from './timeWindow';
|
|
14
|
+
/**
|
|
15
|
+
* The most severe anomaly groups of one anomaly type.
|
|
16
|
+
*/
|
|
17
|
+
export interface AnomalyGroupsOfType {
|
|
18
|
+
readonly category: string;
|
|
19
|
+
readonly type: string;
|
|
20
|
+
readonly title?: string;
|
|
21
|
+
/** Number of groups of this type in the window. */
|
|
22
|
+
readonly total_count?: number;
|
|
23
|
+
/** Whether there are more groups of this type than returned. */
|
|
24
|
+
readonly has_more?: boolean;
|
|
25
|
+
readonly groups: readonly AnomalyGroup[];
|
|
26
|
+
/** When the groups not returned were active. */
|
|
27
|
+
readonly more_intervals?: readonly TimeWindow[];
|
|
28
|
+
}
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Generated by orval 🍺
|
|
3
|
+
* Do not edit manually.
|
|
4
|
+
* Perf Advisor API
|
|
5
|
+
* Perf Advisor v2 REST API.
|
|
6
|
+
*
|
|
7
|
+
* Resources are returned as `{ spec, info }`: `spec` holds the properties a client sets,
|
|
8
|
+
* `info` holds read-only properties Perf Advisor computes.
|
|
9
|
+
*
|
|
10
|
+
* OpenAPI spec version: v2
|
|
11
|
+
*/
|
|
12
|
+
import type { IndexDefinition } from './indexDefinition';
|
|
13
|
+
import type { TableRef } from './tableRef';
|
|
14
|
+
/**
|
|
15
|
+
* The index an unused or redundant index anomaly is about.
|
|
16
|
+
*/
|
|
17
|
+
export interface AnomalyIndexDetails {
|
|
18
|
+
/** The index, with its table, schema and database. */
|
|
19
|
+
table?: TableRef;
|
|
20
|
+
/** The `CREATE INDEX` statement of the index. */
|
|
21
|
+
readonly definition?: string;
|
|
22
|
+
/** For a redundant index, the index that makes it redundant. */
|
|
23
|
+
other_index?: IndexDefinition;
|
|
24
|
+
}
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Generated by orval 🍺
|
|
3
|
+
* Do not edit manually.
|
|
4
|
+
* Perf Advisor API
|
|
5
|
+
* Perf Advisor v2 REST API.
|
|
6
|
+
*
|
|
7
|
+
* Resources are returned as `{ spec, info }`: `spec` holds the properties a client sets,
|
|
8
|
+
* `info` holds read-only properties Perf Advisor computes.
|
|
9
|
+
*
|
|
10
|
+
* OpenAPI spec version: v2
|
|
11
|
+
*/
|
|
12
|
+
import type { AnomalyDetails } from './anomalyDetails';
|
|
13
|
+
import type { AnomalyEntity } from './anomalyEntity';
|
|
14
|
+
import type { AnomalyGraph } from './anomalyGraph';
|
|
15
|
+
import type { GraphSettings } from './graphSettings';
|
|
16
|
+
import type { GraphWindow } from './graphWindow';
|
|
17
|
+
import type { RcaGuideline } from './rcaGuideline';
|
|
18
|
+
import type { TimeWindow } from './timeWindow';
|
|
19
|
+
export interface AnomalyInfo {
|
|
20
|
+
readonly uuid: string;
|
|
21
|
+
/** Anomalies of the same type on the same entity share a group. */
|
|
22
|
+
readonly group_id?: string;
|
|
23
|
+
/** `PERF_ANOMALY` or `INSIGHT`. New values may be added. */
|
|
24
|
+
readonly anomaly_type: string;
|
|
25
|
+
/** `APP`, `DB`, `INFRA`, `NODE` or `SQL`. New values may be added. */
|
|
26
|
+
readonly category: string;
|
|
27
|
+
/** What was detected, for example `SQL_QUERY_LATENCY_INCREASE` or `HOT_NODE_CPU`. New values come with new detectors. */
|
|
28
|
+
readonly type: string;
|
|
29
|
+
readonly title?: string;
|
|
30
|
+
readonly description?: string;
|
|
31
|
+
readonly summary?: string;
|
|
32
|
+
entity: AnomalyEntity;
|
|
33
|
+
readonly detection_time?: string;
|
|
34
|
+
readonly last_update_time?: string;
|
|
35
|
+
window?: TimeWindow;
|
|
36
|
+
graph?: GraphWindow;
|
|
37
|
+
/** Share of the universe's average active sessions the anomaly wastes, where measured. */
|
|
38
|
+
readonly wasted_aas_ratio?: number;
|
|
39
|
+
/** Graphs that show the anomaly. */
|
|
40
|
+
readonly main_graphs?: readonly AnomalyGraph[];
|
|
41
|
+
/** How to split the anomaly's graphs by default. */
|
|
42
|
+
readonly default_settings?: GraphSettings;
|
|
43
|
+
details?: AnomalyDetails;
|
|
44
|
+
/** Possible causes and how to troubleshoot them. */
|
|
45
|
+
readonly rca_guidelines?: readonly RcaGuideline[];
|
|
46
|
+
}
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Generated by orval 🍺
|
|
3
|
+
* Do not edit manually.
|
|
4
|
+
* Perf Advisor API
|
|
5
|
+
* Perf Advisor v2 REST API.
|
|
6
|
+
*
|
|
7
|
+
* Resources are returned as `{ spec, info }`: `spec` holds the properties a client sets,
|
|
8
|
+
* `info` holds read-only properties Perf Advisor computes.
|
|
9
|
+
*
|
|
10
|
+
* OpenAPI spec version: v2
|
|
11
|
+
*/
|
|
12
|
+
import type { Anomaly } from './anomaly';
|
|
13
|
+
import type { Pagination } from './pagination';
|
|
14
|
+
export type AnomalyPagedResp = Pagination & {
|
|
15
|
+
entities: Anomaly[];
|
|
16
|
+
};
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Generated by orval 🍺
|
|
3
|
+
* Do not edit manually.
|
|
4
|
+
* Perf Advisor API
|
|
5
|
+
* Perf Advisor v2 REST API.
|
|
6
|
+
*
|
|
7
|
+
* Resources are returned as `{ spec, info }`: `spec` holds the properties a client sets,
|
|
8
|
+
* `info` holds read-only properties Perf Advisor computes.
|
|
9
|
+
*
|
|
10
|
+
* OpenAPI spec version: v2
|
|
11
|
+
*/
|
|
12
|
+
/**
|
|
13
|
+
* `WASTED_AAS_RATIO` ranks by the share of the universe's load the anomaly wastes; anomalies without one come last in either direction.
|
|
14
|
+
*/
|
|
15
|
+
export type AnomalySortBy = typeof AnomalySortBy[keyof typeof AnomalySortBy];
|
|
16
|
+
export declare const AnomalySortBy: {
|
|
17
|
+
readonly START_TIME: "START_TIME";
|
|
18
|
+
readonly END_TIME: "END_TIME";
|
|
19
|
+
readonly TYPE: "TYPE";
|
|
20
|
+
readonly CATEGORY: "CATEGORY";
|
|
21
|
+
readonly SUMMARY: "SUMMARY";
|
|
22
|
+
readonly WASTED_AAS_RATIO: "WASTED_AAS_RATIO";
|
|
23
|
+
};
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Generated by orval 🍺
|
|
3
|
+
* Do not edit manually.
|
|
4
|
+
* Perf Advisor API
|
|
5
|
+
* Perf Advisor v2 REST API.
|
|
6
|
+
*
|
|
7
|
+
* Resources are returned as `{ spec, info }`: `spec` holds the properties a client sets,
|
|
8
|
+
* `info` holds read-only properties Perf Advisor computes.
|
|
9
|
+
*
|
|
10
|
+
* OpenAPI spec version: v2
|
|
11
|
+
*/
|
|
12
|
+
import type { AnomalyGraph } from './anomalyGraph';
|
|
13
|
+
import type { GraphSettings } from './graphSettings';
|
|
14
|
+
import type { RcaGuideline } from './rcaGuideline';
|
|
15
|
+
/**
|
|
16
|
+
* A kind of anomaly Perf Advisor can detect, with how it is shown and troubleshot.
|
|
17
|
+
*/
|
|
18
|
+
export interface AnomalyType {
|
|
19
|
+
/** `PERF_ANOMALY` or `INSIGHT`. */
|
|
20
|
+
readonly anomaly_type: string;
|
|
21
|
+
readonly category: string;
|
|
22
|
+
readonly type: string;
|
|
23
|
+
readonly entity_type: string;
|
|
24
|
+
readonly title?: string;
|
|
25
|
+
readonly description?: string;
|
|
26
|
+
readonly main_graphs?: readonly AnomalyGraph[];
|
|
27
|
+
/** How to split the type's graphs by default. */
|
|
28
|
+
readonly default_settings?: GraphSettings;
|
|
29
|
+
readonly rca_guidelines?: readonly RcaGuideline[];
|
|
30
|
+
}
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Generated by orval 🍺
|
|
3
|
+
* Do not edit manually.
|
|
4
|
+
* Perf Advisor API
|
|
5
|
+
* Perf Advisor v2 REST API.
|
|
6
|
+
*
|
|
7
|
+
* Resources are returned as `{ spec, info }`: `spec` holds the properties a client sets,
|
|
8
|
+
* `info` holds read-only properties Perf Advisor computes.
|
|
9
|
+
*
|
|
10
|
+
* OpenAPI spec version: v2
|
|
11
|
+
*/
|
|
12
|
+
import type { Error } from './error';
|
|
13
|
+
/**
|
|
14
|
+
* The request is invalid.
|
|
15
|
+
*/
|
|
16
|
+
export type BadRequestResponse = Error;
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Generated by orval 🍺
|
|
3
|
+
* Do not edit manually.
|
|
4
|
+
* Perf Advisor API
|
|
5
|
+
* Perf Advisor v2 REST API.
|
|
6
|
+
*
|
|
7
|
+
* Resources are returned as `{ spec, info }`: `spec` holds the properties a client sets,
|
|
8
|
+
* `info` holds read-only properties Perf Advisor computes.
|
|
9
|
+
*
|
|
10
|
+
* OpenAPI spec version: v2
|
|
11
|
+
*/
|
|
12
|
+
import type { ClusterRefClusterType } from './clusterRefClusterType';
|
|
13
|
+
/**
|
|
14
|
+
* A cluster of a universe.
|
|
15
|
+
*/
|
|
16
|
+
export interface ClusterRef {
|
|
17
|
+
readonly uuid: string;
|
|
18
|
+
readonly cluster_type?: ClusterRefClusterType;
|
|
19
|
+
}
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Generated by orval 🍺
|
|
3
|
+
* Do not edit manually.
|
|
4
|
+
* Perf Advisor API
|
|
5
|
+
* Perf Advisor v2 REST API.
|
|
6
|
+
*
|
|
7
|
+
* Resources are returned as `{ spec, info }`: `spec` holds the properties a client sets,
|
|
8
|
+
* `info` holds read-only properties Perf Advisor computes.
|
|
9
|
+
*
|
|
10
|
+
* OpenAPI spec version: v2
|
|
11
|
+
*/
|
|
12
|
+
export type ClusterRefClusterType = typeof ClusterRefClusterType[keyof typeof ClusterRefClusterType];
|
|
13
|
+
export declare const ClusterRefClusterType: {
|
|
14
|
+
readonly PRIMARY: "PRIMARY";
|
|
15
|
+
readonly ASYNC: "ASYNC";
|
|
16
|
+
readonly ADDON: "ADDON";
|
|
17
|
+
};
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Generated by orval 🍺
|
|
3
|
+
* Do not edit manually.
|
|
4
|
+
* Perf Advisor API
|
|
5
|
+
* Perf Advisor v2 REST API.
|
|
6
|
+
*
|
|
7
|
+
* Resources are returned as `{ spec, info }`: `spec` holds the properties a client sets,
|
|
8
|
+
* `info` holds read-only properties Perf Advisor computes.
|
|
9
|
+
*
|
|
10
|
+
* OpenAPI spec version: v2
|
|
11
|
+
*/
|
|
12
|
+
import type { Error } from './error';
|
|
13
|
+
/**
|
|
14
|
+
* The request conflicts with the current state, for example a standby Perf Advisor refusing a change.
|
|
15
|
+
*/
|
|
16
|
+
export type ConflictResponse = Error;
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Generated by orval 🍺
|
|
3
|
+
* Do not edit manually.
|
|
4
|
+
* Perf Advisor API
|
|
5
|
+
* Perf Advisor v2 REST API.
|
|
6
|
+
*
|
|
7
|
+
* Resources are returned as `{ spec, info }`: `spec` holds the properties a client sets,
|
|
8
|
+
* `info` holds read-only properties Perf Advisor computes.
|
|
9
|
+
*
|
|
10
|
+
* OpenAPI spec version: v2
|
|
11
|
+
*/
|
|
12
|
+
/**
|
|
13
|
+
* CPU use over the requested period.
|
|
14
|
+
*/
|
|
15
|
+
export interface CpuStats {
|
|
16
|
+
/** Share of the universe's CPU, from 0 to 1. */
|
|
17
|
+
readonly universe_ratio?: number;
|
|
18
|
+
/** Average share of the universe's CPU cores the database's cgroup used, from 0 to 1. Not relative to the database's own CPU limit. */
|
|
19
|
+
readonly avg_cgroup_ratio?: number;
|
|
20
|
+
/** Peak share of the universe's CPU cores the database's cgroup used, from 0 to 1. Not relative to the database's own CPU limit. */
|
|
21
|
+
readonly peak_cgroup_ratio?: number;
|
|
22
|
+
/** How long the database's cgroup was CPU-throttled, in ms per second, averaged over the period. It does not grow with the length of the period. */
|
|
23
|
+
readonly throttled_ms?: number;
|
|
24
|
+
}
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Generated by orval 🍺
|
|
3
|
+
* Do not edit manually.
|
|
4
|
+
* Perf Advisor API
|
|
5
|
+
* Perf Advisor v2 REST API.
|
|
6
|
+
*
|
|
7
|
+
* Resources are returned as `{ spec, info }`: `spec` holds the properties a client sets,
|
|
8
|
+
* `info` holds read-only properties Perf Advisor computes.
|
|
9
|
+
*
|
|
10
|
+
* OpenAPI spec version: v2
|
|
11
|
+
*/
|
|
12
|
+
import type { CredentialsType } from './credentialsType';
|
|
13
|
+
/**
|
|
14
|
+
* Credentials Perf Advisor uses to reach another system. Secrets are never returned: omit one on
|
|
15
|
+
* a `PUT` to keep the stored value, send an empty string to clear it. `password_set` and
|
|
16
|
+
* `token_set` say whether one is stored.
|
|
17
|
+
*/
|
|
18
|
+
export interface Credentials {
|
|
19
|
+
/**
|
|
20
|
+
* `NONE` - no authentication; `BASIC` - `username` and `password`; `TOKEN` - a bearer or API
|
|
21
|
+
* `token`; `CLUSTER_KEY` - the key shared between HA Perf Advisors. Each place that takes
|
|
22
|
+
* credentials documents which types it accepts.
|
|
23
|
+
*/
|
|
24
|
+
type: CredentialsType;
|
|
25
|
+
username?: string;
|
|
26
|
+
password?: string;
|
|
27
|
+
token?: string;
|
|
28
|
+
/** Whether a password is stored. */
|
|
29
|
+
readonly password_set?: boolean;
|
|
30
|
+
/** Whether a token is stored. */
|
|
31
|
+
readonly token_set?: boolean;
|
|
32
|
+
}
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Generated by orval 🍺
|
|
3
|
+
* Do not edit manually.
|
|
4
|
+
* Perf Advisor API
|
|
5
|
+
* Perf Advisor v2 REST API.
|
|
6
|
+
*
|
|
7
|
+
* Resources are returned as `{ spec, info }`: `spec` holds the properties a client sets,
|
|
8
|
+
* `info` holds read-only properties Perf Advisor computes.
|
|
9
|
+
*
|
|
10
|
+
* OpenAPI spec version: v2
|
|
11
|
+
*/
|
|
12
|
+
/**
|
|
13
|
+
* `NONE` - no authentication; `BASIC` - `username` and `password`; `TOKEN` - a bearer or API
|
|
14
|
+
* `token`; `CLUSTER_KEY` - the key shared between HA Perf Advisors. Each place that takes
|
|
15
|
+
* credentials documents which types it accepts.
|
|
16
|
+
*/
|
|
17
|
+
export type CredentialsType = typeof CredentialsType[keyof typeof CredentialsType];
|
|
18
|
+
export declare const CredentialsType: {
|
|
19
|
+
readonly NONE: "NONE";
|
|
20
|
+
readonly BASIC: "BASIC";
|
|
21
|
+
readonly TOKEN: "TOKEN";
|
|
22
|
+
readonly CLUSTER_KEY: "CLUSTER_KEY";
|
|
23
|
+
};
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Generated by orval 🍺
|
|
3
|
+
* Do not edit manually.
|
|
4
|
+
* Perf Advisor API
|
|
5
|
+
* Perf Advisor v2 REST API.
|
|
6
|
+
*
|
|
7
|
+
* Resources are returned as `{ spec, info }`: `spec` holds the properties a client sets,
|
|
8
|
+
* `info` holds read-only properties Perf Advisor computes.
|
|
9
|
+
*
|
|
10
|
+
* OpenAPI spec version: v2
|
|
11
|
+
*/
|
|
12
|
+
import type { CustomerInfo } from './customerInfo';
|
|
13
|
+
import type { CustomerSpec } from './customerSpec';
|
|
14
|
+
/**
|
|
15
|
+
* A YBA or YBM customer whose universes Perf Advisor monitors.
|
|
16
|
+
*/
|
|
17
|
+
export interface Customer {
|
|
18
|
+
spec: CustomerSpec;
|
|
19
|
+
info: CustomerInfo;
|
|
20
|
+
}
|