cribl-control-plane 0.5.0-rc.2 → 0.5.0-rc.4

package/src/models/savedjobscheduledsearch.ts

@@ -0,0 +1,455 @@
+/*
+ * 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 SavedJobScheduledSearchJobType = {
+  Collection: "collection",
+  Executor: "executor",
+  ScheduledSearch: "scheduledSearch",
+} as const;
+export type SavedJobScheduledSearchJobType = OpenEnum<
+  typeof SavedJobScheduledSearchJobType
+>;
+
+export const SavedJobScheduledSearchType = {
+  Collection: "collection",
+} as const;
+export type SavedJobScheduledSearchType = OpenEnum<
+  typeof SavedJobScheduledSearchType
+>;
+
+/**
+ * Level at which to set task logging
+ */
+export const SavedJobScheduledSearchLogLevel = {
+  Error: "error",
+  Warn: "warn",
+  Info: "info",
+  Debug: "debug",
+  Silly: "silly",
+} as const;
+/**
+ * Level at which to set task logging
+ */
+export type SavedJobScheduledSearchLogLevel = OpenEnum<
+  typeof SavedJobScheduledSearchLogLevel
+>;
+
+export type SavedJobScheduledSearchTimeWarning = {};
+
+export type SavedJobScheduledSearchRunSettings = {
+  type?: SavedJobScheduledSearchType | undefined;
+  /**
+   * Reschedule tasks that failed with non-fatal errors
+   */
+  rescheduleDroppedTasks?: boolean | undefined;
+  /**
+   * Maximum number of times a task can be rescheduled
+   */
+  maxTaskReschedule?: number | undefined;
+  /**
+   * Level at which to set task logging
+   */
+  logLevel?: SavedJobScheduledSearchLogLevel | undefined;
+  /**
+   * Maximum time the job is allowed to run. Time unit defaults to seconds if not specified (examples: 30, 45s, 15m). Enter 0 for unlimited time.
+   */
+  jobTimeout?: string | undefined;
+  /**
+   * Job run mode. Preview will either return up to N matching results, or will run until capture time T is reached. Discovery will gather the list of files to turn into streaming tasks, without running the data collection job. Full Run will run the collection job.
+   */
+  mode?: string | undefined;
+  timeRangeType?: string | undefined;
+  /**
+   * Earliest time to collect data for the selected timezone
+   */
+  earliest?: number | undefined;
+  /**
+   * Latest time to collect data for the selected timezone
+   */
+  latest?: number | undefined;
+  timestampTimezone?: any | undefined;
+  timeWarning?: SavedJobScheduledSearchTimeWarning | undefined;
+  /**
+   * A filter for tokens in the provided collect path and/or the events being collected
+   */
+  expression?: string | undefined;
+  /**
+   * Limits the bundle size for small tasks. For example,
+   *
+   * @remarks
+   *
+   *         if your lower bundle size is 1MB, you can bundle up to five 200KB files into one task.
+   */
+  minTaskSize?: string | undefined;
+  /**
+   * Limits the bundle size for files above the lower task bundle size. For example, if your upper bundle size is 10MB,
+   *
+   * @remarks
+   *
+   *         you can bundle up to five 2MB files into one task. Files greater than this size will be assigned to individual tasks.
+   */
+  maxTaskSize?: string | undefined;
+};
+
+/**
+ * Configuration for a scheduled job
+ */
+export type SavedJobScheduledSearchSchedule = {
+  /**
+   * Enable to configure scheduling for this Collector
+   */
+  enabled?: boolean | undefined;
+  /**
+   * Skippable jobs can be delayed, up to their next run time, if the system is hitting concurrency limits
+   */
+  skippable?: boolean | undefined;
+  /**
+   * If Stream Leader (or single instance) restarts, run all missed jobs according to their original schedules
+   */
+  resumeMissed?: boolean | undefined;
+  /**
+   * A cron schedule on which to run this job
+   */
+  cronSchedule?: string | undefined;
+  /**
+   * The maximum number of instances of this scheduled job that may be running at any time
+   */
+  maxConcurrentRuns?: number | undefined;
+  run?: SavedJobScheduledSearchRunSettings | undefined;
+};
+
+export type SavedJobScheduledSearch = {
+  /**
+   * Unique ID for this Job
+   */
+  id?: string | undefined;
+  description?: string | undefined;
+  type: SavedJobScheduledSearchJobType;
+  /**
+   * Time to keep the job's artifacts on disk after job completion. This also affects how long a job is listed in the Job Inspector.
+   */
+  ttl?: string | undefined;
+  /**
+   * When enabled, this job's artifacts are not counted toward the Worker Group's finished job artifacts limit. Artifacts will be removed only after the Collector's configured time to live.
+   */
+  ignoreGroupJobsLimit?: boolean | undefined;
+  /**
+   * List of fields to remove from Discover results. Wildcards (for example, aws*) are allowed. This is useful when discovery returns sensitive fields that should not be exposed in the Jobs user interface.
+   */
+  removeFields?: Array<string> | undefined;
+  /**
+   * Resume the ad hoc job if a failure condition causes Stream to restart during job execution
+   */
+  resumeOnBoot?: boolean | undefined;
+  /**
+   * Optionally, enable this config only on a specified Git branch. If empty, will be enabled everywhere.
+   */
+  environment?: string | undefined;
+  /**
+   * Configuration for a scheduled job
+   */
+  schedule?: SavedJobScheduledSearchSchedule | undefined;
+  /**
+   * Tags for filtering and grouping in @{product}
+   */
+  streamtags?: Array<string> | undefined;
+  /**
+   * Identifies which search query to run
+   */
+  savedQueryId: string;
+};
+
+/** @internal */
+export const SavedJobScheduledSearchJobType$inboundSchema: z.ZodType<
+  SavedJobScheduledSearchJobType,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(SavedJobScheduledSearchJobType);
+/** @internal */
+export const SavedJobScheduledSearchJobType$outboundSchema: z.ZodType<
+  string,
+  z.ZodTypeDef,
+  SavedJobScheduledSearchJobType
+> = openEnums.outboundSchema(SavedJobScheduledSearchJobType);
+
+/** @internal */
+export const SavedJobScheduledSearchType$inboundSchema: z.ZodType<
+  SavedJobScheduledSearchType,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(SavedJobScheduledSearchType);
+/** @internal */
+export const SavedJobScheduledSearchType$outboundSchema: z.ZodType<
+  string,
+  z.ZodTypeDef,
+  SavedJobScheduledSearchType
+> = openEnums.outboundSchema(SavedJobScheduledSearchType);
+
+/** @internal */
+export const SavedJobScheduledSearchLogLevel$inboundSchema: z.ZodType<
+  SavedJobScheduledSearchLogLevel,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(SavedJobScheduledSearchLogLevel);
+/** @internal */
+export const SavedJobScheduledSearchLogLevel$outboundSchema: z.ZodType<
+  string,
+  z.ZodTypeDef,
+  SavedJobScheduledSearchLogLevel
+> = openEnums.outboundSchema(SavedJobScheduledSearchLogLevel);
+
+/** @internal */
+export const SavedJobScheduledSearchTimeWarning$inboundSchema: z.ZodType<
+  SavedJobScheduledSearchTimeWarning,
+  z.ZodTypeDef,
+  unknown
+> = z.object({});
+/** @internal */
+export type SavedJobScheduledSearchTimeWarning$Outbound = {};
+
+/** @internal */
+export const SavedJobScheduledSearchTimeWarning$outboundSchema: z.ZodType<
+  SavedJobScheduledSearchTimeWarning$Outbound,
+  z.ZodTypeDef,
+  SavedJobScheduledSearchTimeWarning
+> = z.object({});
+
+export function savedJobScheduledSearchTimeWarningToJSON(
+  savedJobScheduledSearchTimeWarning: SavedJobScheduledSearchTimeWarning,
+): string {
+  return JSON.stringify(
+    SavedJobScheduledSearchTimeWarning$outboundSchema.parse(
+      savedJobScheduledSearchTimeWarning,
+    ),
+  );
+}
+export function savedJobScheduledSearchTimeWarningFromJSON(
+  jsonString: string,
+): SafeParseResult<SavedJobScheduledSearchTimeWarning, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      SavedJobScheduledSearchTimeWarning$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SavedJobScheduledSearchTimeWarning' from JSON`,
+  );
+}
+
+/** @internal */
+export const SavedJobScheduledSearchRunSettings$inboundSchema: z.ZodType<
+  SavedJobScheduledSearchRunSettings,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  type: SavedJobScheduledSearchType$inboundSchema.optional(),
+  rescheduleDroppedTasks: z.boolean().default(true),
+  maxTaskReschedule: z.number().default(1),
+  logLevel: SavedJobScheduledSearchLogLevel$inboundSchema.default("info"),
+  jobTimeout: z.string().default("0"),
+  mode: z.string().default("list"),
+  timeRangeType: z.string().default("relative"),
+  earliest: z.number().optional(),
+  latest: z.number().optional(),
+  timestampTimezone: z.any().optional(),
+  timeWarning: z.lazy(() => SavedJobScheduledSearchTimeWarning$inboundSchema)
+    .optional(),
+  expression: z.string().default("true"),
+  minTaskSize: z.string().default("1MB"),
+  maxTaskSize: z.string().default("10MB"),
+});
+/** @internal */
+export type SavedJobScheduledSearchRunSettings$Outbound = {
+  type?: string | undefined;
+  rescheduleDroppedTasks: boolean;
+  maxTaskReschedule: number;
+  logLevel: string;
+  jobTimeout: string;
+  mode: string;
+  timeRangeType: string;
+  earliest?: number | undefined;
+  latest?: number | undefined;
+  timestampTimezone?: any | undefined;
+  timeWarning?: SavedJobScheduledSearchTimeWarning$Outbound | undefined;
+  expression: string;
+  minTaskSize: string;
+  maxTaskSize: string;
+};
+
+/** @internal */
+export const SavedJobScheduledSearchRunSettings$outboundSchema: z.ZodType<
+  SavedJobScheduledSearchRunSettings$Outbound,
+  z.ZodTypeDef,
+  SavedJobScheduledSearchRunSettings
+> = z.object({
+  type: SavedJobScheduledSearchType$outboundSchema.optional(),
+  rescheduleDroppedTasks: z.boolean().default(true),
+  maxTaskReschedule: z.number().default(1),
+  logLevel: SavedJobScheduledSearchLogLevel$outboundSchema.default("info"),
+  jobTimeout: z.string().default("0"),
+  mode: z.string().default("list"),
+  timeRangeType: z.string().default("relative"),
+  earliest: z.number().optional(),
+  latest: z.number().optional(),
+  timestampTimezone: z.any().optional(),
+  timeWarning: z.lazy(() => SavedJobScheduledSearchTimeWarning$outboundSchema)
+    .optional(),
+  expression: z.string().default("true"),
+  minTaskSize: z.string().default("1MB"),
+  maxTaskSize: z.string().default("10MB"),
+});
+
+export function savedJobScheduledSearchRunSettingsToJSON(
+  savedJobScheduledSearchRunSettings: SavedJobScheduledSearchRunSettings,
+): string {
+  return JSON.stringify(
+    SavedJobScheduledSearchRunSettings$outboundSchema.parse(
+      savedJobScheduledSearchRunSettings,
+    ),
+  );
+}
+export function savedJobScheduledSearchRunSettingsFromJSON(
+  jsonString: string,
+): SafeParseResult<SavedJobScheduledSearchRunSettings, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      SavedJobScheduledSearchRunSettings$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SavedJobScheduledSearchRunSettings' from JSON`,
+  );
+}
+
+/** @internal */
+export const SavedJobScheduledSearchSchedule$inboundSchema: z.ZodType<
+  SavedJobScheduledSearchSchedule,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  enabled: z.boolean().optional(),
+  skippable: z.boolean().default(true),
+  resumeMissed: z.boolean().default(false),
+  cronSchedule: z.string().default("*/5 * * * *"),
+  maxConcurrentRuns: z.number().default(1),
+  run: z.lazy(() => SavedJobScheduledSearchRunSettings$inboundSchema)
+    .optional(),
+});
+/** @internal */
+export type SavedJobScheduledSearchSchedule$Outbound = {
+  enabled?: boolean | undefined;
+  skippable: boolean;
+  resumeMissed: boolean;
+  cronSchedule: string;
+  maxConcurrentRuns: number;
+  run?: SavedJobScheduledSearchRunSettings$Outbound | undefined;
+};
+
+/** @internal */
+export const SavedJobScheduledSearchSchedule$outboundSchema: z.ZodType<
+  SavedJobScheduledSearchSchedule$Outbound,
+  z.ZodTypeDef,
+  SavedJobScheduledSearchSchedule
+> = z.object({
+  enabled: z.boolean().optional(),
+  skippable: z.boolean().default(true),
+  resumeMissed: z.boolean().default(false),
+  cronSchedule: z.string().default("*/5 * * * *"),
+  maxConcurrentRuns: z.number().default(1),
+  run: z.lazy(() => SavedJobScheduledSearchRunSettings$outboundSchema)
+    .optional(),
+});
+
+export function savedJobScheduledSearchScheduleToJSON(
+  savedJobScheduledSearchSchedule: SavedJobScheduledSearchSchedule,
+): string {
+  return JSON.stringify(
+    SavedJobScheduledSearchSchedule$outboundSchema.parse(
+      savedJobScheduledSearchSchedule,
+    ),
+  );
+}
+export function savedJobScheduledSearchScheduleFromJSON(
+  jsonString: string,
+): SafeParseResult<SavedJobScheduledSearchSchedule, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SavedJobScheduledSearchSchedule$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SavedJobScheduledSearchSchedule' from JSON`,
+  );
+}
+
+/** @internal */
+export const SavedJobScheduledSearch$inboundSchema: z.ZodType<
+  SavedJobScheduledSearch,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.string().optional(),
+  description: z.string().optional(),
+  type: SavedJobScheduledSearchJobType$inboundSchema,
+  ttl: z.string().default("4h"),
+  ignoreGroupJobsLimit: z.boolean().default(false),
+  removeFields: z.array(z.string()).optional(),
+  resumeOnBoot: z.boolean().default(false),
+  environment: z.string().optional(),
+  schedule: z.lazy(() => SavedJobScheduledSearchSchedule$inboundSchema)
+    .optional(),
+  streamtags: z.array(z.string()).optional(),
+  savedQueryId: z.string(),
+});
+/** @internal */
+export type SavedJobScheduledSearch$Outbound = {
+  id?: string | undefined;
+  description?: string | undefined;
+  type: string;
+  ttl: string;
+  ignoreGroupJobsLimit: boolean;
+  removeFields?: Array<string> | undefined;
+  resumeOnBoot: boolean;
+  environment?: string | undefined;
+  schedule?: SavedJobScheduledSearchSchedule$Outbound | undefined;
+  streamtags?: Array<string> | undefined;
+  savedQueryId: string;
+};
+
+/** @internal */
+export const SavedJobScheduledSearch$outboundSchema: z.ZodType<
+  SavedJobScheduledSearch$Outbound,
+  z.ZodTypeDef,
+  SavedJobScheduledSearch
+> = z.object({
+  id: z.string().optional(),
+  description: z.string().optional(),
+  type: SavedJobScheduledSearchJobType$outboundSchema,
+  ttl: z.string().default("4h"),
+  ignoreGroupJobsLimit: z.boolean().default(false),
+  removeFields: z.array(z.string()).optional(),
+  resumeOnBoot: z.boolean().default(false),
+  environment: z.string().optional(),
+  schedule: z.lazy(() => SavedJobScheduledSearchSchedule$outboundSchema)
+    .optional(),
+  streamtags: z.array(z.string()).optional(),
+  savedQueryId: z.string(),
+});
+
+export function savedJobScheduledSearchToJSON(
+  savedJobScheduledSearch: SavedJobScheduledSearch,
+): string {
+  return JSON.stringify(
+    SavedJobScheduledSearch$outboundSchema.parse(savedJobScheduledSearch),
+  );
+}
+export function savedJobScheduledSearchFromJSON(
+  jsonString: string,
+): SafeParseResult<SavedJobScheduledSearch, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SavedJobScheduledSearch$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SavedJobScheduledSearch' from JSON`,
+  );
+}

