@yugabytedb/perf-advisor-client 0.0.0-stage → 0.0.1

package/dist/generated/model/universeInfo.d.ts

@@ -0,0 +1,38 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Perf Advisor API
+ * Perf Advisor v2 REST API.
+ *
+ * Resources are returned as `{ spec, info }`: `spec` holds the properties a client sets,
+ * `info` holds read-only properties Perf Advisor computes.
+ *
+ * OpenAPI spec version: v2
+ */
+import type { UniverseClusterInfo } from './universeClusterInfo';
+import type { UniverseCollectionInfo } from './universeCollectionInfo';
+import type { UniverseFeatures } from './universeFeatures';
+import type { UniverseState } from './universeState';
+import type { UniverseSyncInfo } from './universeSyncInfo';
+import type { YbaInfo } from './ybaInfo';
+import type { YbmClusterInfo } from './ybmClusterInfo';
+/**
+ * Properties of a universe that Perf Advisor knows. Until Perf Advisor first reads the universe's
+ * details from YBA or YBM, only `universe_uuid`, `yba`, `collection` and `sync` are set.
+ */
+export interface UniverseInfo {
+    readonly universe_uuid: string;
+    readonly name?: string;
+    /** YugabyteDB version the universe runs. During an upgrade, the version being upgraded from. */
+    readonly yb_software_version?: string;
+    readonly replication_factor?: number;
+    readonly clusters?: readonly UniverseClusterInfo[];
+    /** Whether the universe runs on Kubernetes. */
+    readonly kubernetes?: boolean;
+    state?: UniverseState;
+    yba?: YbaInfo;
+    ybm?: YbmClusterInfo;
+    features?: UniverseFeatures;
+    collection?: UniverseCollectionInfo;
+    sync?: UniverseSyncInfo;
+}

package/dist/generated/model/universeMetricsExportSpec.d.ts

@@ -0,0 +1,22 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Perf Advisor API
+ * Perf Advisor v2 REST API.
+ *
+ * Resources are returned as `{ spec, info }`: `spec` holds the properties a client sets,
+ * `info` holds read-only properties Perf Advisor computes.
+ *
+ * OpenAPI spec version: v2
+ */
+/**
+ * Where the universe's metrics are exported to, besides Perf Advisor's own store.
+ */
+export interface UniverseMetricsExportSpec {
+    /** Export configurations the universe's data is exported through. */
+    export_config_ids?: string[];
+    /** Whether universe metrics are exported through Prometheus remote write. */
+    prometheus_enabled?: boolean;
+    /** Whether universe metrics are exported to JSONL files. */
+    jsonl_enabled?: boolean;
+}

package/dist/generated/model/universeNode.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Perf Advisor API
+ * Perf Advisor v2 REST API.
+ *
+ * Resources are returned as `{ spec, info }`: `spec` holds the properties a client sets,
+ * `info` holds read-only properties Perf Advisor computes.
+ *
+ * OpenAPI spec version: v2
+ */
+import type { UniverseNodeInfo } from './universeNodeInfo';
+/**
+ * A node of a universe.
+ */
+export interface UniverseNode {
+    info: UniverseNodeInfo;
+}

package/dist/generated/model/universeNodeInfo.d.ts

@@ -0,0 +1,28 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Perf Advisor API
+ * Perf Advisor v2 REST API.
+ *
+ * Resources are returned as `{ spec, info }`: `spec` holds the properties a client sets,
+ * `info` holds read-only properties Perf Advisor computes.
+ *
+ * OpenAPI spec version: v2
+ */
+import type { ClusterRef } from './clusterRef';
+import type { KubernetesPod } from './kubernetesPod';
+import type { NodePlacement } from './nodePlacement';
+import type { ObjectLifecycle } from './objectLifecycle';
+import type { ServerType } from './serverType';
+export interface UniverseNodeInfo {
+    /** Node name. */
+    readonly name: string;
+    readonly private_ip?: string;
+    /** The YugabyteDB servers the node runs. */
+    readonly server_types?: readonly ServerType[];
+    cluster?: ClusterRef;
+    placement?: NodePlacement;
+    /** Set for nodes of a Kubernetes universe. */
+    kubernetes_pod?: KubernetesPod;
+    lifecycle?: ObjectLifecycle;
+}

package/dist/generated/model/universeNodePagedResp.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Perf Advisor API
+ * Perf Advisor v2 REST API.
+ *
+ * Resources are returned as `{ spec, info }`: `spec` holds the properties a client sets,
+ * `info` holds read-only properties Perf Advisor computes.
+ *
+ * OpenAPI spec version: v2
+ */
+import type { Pagination } from './pagination';
+import type { UniverseNode } from './universeNode';
+export type UniverseNodePagedResp = Pagination & {
+    entities: UniverseNode[];
+};

