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

package/src/models/savedjobcollection.ts

@@ -8,11 +8,11 @@ import * as openEnums from "../types/enums.js";
 import { OpenEnum } from "../types/enums.js";
 import { Result as SafeParseResult } from "../types/fp.js";
 import {
-  CollectorConf,
-  CollectorConf$inboundSchema,
-  CollectorConf$Outbound,
-  CollectorConf$outboundSchema,
-} from "./collectorconf.js";
+  Collector,
+  Collector$inboundSchema,
+  Collector$Outbound,
+  Collector$outboundSchema,
+} from "./collector.js";
 import { SDKValidationError } from "./errors/sdkvalidationerror.js";
 
 export const SavedJobCollectionJobType = {
@@ -132,25 +132,6 @@ export type SavedJobCollectionSchedule = {
   run?: SavedJobCollectionRunSettings | undefined;
 };
 
-export type SavedJobCollectionCollector = {
-  /**
-   * The type of collector to run
-   */
-  type: string;
-  /**
-   * Collector configuration
-   */
-  conf: CollectorConf;
-  /**
-   * Delete any files collected (where applicable)
-   */
-  destructive?: boolean | undefined;
-  /**
-   * Character encoding to use when parsing ingested data. When not set, @{product} will default to UTF-8 but may incorrectly interpret multi-byte characters.
-   */
-  encoding?: string | undefined;
-};
-
 export const SavedJobCollectionInputType = {
   Collection: "collection",
 } as const;
@@ -250,7 +231,10 @@ export type SavedJobCollection = {
    * If enabled, tasks are created and run by the same Worker Node
    */
   workerAffinity?: boolean | undefined;
-  collector: SavedJobCollectionCollector;
+  /**
+   * Collector configuration
+   */
+  collector: Collector;
   input?: SavedJobCollectionInput | undefined;
 };
 
@@ -464,56 +448,6 @@ export function savedJobCollectionScheduleFromJSON(
   );
 }
 
