@homeflare/distilled-proxmox-backup 0.2.0

package/src/services/status.ts

@@ -0,0 +1,233 @@
+// AUTO-GENERATED by scripts/generate.ts from .generated-specs (apidoc.js, via scripts/apidoc.ts — see its header). Do not edit.
+import * as S from "@distilled.cloud/core/schema";
+import * as API from "@distilled.cloud/core/api";
+import * as T from "../traits.ts";
+import {
+  ProxmoxBackupProtocol,
+  type ProxmoxBackupOpError,
+  type ProxmoxBackupOpContext,
+} from "../protocol.ts";
+import * as Retry from "../retry.ts";
+
+export type { ProxmoxBackupOpError, ProxmoxBackupOpContext };
+
+export interface GetStatusRequest {}
+export const GetStatusRequest = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({}).pipe(T.Http({ method: "GET", uri: "/status", code: 200 })),
+).annotate({
+  identifier: "GetStatusRequest",
+}) as any as S.Schema<GetStatusRequest>;
+
+export interface GetStatusResponse {}
+export const GetStatusResponse = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({}),
+).annotate({
+  identifier: "GetStatusResponse",
+}) as any as S.Schema<GetStatusResponse>;
+
+export interface GetStatusMetricsRequest {
+  /** Include historic values (last 30 minutes) */
+  history?: string;
+  /** Only return values with a timestamp > start-time. Only has an effect if 'history' is also set */
+  start_time?: string;
+}
+export const GetStatusMetricsRequest = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    history: S.optional(S.String.pipe(T.Query())),
+    start_time: S.optional(S.String.pipe(T.Query("start-time"))),
+  }).pipe(T.Http({ method: "GET", uri: "/status/metrics", code: 200 })),
+).annotate({
+  identifier: "GetStatusMetricsRequest",
+}) as any as S.Schema<GetStatusMetricsRequest>;
+
+export interface GetStatusMetricsResponse {}
+export const GetStatusMetricsResponse = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({}),
+).annotate({
+  identifier: "GetStatusMetricsResponse",
+}) as any as S.Schema<GetStatusMetricsResponse>;
+
+export interface ListStatusDatastoreUsageRequest {}
+export const ListStatusDatastoreUsageRequest = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({}).pipe(
+    T.Http({ method: "GET", uri: "/status/datastore-usage", code: 200 }),
+  ),
+).annotate({
+  identifier: "ListStatusDatastoreUsageRequest",
+}) as any as S.Schema<ListStatusDatastoreUsageRequest>;
+
+export type ListStatusDatastoreUsageResponseBodyItemBackendType =
+  | "filesystem"
+  | "s3";
+export const ListStatusDatastoreUsageResponseBodyItemBackendType = S.String;
+
+export interface ListStatusDatastoreUsageResponseBodyItemGcStatusCacheStats {
+  hits: number;
+  misses: number;
+}
+export const ListStatusDatastoreUsageResponseBodyItemGcStatusCacheStats =
+  /*@__PURE__*/ S.suspend(() =>
+    S.Struct({
+      hits: S.Number,
+      misses: S.Number,
+    }),
+  ).annotate({
+    identifier: "ListStatusDatastoreUsageResponseBodyItemGcStatusCacheStats",
+  }) as any as S.Schema<ListStatusDatastoreUsageResponseBodyItemGcStatusCacheStats>;
+
+export interface ListStatusDatastoreUsageResponseBodyItemGcStatus {
+  cache_stats?: ListStatusDatastoreUsageResponseBodyItemGcStatusCacheStats;
+  disk_bytes?: number;
+  disk_chunks?: number;
+  index_data_bytes?: number;
+  index_file_count?: number;
+  pending_bytes?: number;
+  pending_chunks?: number;
+  removed_bad?: number;
+  removed_bytes?: number;
+  removed_chunks?: number;
+  still_bad?: number;
+  upid?: string;
+}
+export const ListStatusDatastoreUsageResponseBodyItemGcStatus =
+  /*@__PURE__*/ S.suspend(() =>
+    S.Struct({
+      cache_stats: S.optional(
+        ListStatusDatastoreUsageResponseBodyItemGcStatusCacheStats.pipe(
+          T.Body("cache-stats"),
+        ),
+      ),
+      disk_bytes: S.optional(S.Number.pipe(T.Body("disk-bytes"))),
+      disk_chunks: S.optional(S.Number.pipe(T.Body("disk-chunks"))),
+      index_data_bytes: S.optional(S.Number.pipe(T.Body("index-data-bytes"))),
+      index_file_count: S.optional(S.Number.pipe(T.Body("index-file-count"))),
+      pending_bytes: S.optional(S.Number.pipe(T.Body("pending-bytes"))),
+      pending_chunks: S.optional(S.Number.pipe(T.Body("pending-chunks"))),
+      removed_bad: S.optional(S.Number.pipe(T.Body("removed-bad"))),
+      removed_bytes: S.optional(S.Number.pipe(T.Body("removed-bytes"))),
+      removed_chunks: S.optional(S.Number.pipe(T.Body("removed-chunks"))),
+      still_bad: S.optional(S.Number.pipe(T.Body("still-bad"))),
+      upid: S.optional(S.String),
+    }),
+  ).annotate({
+    identifier: "ListStatusDatastoreUsageResponseBodyItemGcStatus",
+  }) as any as S.Schema<ListStatusDatastoreUsageResponseBodyItemGcStatus>;
+
+export type ListStatusDatastoreUsageResponseBodyItemHistoryList = Array<number>;
+export const ListStatusDatastoreUsageResponseBodyItemHistoryList =
+  /*@__PURE__*/ S.Array(
+    S.Number,
+  ) as any as S.Schema<ListStatusDatastoreUsageResponseBodyItemHistoryList>;
+
+export type ListStatusDatastoreUsageResponseBodyItemMountStatus =
+  | "mounted"
+  | "notmounted"
+  | "nonremovable";
+export const ListStatusDatastoreUsageResponseBodyItemMountStatus = S.String;
+
+export interface ListStatusDatastoreUsageResponseBodyItem {
+  avail?: number;
+  backend_type?: ListStatusDatastoreUsageResponseBodyItemBackendType;
+  error?: string;
+  estimated_full_date?: number;
+  gc_status?: ListStatusDatastoreUsageResponseBodyItemGcStatus;
+  history?: ListStatusDatastoreUsageResponseBodyItemHistoryList;
+  history_delta?: number;
+  history_start?: number;
+  mount_status?: ListStatusDatastoreUsageResponseBodyItemMountStatus;
+  store: string;
+  total?: number;
+  used?: number;
+}
+export const ListStatusDatastoreUsageResponseBodyItem = /*@__PURE__*/ S.suspend(
+  () =>
+    S.Struct({
+      avail: S.optional(S.Number),
+      backend_type: S.optional(
+        ListStatusDatastoreUsageResponseBodyItemBackendType.pipe(
+          T.Body("backend-type"),
+        ),
+      ),
+      error: S.optional(S.String),
+      estimated_full_date: S.optional(
+        S.Number.pipe(T.Body("estimated-full-date")),
+      ),
+      gc_status: S.optional(
+        ListStatusDatastoreUsageResponseBodyItemGcStatus.pipe(
+          T.Body("gc-status"),
+        ),
+      ),
+      history: S.optional(ListStatusDatastoreUsageResponseBodyItemHistoryList),
+      history_delta: S.optional(S.Number.pipe(T.Body("history-delta"))),
+      history_start: S.optional(S.Number.pipe(T.Body("history-start"))),
+      mount_status: S.optional(
+        ListStatusDatastoreUsageResponseBodyItemMountStatus.pipe(
+          T.Body("mount-status"),
+        ),
+      ),
+      store: S.String,
+      total: S.optional(S.Number),
+      used: S.optional(S.Number),
+    }),
+).annotate({
+  identifier: "ListStatusDatastoreUsageResponseBodyItem",
+}) as any as S.Schema<ListStatusDatastoreUsageResponseBodyItem>;
+
+export type ListStatusDatastoreUsageResponseBodyList =
+  Array<ListStatusDatastoreUsageResponseBodyItem>;
+export const ListStatusDatastoreUsageResponseBodyList = /*@__PURE__*/ S.Array(
+  ListStatusDatastoreUsageResponseBodyItem,
+) as any as S.Schema<ListStatusDatastoreUsageResponseBodyList>;
+
+export type ListStatusDatastoreUsageResponse =
+  ListStatusDatastoreUsageResponseBodyList;
+export const ListStatusDatastoreUsageResponse = /*@__PURE__*/ S.suspend(() =>
+  ListStatusDatastoreUsageResponseBodyList.pipe(T.RawResponseRoot()),
+).annotate({
+  identifier: "ListStatusDatastoreUsageResponse",
+}) as any as S.Schema<ListStatusDatastoreUsageResponse>;
+
+export type GetStatusError = ProxmoxBackupOpError;
+/** Directory index. */
+export const getStatus: API.OperationMethod<
+  GetStatusRequest,
+  GetStatusResponse,
+  GetStatusError,
+  ProxmoxBackupOpContext
+> = /*@__PURE__*/ API.make(() => ({
+  input: GetStatusRequest,
+  output: GetStatusResponse,
+  errors: [],
+  protocol: ProxmoxBackupProtocol,
+  retry: Retry.Retry,
+}));
+
+export type GetStatusMetricsError = ProxmoxBackupOpError;
+/** Return backup server metrics. */
+export const getStatusMetrics: API.OperationMethod<
+  GetStatusMetricsRequest,
+  GetStatusMetricsResponse,
+  GetStatusMetricsError,
+  ProxmoxBackupOpContext
+> = /*@__PURE__*/ API.make(() => ({
+  input: GetStatusMetricsRequest,
+  output: GetStatusMetricsResponse,
+  errors: [],
+  protocol: ProxmoxBackupProtocol,
+  retry: Retry.Retry,
+}));
+
+export type ListStatusDatastoreUsageError = ProxmoxBackupOpError;
+/** List Datastore usages and estimates */
+export const listStatusDatastoreUsage: API.OperationMethod<
+  ListStatusDatastoreUsageRequest,
+  ListStatusDatastoreUsageResponse,
+  ListStatusDatastoreUsageError,
+  ProxmoxBackupOpContext
+> = /*@__PURE__*/ API.make(() => ({
+  input: ListStatusDatastoreUsageRequest,
+  output: ListStatusDatastoreUsageResponse,
+  errors: [],
+  protocol: ProxmoxBackupProtocol,
+  retry: Retry.Retry,
+}));