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

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

@@ -0,0 +1,24 @@
+/**
+ * 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 busy an entity was over the requested period.
+ */
+export interface LoadStats {
+    /** Average number of connections. Not set for statements. */
+    readonly connections?: number;
+    /** Calls per second. */
+    readonly rps?: number;
+    /** Active session history samples per second - on average, how many sessions were active (running or waiting) for this entity. */
+    readonly eps?: number;
+    /** Share of the active session history samples the request counts, from 0 to 1: those matching its filters (node, namespace, wait event, exclusions), or all of the universe's without any. */
+    readonly total_eps_ratio?: number;
+}

package/dist/generated/model/materializedView.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 { MaterializedViewInfo } from './materializedViewInfo';
+/**
+ * A YSQL materialized view.
+ */
+export interface MaterializedView {
+    info: MaterializedViewInfo;
+}

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

@@ -0,0 +1,26 @@
+/**
+ * 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
+ */
+/**
+ * Which materialized views to list.
+ */
+export interface MaterializedViewFilter {
+    /** Only views of this database, by exact name. */
+    namespace_name?: string;
+    /** Only views of this schema, by exact name. */
+    schema_name?: string;
+    /** Only the view with this exact name. */
+    materialized_view_name?: string;
+    /** Only views whose name contains this text, ignoring case. */
+    materialized_view_name_contains?: string;
+    /** Only views whose definition contains this text. */
+    definition?: string;
+}

package/dist/generated/model/materializedViewInfo.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 { ObjectLifecycle } from './objectLifecycle';
+import type { ObjectNamespace } from './objectNamespace';
+export interface MaterializedViewInfo {
+    namespace: ObjectNamespace;
+    readonly materialized_view_name: string;
+    /** Materialized view OID. */
+    readonly materialized_view_id?: number;
+    /** The view's query. */
+    readonly definition?: string;
+    lifecycle?: ObjectLifecycle;
+}

package/dist/generated/model/materializedViewPagedResp.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 { MaterializedView } from './materializedView';
+import type { Pagination } from './pagination';
+export type MaterializedViewPagedResp = Pagination & {
+    entities: MaterializedView[];
+};

package/dist/generated/model/materializedViewSortBy.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
+ */
+export type MaterializedViewSortBy = typeof MaterializedViewSortBy[keyof typeof MaterializedViewSortBy];
+export declare const MaterializedViewSortBy: {
+    readonly NAMESPACE_NAME: "NAMESPACE_NAME";
+    readonly SCHEMA_NAME: "SCHEMA_NAME";
+    readonly MATERIALIZED_VIEW_NAME: "MATERIALIZED_VIEW_NAME";
+    readonly FIRST_SEEN_TIME: "FIRST_SEEN_TIME";
+};

package/dist/generated/model/metadataRefresh.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 { MetadataRefreshResult } from './metadataRefreshResult';
+/**
+ * Outcome of a metadata refresh request, per target.
+ */
+export interface MetadataRefresh {
+    readonly universe_uuid: string;
+    readonly requested_at: string;
+    readonly results: readonly MetadataRefreshResult[];
+}

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

@@ -0,0 +1,24 @@
+/**
+ * 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 { MetadataRefreshResultStatus } from './metadataRefreshResultStatus';
+import type { MetadataRefreshTarget } from './metadataRefreshTarget';
+export interface MetadataRefreshResult {
+    target: MetadataRefreshTarget;
+    /**
+       * `SCHEDULED` - a refresh was started; `ALREADY_RUNNING` - one is in progress already;
+       * `SKIPPED` - the target can't be refreshed now; `FAILED` - starting it failed.
+       */
+    readonly status: MetadataRefreshResultStatus;
+    readonly message?: string;
+    readonly sync_time?: string;
+    readonly last_successful_sync_time?: string;
+}

package/dist/generated/model/metadataRefreshResultStatus.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
+ */
+/**
+ * `SCHEDULED` - a refresh was started; `ALREADY_RUNNING` - one is in progress already;
+ * `SKIPPED` - the target can't be refreshed now; `FAILED` - starting it failed.
+ */
+export type MetadataRefreshResultStatus = typeof MetadataRefreshResultStatus[keyof typeof MetadataRefreshResultStatus];
+export declare const MetadataRefreshResultStatus: {
+    readonly SCHEDULED: "SCHEDULED";
+    readonly ALREADY_RUNNING: "ALREADY_RUNNING";
+    readonly SKIPPED: "SKIPPED";
+    readonly FAILED: "FAILED";
+};

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

