cribl-control-plane 0.5.0-rc.6 → 0.5.0-rc.8

package/src/models/azureblobcollectorconf.ts

@@ -0,0 +1,214 @@
+/*
+ * 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";
+
+/**
+ * Enter authentication data directly, or select a secret referencing your auth data
+ */
+export const AzureBlobCollectorConfAuthenticationMethod = {
+  Manual: "manual",
+  Secret: "secret",
+  ClientSecret: "clientSecret",
+  ClientCert: "clientCert",
+} as const;
+/**
+ * Enter authentication data directly, or select a secret referencing your auth data
+ */
+export type AzureBlobCollectorConfAuthenticationMethod = OpenEnum<
+  typeof AzureBlobCollectorConfAuthenticationMethod
+>;
+
+export type AzureBlobCollectorConfExtractor = {
+  /**
+   * A token from the template path, such as epoch
+   */
+  key: string;
+  /**
+   * A JavaScript expression that accesses a corresponding <token> through the value variable and evaluates the token to populate event fields. Example: {date: new Date(+value*1000)}
+   */
+  expression: string;
+};
+
+export type AzureBlobCollectorConf = {
+  /**
+   * An optional predefined Destination that will be used to auto-populate Collector settings
+   */
+  outputName?: string | undefined;
+  /**
+   * Enter authentication data directly, or select a secret referencing your auth data
+   */
+  authType?: AzureBlobCollectorConfAuthenticationMethod | undefined;
+  /**
+   * Container to collect from. This value can be a constant, or a JavaScript expression that can only be evaluated at init time. Example referencing a Global Variable: myBucket-${C.vars.myVar}
+   */
+  containerName: string;
+  /**
+   * The directory from which to collect data. Templating is supported, such as myDir/${datacenter}/${host}/${app}/. Time-based tokens are supported, such as myOtherDir/${_time:%Y}/${_time:%m}/${_time:%d}/.
+   */
+  path?: string | undefined;
+  /**
+   * Extractors allow use of 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<AzureBlobCollectorConfExtractor> | undefined;
+  /**
+   * Recurse through subdirectories
+   */
+  recurse?: boolean | undefined;
+  /**
+   * Include Azure Blob metadata in collected events. In each event, metadata will be located at: __collectible.metadata.
+   */
+  includeMetadata?: boolean | undefined;
+  /**
+   * Include Azure Blob tags in collected events. In each event, tags will be located at: __collectible.tags. Disable this feature when using a Shared Access Signature Connection String, to prevent errors.
+   */
+  includeTags?: boolean | undefined;
+  /**
+   * Maximum number of metadata objects to batch before recording as results
+   */
+  maxBatchSize?: number | undefined;
+  /**
+   * Maximum file size for each Parquet chunk
+   */
+  parquetChunkSizeMB?: number | undefined;
+  /**
+   * The maximum time allowed for downloading a Parquet chunk. Processing will abort if a chunk cannot be downloaded within the time specified.
+   */
+  parquetChunkDownloadTimeout?: number | undefined;
+};
+
+/** @internal */
+export const AzureBlobCollectorConfAuthenticationMethod$inboundSchema:
+  z.ZodType<AzureBlobCollectorConfAuthenticationMethod, z.ZodTypeDef, unknown> =
+    openEnums.inboundSchema(AzureBlobCollectorConfAuthenticationMethod);
+/** @internal */
+export const AzureBlobCollectorConfAuthenticationMethod$outboundSchema:
+  z.ZodType<string, z.ZodTypeDef, AzureBlobCollectorConfAuthenticationMethod> =
+    openEnums.outboundSchema(AzureBlobCollectorConfAuthenticationMethod);
+
+/** @internal */
+export const AzureBlobCollectorConfExtractor$inboundSchema: z.ZodType<
+  AzureBlobCollectorConfExtractor,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  key: z.string(),
+  expression: z.string(),
+});
+/** @internal */
+export type AzureBlobCollectorConfExtractor$Outbound = {
+  key: string;
+  expression: string;
+};
+
+/** @internal */
+export const AzureBlobCollectorConfExtractor$outboundSchema: z.ZodType<
+  AzureBlobCollectorConfExtractor$Outbound,
+  z.ZodTypeDef,
+  AzureBlobCollectorConfExtractor
+> = z.object({
+  key: z.string(),
+  expression: z.string(),
+});
+
+export function azureBlobCollectorConfExtractorToJSON(
+  azureBlobCollectorConfExtractor: AzureBlobCollectorConfExtractor,
+): string {
+  return JSON.stringify(
+    AzureBlobCollectorConfExtractor$outboundSchema.parse(
+      azureBlobCollectorConfExtractor,
+    ),
+  );
+}
+export function azureBlobCollectorConfExtractorFromJSON(
+  jsonString: string,
+): SafeParseResult<AzureBlobCollectorConfExtractor, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AzureBlobCollectorConfExtractor$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AzureBlobCollectorConfExtractor' from JSON`,
+  );
+}
+
+/** @internal */
+export const AzureBlobCollectorConf$inboundSchema: z.ZodType<
+  AzureBlobCollectorConf,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  outputName: z.string().optional(),
+  authType: AzureBlobCollectorConfAuthenticationMethod$inboundSchema.default(
+    "manual",
+  ),
+  containerName: z.string(),
+  path: z.string().optional(),
+  extractors: z.array(
+    z.lazy(() => AzureBlobCollectorConfExtractor$inboundSchema),
+  ).optional(),
+  recurse: z.boolean().default(true),
+  includeMetadata: z.boolean().default(true),
+  includeTags: z.boolean().default(true),
+  maxBatchSize: z.number().default(10),
+  parquetChunkSizeMB: z.number().default(5),
+  parquetChunkDownloadTimeout: z.number().default(600),
+});
+/** @internal */
+export type AzureBlobCollectorConf$Outbound = {
+  outputName?: string | undefined;
+  authType: string;
+  containerName: string;
+  path?: string | undefined;
+  extractors?: Array<AzureBlobCollectorConfExtractor$Outbound> | undefined;
+  recurse: boolean;
+  includeMetadata: boolean;
+  includeTags: boolean;
+  maxBatchSize: number;
+  parquetChunkSizeMB: number;
+  parquetChunkDownloadTimeout: number;
+};
+
+/** @internal */
+export const AzureBlobCollectorConf$outboundSchema: z.ZodType<
+  AzureBlobCollectorConf$Outbound,
+  z.ZodTypeDef,
+  AzureBlobCollectorConf
+> = z.object({
+  outputName: z.string().optional(),
+  authType: AzureBlobCollectorConfAuthenticationMethod$outboundSchema.default(
+    "manual",
+  ),
+  containerName: z.string(),
+  path: z.string().optional(),
+  extractors: z.array(
+    z.lazy(() => AzureBlobCollectorConfExtractor$outboundSchema),
+  ).optional(),
+  recurse: z.boolean().default(true),
+  includeMetadata: z.boolean().default(true),
+  includeTags: z.boolean().default(true),
+  maxBatchSize: z.number().default(10),
+  parquetChunkSizeMB: z.number().default(5),
+  parquetChunkDownloadTimeout: z.number().default(600),
+});
+
+export function azureBlobCollectorConfToJSON(
+  azureBlobCollectorConf: AzureBlobCollectorConf,
+): string {
+  return JSON.stringify(
+    AzureBlobCollectorConf$outboundSchema.parse(azureBlobCollectorConf),
+  );
+}
+export function azureBlobCollectorConfFromJSON(
+  jsonString: string,
+): SafeParseResult<AzureBlobCollectorConf, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AzureBlobCollectorConf$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AzureBlobCollectorConf' from JSON`,
+  );
+}

