cribl-control-plane 0.5.0-beta.13 → 0.5.0-beta.14

package/src/models/cribllakecollectorconf.ts

@@ -0,0 +1,54 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../lib/schemas.js";
+import { Result as SafeParseResult } from "../types/fp.js";
+import { SDKValidationError } from "./errors/sdkvalidationerror.js";
+
+export type CriblLakeCollectorConf = {
+  /**
+   * Lake dataset to collect data from.
+   */
+  dataset: string;
+};
+
+/** @internal */
+export const CriblLakeCollectorConf$inboundSchema: z.ZodType<
+  CriblLakeCollectorConf,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  dataset: z.string(),
+});
+/** @internal */
+export type CriblLakeCollectorConf$Outbound = {
+  dataset: string;
+};
+
+/** @internal */
+export const CriblLakeCollectorConf$outboundSchema: z.ZodType<
+  CriblLakeCollectorConf$Outbound,
+  z.ZodTypeDef,
+  CriblLakeCollectorConf
+> = z.object({
+  dataset: z.string(),
+});
+
+export function criblLakeCollectorConfToJSON(
+  criblLakeCollectorConf: CriblLakeCollectorConf,
+): string {
+  return JSON.stringify(
+    CriblLakeCollectorConf$outboundSchema.parse(criblLakeCollectorConf),
+  );
+}
+export function criblLakeCollectorConfFromJSON(
+  jsonString: string,
+): SafeParseResult<CriblLakeCollectorConf, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CriblLakeCollectorConf$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CriblLakeCollectorConf' from JSON`,
+  );
+}

package/src/models/databasecollectorconf.ts