@@ -0,0 +1,19 @@
+/**
+ * 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 { MetadataRefreshTarget } from './metadataRefreshTarget';
+/**
+ * Metadata to refresh right away rather than on the next scheduled sync.
+ */
+export interface MetadataRefreshSpec {
+    /** @minItems 1 */
+    targets: MetadataRefreshTarget[];
+}

package/dist/generated/model/metadataRefreshTarget.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
+ */
+export type MetadataRefreshTarget = typeof MetadataRefreshTarget[keyof typeof MetadataRefreshTarget];
+export declare const MetadataRefreshTarget: {
+    readonly NAMESPACES: "NAMESPACES";
+    readonly TABLES: "TABLES";
+    readonly CQL_TABLES: "CQL_TABLES";
+    readonly TABLETS: "TABLETS";
+};

package/dist/generated/model/metricsExportEndpoint.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 { Endpoint } from './endpoint';
+import type { MetricsExportEndpointProtocol } from './metricsExportEndpointProtocol';
+/**
+ * Where universe metrics are exported. Its credentials are `NONE`, `BASIC`, or `CLUSTER_KEY`
+ * (between the Perf Advisors of an HA cluster, with the key in `token`).
+ */
+export type MetricsExportEndpoint = Endpoint & {
+    /** How metrics are sent to `url`. */
+    protocol?: MetricsExportEndpointProtocol;
+};

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

@@ -0,0 +1,19 @@
+/**
+ * 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 metrics are sent to `url`.
+ */
+export type MetricsExportEndpointProtocol = typeof MetricsExportEndpointProtocol[keyof typeof MetricsExportEndpointProtocol];
+export declare const MetricsExportEndpointProtocol: {
+    readonly OTLPHTTP: "OTLPHTTP";
+    readonly REMOTEWRITE: "REMOTEWRITE";
+};

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

@@ -0,0 +1,27 @@
+/**
+ * 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 { ServerType } from './serverType';
+/**
+ * Which nodes' data to include. Each list narrows the data to the nodes matching all of them.
+ */
+export interface NodeFilter {
+    /** Only data of nodes in these clusters. */
+    cluster_uuids?: string[];
+    /** Only data of nodes in these regions. */
+    region_codes?: string[];
+    /** Only data of nodes in these availability zones. */
+    zone_codes?: string[];
+    /** Only data of these nodes. */
+    node_names?: string[];
+    /** Only data of these YugabyteDB server types. */
+    server_types?: ServerType[];
+}

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

@@ -0,0 +1,19 @@
+/**
+ * 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 a node runs.
+ */
+export interface NodePlacement {
+    readonly cloud?: string;
+    readonly region?: string;
+    readonly availability_zone?: string;
+}

package/dist/generated/model/nodeStats.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 { NodeStatsInfo } from './nodeStatsInfo';
+/**
+ * Statistics of one universe node over the requested time range.
+ */
+export interface NodeStats {
+    info: NodeStatsInfo;
+}

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

@@ -0,0 +1,23 @@
+/**
+ * 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 { LoadStats } from './loadStats';
+import type { NodePlacement } from './nodePlacement';
+import type { WaitEventLoad } from './waitEventLoad';
+export interface NodeStatsInfo {
+    /** Node name. */
+    readonly name: string;
+    readonly private_ip?: string;
+    placement?: NodePlacement;
+    load?: LoadStats;
+    /** The load broken down by wait event type or wait event. Set when `group_events_by` is. */
+    readonly wait_events?: readonly WaitEventLoad[];
+}

package/dist/generated/model/nodeStatsPagedResp.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 { NodeStats } from './nodeStats';
+import type { Pagination } from './pagination';
+export type NodeStatsPagedResp = Pagination & {
+    entities: NodeStats[];
+};

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

@@ -0,0 +1,19 @@
+/**
+ * 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 NodeStatsSortBy = typeof NodeStatsSortBy[keyof typeof NodeStatsSortBy];
+export declare const NodeStatsSortBy: {
+    readonly NAME: "NAME";
+    readonly CONNECTIONS: "CONNECTIONS";
+    readonly EPS: "EPS";
+    readonly RPS: "RPS";
+    readonly TOTAL_EPS_RATIO: "TOTAL_EPS_RATIO";
+};

package/dist/generated/model/notFoundResponse.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 { Error } from './error';
+/**
+ * The resource does not exist.
+ */
+export type NotFoundResponse = Error;