package/src/models/{collectorconf.ts → collector.ts}

@@ -68,89 +68,77 @@ import {
 import { SDKValidationError } from "./errors/sdkvalidationerror.js";
 
 /**
- * Collector configuration
+ * Collector config wrapper
  */
-export type CollectorConf =
-  | (CollectorAzureBlob & { type: "azure_blob" })
+export type Collector =
+  | CollectorAzureBlob
   | CollectorCriblLake
   | CollectorDatabase
   | CollectorFilesystem
-  | (CollectorGoogleCloudStorage & { type: "google_cloud_storage" })
-  | (CollectorHealthCheck & { type: "health_check" })
-  | (CollectorRest & { type: "rest" })
-  | (CollectorS3 & { type: "s3" })
+  | CollectorGoogleCloudStorage
+  | CollectorHealthCheck
+  | CollectorRest
+  | CollectorS3
   | CollectorScript
-  | (CollectorSplunk & { type: "splunk" });
+  | CollectorSplunk;
 
 /** @internal */
-export const CollectorConf$inboundSchema: z.ZodType<
-  CollectorConf,
+export const Collector$inboundSchema: z.ZodType<
+  Collector,
   z.ZodTypeDef,
   unknown
 > = z.union([
-  CollectorAzureBlob$inboundSchema.and(
-    z.object({ type: z.literal("azure_blob") }),
-  ),
+  CollectorAzureBlob$inboundSchema,
   CollectorCriblLake$inboundSchema,
   CollectorDatabase$inboundSchema,
   CollectorFilesystem$inboundSchema,
-  CollectorGoogleCloudStorage$inboundSchema.and(
-    z.object({ type: z.literal("google_cloud_storage") }),
-  ),
-  CollectorHealthCheck$inboundSchema.and(
-    z.object({ type: z.literal("health_check") }),
-  ),
-  CollectorRest$inboundSchema.and(z.object({ type: z.literal("rest") })),
-  CollectorS3$inboundSchema.and(z.object({ type: z.literal("s3") })),
+  CollectorGoogleCloudStorage$inboundSchema,
+  CollectorHealthCheck$inboundSchema,
+  CollectorRest$inboundSchema,
+  CollectorS3$inboundSchema,
   CollectorScript$inboundSchema,
-  CollectorSplunk$inboundSchema.and(z.object({ type: z.literal("splunk") })),
+  CollectorSplunk$inboundSchema,
 ]);
 /** @internal */
-export type CollectorConf$Outbound =
-  | (CollectorAzureBlob$Outbound & { type: "azure_blob" })
+export type Collector$Outbound =
+  | CollectorAzureBlob$Outbound
   | CollectorCriblLake$Outbound
   | CollectorDatabase$Outbound
   | CollectorFilesystem$Outbound
-  | (CollectorGoogleCloudStorage$Outbound & { type: "google_cloud_storage" })
-  | (CollectorHealthCheck$Outbound & { type: "health_check" })
-  | (CollectorRest$Outbound & { type: "rest" })
-  | (CollectorS3$Outbound & { type: "s3" })
+  | CollectorGoogleCloudStorage$Outbound
+  | CollectorHealthCheck$Outbound
+  | CollectorRest$Outbound
+  | CollectorS3$Outbound
   | CollectorScript$Outbound
-  | (CollectorSplunk$Outbound & { type: "splunk" });
+  | CollectorSplunk$Outbound;
 
 /** @internal */
-export const CollectorConf$outboundSchema: z.ZodType<
-  CollectorConf$Outbound,
+export const Collector$outboundSchema: z.ZodType<
+  Collector$Outbound,
   z.ZodTypeDef,
-  CollectorConf
+  Collector
 > = z.union([
-  CollectorAzureBlob$outboundSchema.and(
-    z.object({ type: z.literal("azure_blob") }),
-  ),
+  CollectorAzureBlob$outboundSchema,
   CollectorCriblLake$outboundSchema,
   CollectorDatabase$outboundSchema,
   CollectorFilesystem$outboundSchema,
-  CollectorGoogleCloudStorage$outboundSchema.and(
-    z.object({ type: z.literal("google_cloud_storage") }),
-  ),
-  CollectorHealthCheck$outboundSchema.and(
-    z.object({ type: z.literal("health_check") }),
-  ),
-  CollectorRest$outboundSchema.and(z.object({ type: z.literal("rest") })),
-  CollectorS3$outboundSchema.and(z.object({ type: z.literal("s3") })),
+  CollectorGoogleCloudStorage$outboundSchema,
+  CollectorHealthCheck$outboundSchema,
+  CollectorRest$outboundSchema,
+  CollectorS3$outboundSchema,
   CollectorScript$outboundSchema,
-  CollectorSplunk$outboundSchema.and(z.object({ type: z.literal("splunk") })),
+  CollectorSplunk$outboundSchema,
 ]);
 
-export function collectorConfToJSON(collectorConf: CollectorConf): string {
-  return JSON.stringify(CollectorConf$outboundSchema.parse(collectorConf));
+export function collectorToJSON(collector: Collector): string {
+  return JSON.stringify(Collector$outboundSchema.parse(collector));
 }
-export function collectorConfFromJSON(
+export function collectorFromJSON(
   jsonString: string,
-): SafeParseResult<CollectorConf, SDKValidationError> {
+): SafeParseResult<Collector, SDKValidationError> {
   return safeParse(
     jsonString,
-    (x) => CollectorConf$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'CollectorConf' from JSON`,
+    (x) => Collector$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Collector' from JSON`,
   );
 }