package/dist/generated/model/universePagedResp.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Perf Advisor API
+ * Perf Advisor v2 REST API.
+ *
+ * Resources are returned as `{ spec, info }`: `spec` holds the properties a client sets,
+ * `info` holds read-only properties Perf Advisor computes.
+ *
+ * OpenAPI spec version: v2
+ */
+import type { Pagination } from './pagination';
+import type { Universe } from './universe';
+export type UniversePagedResp = Pagination & {
+    entities: Universe[];
+};

package/dist/generated/model/universeSortBy.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Perf Advisor API
+ * Perf Advisor v2 REST API.
+ *
+ * Resources are returned as `{ spec, info }`: `spec` holds the properties a client sets,
+ * `info` holds read-only properties Perf Advisor computes.
+ *
+ * OpenAPI spec version: v2
+ */
+export type UniverseSortBy = typeof UniverseSortBy[keyof typeof UniverseSortBy];
+export declare const UniverseSortBy: {
+    readonly NAME: "NAME";
+    readonly UNIVERSE_UUID: "UNIVERSE_UUID";
+    readonly YBM_CLUSTER_NAME: "YBM_CLUSTER_NAME";
+    readonly YBM_ACCOUNT_ID: "YBM_ACCOUNT_ID";
+    readonly CUSTOMER_UUID: "CUSTOMER_UUID";
+    readonly PLATFORM_URL: "PLATFORM_URL";
+    readonly SYNC_ERROR: "SYNC_ERROR";
+};

package/dist/generated/model/universeSpec.d.ts

@@ -0,0 +1,30 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Perf Advisor API
+ * Perf Advisor v2 REST API.
+ *
+ * Resources are returned as `{ spec, info }`: `spec` holds the properties a client sets,
+ * `info` holds read-only properties Perf Advisor computes.
+ *
+ * OpenAPI spec version: v2
+ */
+import type { UniverseDatabaseSpec } from './universeDatabaseSpec';
+import type { UniverseMetricsExportSpec } from './universeMetricsExportSpec';
+import type { UniverseSpecCollectionMode } from './universeSpecCollectionMode';
+/**
+ * Properties of a universe registration that the caller sets. A `PUT` replaces the whole spec:
+ * an omitted property takes its default. An omitted `database.credentials` keeps the stored
+ * ones.
+ */
+export interface UniverseSpec {
+    /** Customer the universe belongs to. The customer must be registered first. */
+    customer_uuid: string;
+    /**
+       * How Perf Advisor gets the universe's data: `LOCAL` and `ONLINE` - this Perf Advisor collects it;
+       * `EXTERNAL` - another Perf Advisor collects it and pushes it here; `NONE` - nothing is collected.
+       */
+    collection_mode?: UniverseSpecCollectionMode;
+    database?: UniverseDatabaseSpec;
+    metrics_export?: UniverseMetricsExportSpec;
+}

package/dist/generated/model/universeSpecCollectionMode.d.ts

@@ -0,0 +1,22 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Perf Advisor API
+ * Perf Advisor v2 REST API.
+ *
+ * Resources are returned as `{ spec, info }`: `spec` holds the properties a client sets,
+ * `info` holds read-only properties Perf Advisor computes.
+ *
+ * OpenAPI spec version: v2
+ */
+/**
+ * How Perf Advisor gets the universe's data: `LOCAL` and `ONLINE` - this Perf Advisor collects it;
+ * `EXTERNAL` - another Perf Advisor collects it and pushes it here; `NONE` - nothing is collected.
+ */
+export type UniverseSpecCollectionMode = typeof UniverseSpecCollectionMode[keyof typeof UniverseSpecCollectionMode];
+export declare const UniverseSpecCollectionMode: {
+    readonly LOCAL: "LOCAL";
+    readonly ONLINE: "ONLINE";
+    readonly EXTERNAL: "EXTERNAL";
+    readonly NONE: "NONE";
+};

package/dist/generated/model/universeState.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Perf Advisor API
+ * Perf Advisor v2 REST API.
+ *
+ * Resources are returned as `{ spec, info }`: `spec` holds the properties a client sets,
+ * `info` holds read-only properties Perf Advisor computes.
+ *
+ * OpenAPI spec version: v2
+ */
+/**
+ * The universe's operational state, as YBA or YBM reports it.
+ */
+export interface UniverseState {
+    readonly paused?: boolean;
+    readonly update_in_progress?: boolean;
+}

package/dist/generated/model/universeSyncInfo.d.ts