package/dist/generated/model/objectLifecycle.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
+ */
+/**
+ * When Perf Advisor first saw a database object, last read its metadata, and saw it dropped.
+ */
+export interface ObjectLifecycle {
+    /** When Perf Advisor first saw the object. */
+    readonly first_seen_time?: string;
+    /** When Perf Advisor last read the object's metadata. */
+    readonly updated_time?: string;
+    /** When the object was dropped. Not set for existing objects. */
+    readonly deleted_time?: string;
+}

package/dist/generated/model/objectNamespace.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
+ */
+/**
+ * The database or YCQL keyspace, and the YSQL schema, an object is in.
+ */
+export interface ObjectNamespace {
+    /** Database or keyspace name. */
+    readonly namespace_name: string;
+    /** YSQL schema name. Not set for YCQL objects. */
+    readonly schema_name?: string;
+}

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

@@ -0,0 +1,19 @@
+/**
+ * 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 database object, such as a database or a user, by OID and name.
+ */
+export interface ObjectRef {
+    /** OID. */
+    readonly id?: number;
+    readonly name?: string;
+}

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

@@ -0,0 +1,31 @@
+/**
+ * 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 { SortDirection } from './sortDirection';
+/**
+ * Which page of a list to return. Each list documents the order it sorts by and its default direction.
+ */
+export interface PageRequest {
+    /**
+       * Number of entities to skip.
+       * @minimum 0
+       */
+    offset?: number;
+    /**
+       * Maximum number of entities to return.
+       * @minimum 1
+       * @maximum 500
+       */
+    limit?: number;
+    direction?: SortDirection;
+    /** Whether to return `total_count`, which costs an extra count query. */
+    need_total_count?: boolean;
+}

package/dist/generated/model/pagination.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
+ */
+/**
+ * Paging information returned with every paged list.
+ */
+export interface Pagination {
+    /** Whether a page follows this one. */
+    has_next: boolean;
+    /** Whether a page precedes this one. */
+    has_prev: boolean;
+    /** Total number of entities. Returned only when `need_total_count` is set. */
+    total_count?: number;
+}

package/dist/generated/model/perfAdvisor.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 { PerfAdvisorInfo } from './perfAdvisorInfo';
+/**
+ * This Perf Advisor instance.
+ */
+export interface PerfAdvisor {
+    info: PerfAdvisorInfo;
+}

package/dist/generated/model/perfAdvisorInfo.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 interface PerfAdvisorInfo {
+    /** Perf Advisor version, for example `1.7.0-b5`. */
+    readonly version: string;
+    /** Whether this Perf Advisor serves YugabyteDB Aeon (YBM) rather than YugabyteDB Anywhere. */
+    readonly cloud_enabled: boolean;
+    /** Whether this Perf Advisor supports high availability, which YBM deployments don't. */
+    readonly ha_enabled: boolean;
+    /** Whether users sign in to this Perf Advisor through Teleport. */
+    readonly teleport_auth_enabled: boolean;
+}

package/dist/generated/model/query.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 { QueryInfo } from './queryInfo';
+/**
+ * A YSQL or YCQL statement, by its text and identity.
+ */
+export interface Query {
+    info: QueryInfo;
+}

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

@@ -0,0 +1,29 @@
+/**
+ * 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 { QueryType } from './queryType';
+/**
+ * Which statements to list.
+ */
+export interface QueryFilter {
+    /** Only statements of these types, `SQL` or `CQL`. Both by default. */
+    types?: QueryType[];
+    /** Only statements of this database or keyspace, by exact name. */
+    database_name?: string;
+    /** Only statements of this user, by exact name. YCQL statements have no user, so it leaves them out. */
+    user_name?: string;
+    /** Only statements whose text contains this text, ignoring case. */
+    query?: string;
+    /** Leave out the YSQL statements Perf Advisor's own database user runs. */
+    exclude_tp_user?: boolean;
+    /** Leave out the YSQL statements of system databases. */
+    exclude_system_dbs?: boolean;
+}