@@ -0,0 +1,194 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../lib/schemas.js";
+import * as openEnums from "../types/enums.js";
+import { OpenEnum } from "../types/enums.js";
+import { Result as SafeParseResult } from "../types/fp.js";
+import { SDKValidationError } from "./errors/sdkvalidationerror.js";
+
+export const DatabaseCollectorConfHiddenDefaultBreakers = {
+  Cribl: "Cribl",
+} as const;
+export type DatabaseCollectorConfHiddenDefaultBreakers = OpenEnum<
+  typeof DatabaseCollectorConfHiddenDefaultBreakers
+>;
+
+export type DatabaseCollectorConfStateTracking = {
+  /**
+   * Enable tracking of collection progress between consecutive scheduled executions.
+   */
+  enabled?: boolean | undefined;
+};
+
+export type DatabaseCollectorConfScheduling = {
+  stateTracking?: DatabaseCollectorConfStateTracking | undefined;
+};
+
+export type DatabaseCollectorConf = {
+  /**
+   * Select an existing Connection, or go to Knowledge > Database Connections to add one
+   */
+  connectionId: string;
+  /**
+   * An expression that resolves to the query string for selecting data from the database. Has access to the special ${earliest} and ${latest} variables, which will resolve to the Collector run's start and end time.
+   */
+  query: string;
+  /**
+   * Enforces a basic query validation that allows only a single 'select' statement. Disable for more complex queries or when using semicolons. Caution: Disabling query validation allows DDL and DML statements to be executed, which could be destructive to your database.
+   */
+  queryValidationEnabled?: boolean | undefined;
+  defaultBreakers?: DatabaseCollectorConfHiddenDefaultBreakers | undefined;
+  __scheduling?: DatabaseCollectorConfScheduling | undefined;
+};
+
+/** @internal */
+export const DatabaseCollectorConfHiddenDefaultBreakers$inboundSchema:
+  z.ZodType<DatabaseCollectorConfHiddenDefaultBreakers, z.ZodTypeDef, unknown> =
+    openEnums.inboundSchema(DatabaseCollectorConfHiddenDefaultBreakers);
+/** @internal */
+export const DatabaseCollectorConfHiddenDefaultBreakers$outboundSchema:
+  z.ZodType<string, z.ZodTypeDef, DatabaseCollectorConfHiddenDefaultBreakers> =
+    openEnums.outboundSchema(DatabaseCollectorConfHiddenDefaultBreakers);
+
+/** @internal */
+export const DatabaseCollectorConfStateTracking$inboundSchema: z.ZodType<
+  DatabaseCollectorConfStateTracking,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  enabled: z.boolean().optional(),
+});
+/** @internal */
+export type DatabaseCollectorConfStateTracking$Outbound = {
+  enabled?: boolean | undefined;
+};
+
+/** @internal */
+export const DatabaseCollectorConfStateTracking$outboundSchema: z.ZodType<
+  DatabaseCollectorConfStateTracking$Outbound,
+  z.ZodTypeDef,
+  DatabaseCollectorConfStateTracking
+> = z.object({
+  enabled: z.boolean().optional(),
+});
+
+export function databaseCollectorConfStateTrackingToJSON(
+  databaseCollectorConfStateTracking: DatabaseCollectorConfStateTracking,
+): string {
+  return JSON.stringify(
+    DatabaseCollectorConfStateTracking$outboundSchema.parse(
+      databaseCollectorConfStateTracking,
+    ),
+  );
+}
+export function databaseCollectorConfStateTrackingFromJSON(
+  jsonString: string,
+): SafeParseResult<DatabaseCollectorConfStateTracking, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      DatabaseCollectorConfStateTracking$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'DatabaseCollectorConfStateTracking' from JSON`,
+  );
+}
+
+/** @internal */
+export const DatabaseCollectorConfScheduling$inboundSchema: z.ZodType<
+  DatabaseCollectorConfScheduling,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  stateTracking: z.lazy(() => DatabaseCollectorConfStateTracking$inboundSchema)
+    .optional(),
+});
+/** @internal */
+export type DatabaseCollectorConfScheduling$Outbound = {
+  stateTracking?: DatabaseCollectorConfStateTracking$Outbound | undefined;
+};
+
+/** @internal */
+export const DatabaseCollectorConfScheduling$outboundSchema: z.ZodType<
+  DatabaseCollectorConfScheduling$Outbound,
+  z.ZodTypeDef,
+  DatabaseCollectorConfScheduling
+> = z.object({
+  stateTracking: z.lazy(() => DatabaseCollectorConfStateTracking$outboundSchema)
+    .optional(),
+});
+
+export function databaseCollectorConfSchedulingToJSON(
+  databaseCollectorConfScheduling: DatabaseCollectorConfScheduling,
+): string {
+  return JSON.stringify(
+    DatabaseCollectorConfScheduling$outboundSchema.parse(
+      databaseCollectorConfScheduling,
+    ),
+  );
+}
+export function databaseCollectorConfSchedulingFromJSON(
+  jsonString: string,
+): SafeParseResult<DatabaseCollectorConfScheduling, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => DatabaseCollectorConfScheduling$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'DatabaseCollectorConfScheduling' from JSON`,
+  );
+}
+
+/** @internal */
+export const DatabaseCollectorConf$inboundSchema: z.ZodType<
+  DatabaseCollectorConf,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  connectionId: z.string(),
+  query: z.string(),
+  queryValidationEnabled: z.boolean().default(true),
+  defaultBreakers: DatabaseCollectorConfHiddenDefaultBreakers$inboundSchema
+    .optional(),
+  __scheduling: z.lazy(() => DatabaseCollectorConfScheduling$inboundSchema)
+    .optional(),
+});
+/** @internal */
+export type DatabaseCollectorConf$Outbound = {
+  connectionId: string;
+  query: string;
+  queryValidationEnabled: boolean;
+  defaultBreakers?: string | undefined;
+  __scheduling?: DatabaseCollectorConfScheduling$Outbound | undefined;
+};
+
+/** @internal */
+export const DatabaseCollectorConf$outboundSchema: z.ZodType<
+  DatabaseCollectorConf$Outbound,
+  z.ZodTypeDef,
+  DatabaseCollectorConf
+> = z.object({
+  connectionId: z.string(),
+  query: z.string(),
+  queryValidationEnabled: z.boolean().default(true),
+  defaultBreakers: DatabaseCollectorConfHiddenDefaultBreakers$outboundSchema
+    .optional(),
+  __scheduling: z.lazy(() => DatabaseCollectorConfScheduling$outboundSchema)
+    .optional(),
+});
+
+export function databaseCollectorConfToJSON(
+  databaseCollectorConf: DatabaseCollectorConf,
+): string {
+  return JSON.stringify(
+    DatabaseCollectorConf$outboundSchema.parse(databaseCollectorConf),
+  );
+}
+export function databaseCollectorConfFromJSON(
+  jsonString: string,
+): SafeParseResult<DatabaseCollectorConf, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => DatabaseCollectorConf$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'DatabaseCollectorConf' from JSON`,
+  );
+}

package/src/models/filesystemcollectorconf.ts

@@ -0,0 +1,141 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../lib/schemas.js";
+import { Result as SafeParseResult } from "../types/fp.js";
+import { SDKValidationError } from "./errors/sdkvalidationerror.js";
+
+export type FilesystemCollectorConfExtractor = {
+  /**
+   * A token from the template directory, such as epoch
+   */
+  key: string;
+  /**
+   * JavaScript expression that receives token under "value" variable, and evaluates to populate event fields, such as {date: new Date(+value*1000)}
+   */
+  expression: string;
+};
+
+export type FilesystemCollectorConf = {
+  /**
+   * Select a predefined configuration (a Destination) to auto-populate Collector settings
+   */
+  outputName?: string | undefined;
+  /**
+   * The directory from which to collect data. Templating is supported, such as /myDir/${datacenter}/${host}/${app}/. Time-based tokens are also supported, such as /myOtherDir/${_time:%Y}/${_time:%m}/${_time:%d}/.
+   */
+  path: string;
+  /**
+   * Allows using template tokens as context for expressions that enrich discovery results. For example, given a template /path/${epoch}, an extractor under key "epoch" with an expression {date: new Date(+value*1000)}, will enrich discovery results with a human readable "date" field.
+   */
+  extractors?: Array<FilesystemCollectorConfExtractor> | undefined;
+  /**
+   * Recurse through subdirectories
+   */
+  recurse?: boolean | undefined;
+  /**
+   * Maximum number of metadata files to batch before recording as results
+   */
+  maxBatchSize?: number | undefined;
+};
+
+/** @internal */
+export const FilesystemCollectorConfExtractor$inboundSchema: z.ZodType<
+  FilesystemCollectorConfExtractor,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  key: z.string(),
+  expression: z.string(),
+});
+/** @internal */
+export type FilesystemCollectorConfExtractor$Outbound = {
+  key: string;
+  expression: string;
+};
+
+/** @internal */
+export const FilesystemCollectorConfExtractor$outboundSchema: z.ZodType<
+  FilesystemCollectorConfExtractor$Outbound,
+  z.ZodTypeDef,
+  FilesystemCollectorConfExtractor
+> = z.object({
+  key: z.string(),
+  expression: z.string(),
+});
+
+export function filesystemCollectorConfExtractorToJSON(
+  filesystemCollectorConfExtractor: FilesystemCollectorConfExtractor,
+): string {
+  return JSON.stringify(
+    FilesystemCollectorConfExtractor$outboundSchema.parse(
+      filesystemCollectorConfExtractor,
+    ),
+  );
+}
+export function filesystemCollectorConfExtractorFromJSON(
+  jsonString: string,
+): SafeParseResult<FilesystemCollectorConfExtractor, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => FilesystemCollectorConfExtractor$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'FilesystemCollectorConfExtractor' from JSON`,
+  );
+}
+
+/** @internal */
+export const FilesystemCollectorConf$inboundSchema: z.ZodType<
+  FilesystemCollectorConf,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  outputName: z.string().optional(),
+  path: z.string(),
+  extractors: z.array(
+    z.lazy(() => FilesystemCollectorConfExtractor$inboundSchema),
+  ).optional(),
+  recurse: z.boolean().default(true),
+  maxBatchSize: z.number().default(10),
+});
+/** @internal */
+export type FilesystemCollectorConf$Outbound = {
+  outputName?: string | undefined;
+  path: string;
+  extractors?: Array<FilesystemCollectorConfExtractor$Outbound> | undefined;
+  recurse: boolean;
+  maxBatchSize: number;
+};
+
+/** @internal */
+export const FilesystemCollectorConf$outboundSchema: z.ZodType<
+  FilesystemCollectorConf$Outbound,
+  z.ZodTypeDef,
+  FilesystemCollectorConf
+> = z.object({
+  outputName: z.string().optional(),
+  path: z.string(),
+  extractors: z.array(
+    z.lazy(() => FilesystemCollectorConfExtractor$outboundSchema),
+  ).optional(),
+  recurse: z.boolean().default(true),
+  maxBatchSize: z.number().default(10),
+});
+
+export function filesystemCollectorConfToJSON(
+  filesystemCollectorConf: FilesystemCollectorConf,
+): string {
+  return JSON.stringify(
+    FilesystemCollectorConf$outboundSchema.parse(filesystemCollectorConf),
+  );
+}
+export function filesystemCollectorConfFromJSON(
+  jsonString: string,
+): SafeParseResult<FilesystemCollectorConf, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => FilesystemCollectorConf$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'FilesystemCollectorConf' from JSON`,
+  );
+}