@@ -0,0 +1,22 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Perf Advisor API
+ * Perf Advisor v2 REST API.
+ *
+ * Resources are returned as `{ spec, info }`: `spec` holds the properties a client sets,
+ * `info` holds read-only properties Perf Advisor computes.
+ *
+ * OpenAPI spec version: v2
+ */
+import type { SyncStatus } from './syncStatus';
+import type { UniverseSyncStatus } from './universeSyncStatus';
+/**
+ * How Perf Advisor's syncs of the universe's metadata are going.
+ */
+export interface UniverseSyncInfo {
+    /** The latest sync of the universe's details from YBA or YBM. */
+    details?: SyncStatus;
+    /** Each kind of metadata sync. */
+    readonly processes?: readonly UniverseSyncStatus[];
+}

package/dist/generated/model/universeSyncStatus.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Perf Advisor API
+ * Perf Advisor v2 REST API.
+ *
+ * Resources are returned as `{ spec, info }`: `spec` holds the properties a client sets,
+ * `info` holds read-only properties Perf Advisor computes.
+ *
+ * OpenAPI spec version: v2
+ */
+import type { SyncStatus } from './syncStatus';
+import type { UniverseSyncStatusProcess } from './universeSyncStatusProcess';
+/**
+ * One kind of metadata sync and its latest outcome.
+ */
+export interface UniverseSyncStatus {
+    /** Kind of metadata sync. */
+    readonly process: UniverseSyncStatusProcess;
+    status?: SyncStatus;
+}

package/dist/generated/model/universeSyncStatusProcess.d.ts

@@ -0,0 +1,28 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Perf Advisor API
+ * Perf Advisor v2 REST API.
+ *
+ * Resources are returned as `{ spec, info }`: `spec` holds the properties a client sets,
+ * `info` holds read-only properties Perf Advisor computes.
+ *
+ * OpenAPI spec version: v2
+ */
+/**
+ * Kind of metadata sync.
+ */
+export type UniverseSyncStatusProcess = typeof UniverseSyncStatusProcess[keyof typeof UniverseSyncStatusProcess];
+export declare const UniverseSyncStatusProcess: {
+    readonly UNIVERSE_METADATA: "UNIVERSE_METADATA";
+    readonly UNIVERSE_DETAILS: "UNIVERSE_DETAILS";
+    readonly PG_STAT_STATEMENTS: "PG_STAT_STATEMENTS";
+    readonly PG_METRICS: "PG_METRICS";
+    readonly PG_METADATA: "PG_METADATA";
+    readonly MASTER_CATALOG: "MASTER_CATALOG";
+    readonly CQL_METRICS: "CQL_METRICS";
+    readonly ACTIVE_SESSION_HISTORY: "ACTIVE_SESSION_HISTORY";
+    readonly TABLET_METADATA: "TABLET_METADATA";
+    readonly TABLET_METRICS: "TABLET_METRICS";
+    readonly QUERY_PLANS: "QUERY_PLANS";
+};

package/dist/generated/model/user.d.ts

@@ -0,0 +1,20 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Perf Advisor API
+ * Perf Advisor v2 REST API.
+ *
+ * Resources are returned as `{ spec, info }`: `spec` holds the properties a client sets,
+ * `info` holds read-only properties Perf Advisor computes.
+ *
+ * OpenAPI spec version: v2
+ */
+import type { UserInfo } from './userInfo';
+import type { UserSpec } from './userSpec';
+/**
+ * A local Perf Advisor user.
+ */
+export interface User {
+    spec: UserSpec;
+    info: UserInfo;
+}

package/dist/generated/model/userInfo.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Perf Advisor API
+ * Perf Advisor v2 REST API.
+ *
+ * Resources are returned as `{ spec, info }`: `spec` holds the properties a client sets,
+ * `info` holds read-only properties Perf Advisor computes.
+ *
+ * OpenAPI spec version: v2
+ */
+export interface UserInfo {
+    readonly user_uuid: string;
+}

package/dist/generated/model/userPagedResp.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Perf Advisor API
+ * Perf Advisor v2 REST API.
+ *
+ * Resources are returned as `{ spec, info }`: `spec` holds the properties a client sets,
+ * `info` holds read-only properties Perf Advisor computes.
+ *
+ * OpenAPI spec version: v2
+ */
+import type { Pagination } from './pagination';
+import type { User } from './user';
+export type UserPagedResp = Pagination & {
+    entities: User[];
+};