-/** @internal */
-export const SavedJobCollectionCollector$inboundSchema: z.ZodType<
-  SavedJobCollectionCollector,
-  z.ZodTypeDef,
-  unknown
-> = z.object({
-  type: z.string(),
-  conf: CollectorConf$inboundSchema,
-  destructive: z.boolean().default(false),
-  encoding: z.string().optional(),
-});
-/** @internal */
-export type SavedJobCollectionCollector$Outbound = {
-  type: string;
-  conf: CollectorConf$Outbound;
-  destructive: boolean;
-  encoding?: string | undefined;
-};
-
-/** @internal */
-export const SavedJobCollectionCollector$outboundSchema: z.ZodType<
-  SavedJobCollectionCollector$Outbound,
-  z.ZodTypeDef,
-  SavedJobCollectionCollector
-> = z.object({
-  type: z.string(),
-  conf: CollectorConf$outboundSchema,
-  destructive: z.boolean().default(false),
-  encoding: z.string().optional(),
-});
-
-export function savedJobCollectionCollectorToJSON(
-  savedJobCollectionCollector: SavedJobCollectionCollector,
-): string {
-  return JSON.stringify(
-    SavedJobCollectionCollector$outboundSchema.parse(
-      savedJobCollectionCollector,
-    ),
-  );
-}
-export function savedJobCollectionCollectorFromJSON(
-  jsonString: string,
-): SafeParseResult<SavedJobCollectionCollector, SDKValidationError> {
-  return safeParse(
-    jsonString,
-    (x) => SavedJobCollectionCollector$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'SavedJobCollectionCollector' from JSON`,
-  );
-}
-
 /** @internal */
 export const SavedJobCollectionInputType$inboundSchema: z.ZodType<
   SavedJobCollectionInputType,
@@ -702,7 +636,7 @@ export const SavedJobCollection$inboundSchema: z.ZodType<
   schedule: z.lazy(() => SavedJobCollectionSchedule$inboundSchema).optional(),
   streamtags: z.array(z.string()).optional(),
   workerAffinity: z.boolean().default(false),
-  collector: z.lazy(() => SavedJobCollectionCollector$inboundSchema),
+  collector: Collector$inboundSchema,
   input: z.lazy(() => SavedJobCollectionInput$inboundSchema).optional(),
 });
 /** @internal */
@@ -718,7 +652,7 @@ export type SavedJobCollection$Outbound = {
   schedule?: SavedJobCollectionSchedule$Outbound | undefined;
   streamtags?: Array<string> | undefined;
   workerAffinity: boolean;
-  collector: SavedJobCollectionCollector$Outbound;
+  collector: Collector$Outbound;
   input?: SavedJobCollectionInput$Outbound | undefined;
 };
 
@@ -739,7 +673,7 @@ export const SavedJobCollection$outboundSchema: z.ZodType<
   schedule: z.lazy(() => SavedJobCollectionSchedule$outboundSchema).optional(),
   streamtags: z.array(z.string()).optional(),
   workerAffinity: z.boolean().default(false),
-  collector: z.lazy(() => SavedJobCollectionCollector$outboundSchema),
+  collector: Collector$outboundSchema,
   input: z.lazy(() => SavedJobCollectionInput$outboundSchema).optional(),
 });
 

package/src/models/scriptcollectorconf.ts

@@ -0,0 +1,121 @@
+/*
+ * 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 EnvVar = {
+  /**
+   * Environment variable name
+   */
+  name: string;
+  /**
+   * JavaScript expression to compute environment variable's value, enclosed in quotes or backticks. (Can evaluate to a constant.)
+   */
+  value: string;
+};
+
+export type ScriptCollectorConf = {
+  /**
+   * Script to discover what to collect. Should output one task per line in stdout.
+   */
+  discoverScript: string;
+  /**
+   * Script to run to perform data collections. Task passed in as $CRIBL_COLLECT_ARG. Should output results to stdout.
+   */
+  collectScript: string;
+  /**
+   * Shell to use to execute scripts.
+   */
+  shell?: string | undefined;
+  /**
+   * Environment variables to expose to the discover and collect scripts.
+   */
+  envVars?: Array<EnvVar> | undefined;
+};
+
+/** @internal */
+export const EnvVar$inboundSchema: z.ZodType<EnvVar, z.ZodTypeDef, unknown> = z
+  .object({
+    name: z.string(),
+    value: z.string(),
+  });
+/** @internal */
+export type EnvVar$Outbound = {
+  name: string;
+  value: string;
+};
+
+/** @internal */
+export const EnvVar$outboundSchema: z.ZodType<
+  EnvVar$Outbound,
+  z.ZodTypeDef,
+  EnvVar
+> = z.object({
+  name: z.string(),
+  value: z.string(),
+});
+
+export function envVarToJSON(envVar: EnvVar): string {
+  return JSON.stringify(EnvVar$outboundSchema.parse(envVar));
+}
+export function envVarFromJSON(
+  jsonString: string,
+): SafeParseResult<EnvVar, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => EnvVar$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'EnvVar' from JSON`,
+  );
+}
+
+/** @internal */
+export const ScriptCollectorConf$inboundSchema: z.ZodType<
+  ScriptCollectorConf,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  discoverScript: z.string(),
+  collectScript: z.string(),
+  shell: z.string().default("/bin/bash"),
+  envVars: z.array(z.lazy(() => EnvVar$inboundSchema)).optional(),
+});
+/** @internal */
+export type ScriptCollectorConf$Outbound = {
+  discoverScript: string;
+  collectScript: string;
+  shell: string;
+  envVars?: Array<EnvVar$Outbound> | undefined;
+};
+
+/** @internal */
+export const ScriptCollectorConf$outboundSchema: z.ZodType<
+  ScriptCollectorConf$Outbound,
+  z.ZodTypeDef,
+  ScriptCollectorConf
+> = z.object({
+  discoverScript: z.string(),
+  collectScript: z.string(),
+  shell: z.string().default("/bin/bash"),
+  envVars: z.array(z.lazy(() => EnvVar$outboundSchema)).optional(),
+});
+
+export function scriptCollectorConfToJSON(
+  scriptCollectorConf: ScriptCollectorConf,
+): string {
+  return JSON.stringify(
+    ScriptCollectorConf$outboundSchema.parse(scriptCollectorConf),
+  );
+}
+export function scriptCollectorConfFromJSON(
+  jsonString: string,
+): SafeParseResult<ScriptCollectorConf, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ScriptCollectorConf$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ScriptCollectorConf' from JSON`,
+  );
+}