package/src/sdk/collectors.ts

@@ -0,0 +1,100 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { collectorsCreate } from "../funcs/collectorsCreate.js";
+import { collectorsDelete } from "../funcs/collectorsDelete.js";
+import { collectorsGet } from "../funcs/collectorsGet.js";
+import { collectorsList } from "../funcs/collectorsList.js";
+import { collectorsUpdate } from "../funcs/collectorsUpdate.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as models from "../models/index.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export class Collectors extends ClientSDK {
+  /**
+   * Create a Collector
+   *
+   * @remarks
+   * Create a new Collector.
+   */
+  async create(
+    request: operations.CreateSavedJobRequest,
+    options?: RequestOptions,
+  ): Promise<models.CountedSavedJob> {
+    return unwrapAsync(collectorsCreate(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * List all Collectors
+   *
+   * @remarks
+   * Get a list of all Collectors.
+   */
+  async list(
+    request?: operations.GetSavedJobRequest | undefined,
+    options?: RequestOptions,
+  ): Promise<models.CountedSavedJob> {
+    return unwrapAsync(collectorsList(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Delete a Collector
+   *
+   * @remarks
+   * Delete the specified Collector.
+   */
+  async delete(
+    request: operations.DeleteSavedJobByIdRequest,
+    options?: RequestOptions,
+  ): Promise<models.CountedSavedJob> {
+    return unwrapAsync(collectorsDelete(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Get a Collector
+   *
+   * @remarks
+   * Get the specified Collector.
+   */
+  async get(
+    request: operations.GetSavedJobByIdRequest,
+    options?: RequestOptions,
+  ): Promise<models.CountedSavedJob> {
+    return unwrapAsync(collectorsGet(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Update a Collector
+   *
+   * @remarks
+   * Update the specified Collector.<br><br>Provide a complete representation of the Collector that you want to update in the request body. This endpoint does not support partial updates. Cribl removes any omitted fields when updating the Collector.<br><br>Confirm that the configuration in your request body is correct before sending the request. If the configuration is incorrect, the updated Collector might not function as expected.
+   */
+  async update(
+    request: operations.UpdateSavedJobByIdRequest,
+    options?: RequestOptions,
+  ): Promise<models.CountedSavedJob> {
+    return unwrapAsync(collectorsUpdate(
+      this,
+      request,
+      options,
+    ));
+  }
+}

package/src/sdk/pipelines.ts

@@ -35,7 +35,7 @@ export class Pipelines extends ClientSDK {
    * Create a new Pipeline.
    */
   async create(
-    request: models.Pipeline,
+    request: models.PipelineInput,
     options?: RequestOptions,
   ): Promise<models.CountedPipeline> {
     return unwrapAsync(pipelinesCreate(

package/src/sdk/pq.ts

@@ -3,6 +3,7 @@
  */
 
 import { destinationsPqClear } from "../funcs/destinationsPqClear.js";
+import { destinationsPqGet } from "../funcs/destinationsPqGet.js";
 import { ClientSDK, RequestOptions } from "../lib/sdks.js";
 import * as models from "../models/index.js";
 import * as operations from "../models/operations/index.js";
@@ -25,4 +26,21 @@ export class Pq extends ClientSDK {
       options,
     ));
   }
+
+  /**
+   * Get information about the latest job to clear the persistent queue for a Destination
+   *
+   * @remarks
+   * Get information about the latest job to clear the persistent queue (PQ) for the specified Destination.
+   */
+  async get(
+    request: operations.GetOutputPqByIdRequest,
+    options?: RequestOptions,
+  ): Promise<models.CountedJobInfo> {
+    return unwrapAsync(destinationsPqGet(
+      this,
+      request,
+      options,
+    ));
+  }
 }

package/src/sdk/sdk.ts

@@ -4,6 +4,7 @@
 
 import { ClientSDK } from "../lib/sdks.js";
 import { Auth } from "./auth.js";
+import { Collectors } from "./collectors.js";
 import { Destinations } from "./destinations.js";
 import { Functions } from "./functions.js";
 import { Groups } from "./groups.js";
@@ -23,6 +24,11 @@ export class CriblControlPlane extends ClientSDK {
     return (this._lakeDatasets ??= new LakeDatasets(this._options));
   }
 
+  private _collectors?: Collectors;
+  get collectors(): Collectors {
+    return (this._collectors ??= new Collectors(this._options));
+  }
+
   private _sources?: Sources;
   get sources(): Sources {
     return (this._sources ??= new Sources(this._options));