package/dist/generated/model/userSpec.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Perf Advisor API
+ * Perf Advisor v2 REST API.
+ *
+ * Resources are returned as `{ spec, info }`: `spec` holds the properties a client sets,
+ * `info` holds read-only properties Perf Advisor computes.
+ *
+ * OpenAPI spec version: v2
+ */
+export interface UserSpec {
+    name: string;
+    /** Required to create a user. Never returned; omitted on a `PUT`, keeps the stored one. */
+    password?: string;
+}

package/dist/generated/model/waitEvent.d.ts

@@ -0,0 +1,20 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Perf Advisor API
+ * Perf Advisor v2 REST API.
+ *
+ * Resources are returned as `{ spec, info }`: `spec` holds the properties a client sets,
+ * `info` holds read-only properties Perf Advisor computes.
+ *
+ * OpenAPI spec version: v2
+ */
+/**
+ * A wait event of active session history.
+ */
+export interface WaitEvent {
+    readonly component?: string;
+    readonly class?: string;
+    readonly type?: string;
+    readonly name?: string;
+}

package/dist/generated/model/waitEventFilter.d.ts

@@ -0,0 +1,20 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Perf Advisor API
+ * Perf Advisor v2 REST API.
+ *
+ * Resources are returned as `{ spec, info }`: `spec` holds the properties a client sets,
+ * `info` holds read-only properties Perf Advisor computes.
+ *
+ * OpenAPI spec version: v2
+ */
+/**
+ * Only activity in these wait event types or wait events. Rows without such activity are left out, and `eps`, its share and the wait event breakdown count only the matching active session history samples. The other figures, such as latency or rows, still cover all activity, so only `sort_by=EPS` ranks by the filtered load.
+ */
+export interface WaitEventFilter {
+    /** Only activity in these wait event types, such as `Cpu` or `DiskIO`. */
+    wait_event_types?: string[];
+    /** Only activity in these wait events. */
+    wait_events?: string[];
+}

package/dist/generated/model/waitEventGrouping.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Perf Advisor API
+ * Perf Advisor v2 REST API.
+ *
+ * Resources are returned as `{ spec, info }`: `spec` holds the properties a client sets,
+ * `info` holds read-only properties Perf Advisor computes.
+ *
+ * OpenAPI spec version: v2
+ */
+export type WaitEventGrouping = typeof WaitEventGrouping[keyof typeof WaitEventGrouping];
+export declare const WaitEventGrouping: {
+    readonly TYPE: "TYPE";
+    readonly EVENT: "EVENT";
+};

package/dist/generated/model/waitEventLoad.d.ts

@@ -0,0 +1,22 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Perf Advisor API
+ * Perf Advisor v2 REST API.
+ *
+ * Resources are returned as `{ spec, info }`: `spec` holds the properties a client sets,
+ * `info` holds read-only properties Perf Advisor computes.
+ *
+ * OpenAPI spec version: v2
+ */
+/**
+ * The share of a row's load spent in one wait event type, or one wait event.
+ */
+export interface WaitEventLoad {
+    /** Wait event type, such as `Cpu` or `DiskIO`. */
+    readonly type: string;
+    /** Wait event. Set when grouped by `EVENT`. */
+    readonly name?: string;
+    /** Active session history samples per second in this type or event. */
+    readonly eps?: number;
+}

package/dist/generated/model/ybaInfo.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Perf Advisor API
+ * Perf Advisor v2 REST API.
+ *
+ * Resources are returned as `{ spec, info }`: `spec` holds the properties a client sets,
+ * `info` holds read-only properties Perf Advisor computes.
+ *
+ * OpenAPI spec version: v2
+ */
+/**
+ * The YBA that manages the universe. Not set when no YBA does.
+ */
+export interface YbaInfo {
+    readonly url?: string;
+}

package/dist/generated/model/ybmClusterInfo.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Perf Advisor API
+ * Perf Advisor v2 REST API.
+ *
+ * Resources are returned as `{ spec, info }`: `spec` holds the properties a client sets,
+ * `info` holds read-only properties Perf Advisor computes.
+ *
+ * OpenAPI spec version: v2
+ */
+import type { YbmProject } from './ybmProject';
+/**
+ * The YBM cluster the universe is. Set for YBM universes only.
+ */
+export type YbmClusterInfo = YbmProject & {
+    readonly cluster_name?: string;
+};

package/dist/generated/model/ybmProject.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Perf Advisor API
+ * Perf Advisor v2 REST API.
+ *
+ * Resources are returned as `{ spec, info }`: `spec` holds the properties a client sets,
+ * `info` holds read-only properties Perf Advisor computes.
+ *
+ * OpenAPI spec version: v2
+ */
+/**
+ * A YBM project, by its account and project ids.
+ */
+export interface YbmProject {
+    account_id?: string;
+    project_id?: string;
+}