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

package/src/models/googlecloudstoragecollectorconf.ts

@@ -0,0 +1,232 @@
+/*
+ * 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 type GoogleCloudStorageCollectorConfExtractor = {
+  /**
+   * A token from the template path, 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;
+};
+
+/**
+ * Enter account credentials manually, select a secret that references your credentials, or use Google Application Default Credentials
+ */
+export const GoogleCloudStorageCollectorConfAuthenticationMethod = {
+  Auto: "auto",
+  Manual: "manual",
+  Secret: "secret",
+} as const;
+/**
+ * Enter account credentials manually, select a secret that references your credentials, or use Google Application Default Credentials
+ */
+export type GoogleCloudStorageCollectorConfAuthenticationMethod = OpenEnum<
+  typeof GoogleCloudStorageCollectorConfAuthenticationMethod
+>;
+
+export type GoogleCloudStorageCollectorConf = {
+  /**
+   * Name of the predefined Destination that will be used to auto-populate Collector settings
+   */
+  outputName?: string | undefined;
+  /**
+   * Name of the bucket 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}`.
+   */
+  bucket: string;
+  /**
+   * 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 | undefined;
+  /**
+   * 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<GoogleCloudStorageCollectorConfExtractor> | undefined;
+  /**
+   * Google Cloud Storage service endpoint. If empty, the endpoint will default to https://storage.googleapis.com.
+   */
+  endpoint?: string | undefined;
+  /**
+   * Used to disable Collector event time filtering when a date range is specified
+   */
+  disableTimeFilter?: boolean | undefined;
+  /**
+   * Recurse through subdirectories
+   */
+  recurse?: boolean | undefined;
+  /**
+   * Maximum number of metadata objects to batch before recording as results
+   */
+  maxBatchSize?: number | undefined;
+  /**
+   * Enter account credentials manually, select a secret that references your credentials, or use Google Application Default Credentials
+   */
+  authType?: GoogleCloudStorageCollectorConfAuthenticationMethod | 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 GoogleCloudStorageCollectorConfExtractor$inboundSchema: z.ZodType<
+  GoogleCloudStorageCollectorConfExtractor,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  key: z.string(),
+  expression: z.string(),
+});
+/** @internal */
+export type GoogleCloudStorageCollectorConfExtractor$Outbound = {
+  key: string;
+  expression: string;
+};
+
+/** @internal */
+export const GoogleCloudStorageCollectorConfExtractor$outboundSchema: z.ZodType<
+  GoogleCloudStorageCollectorConfExtractor$Outbound,
+  z.ZodTypeDef,
+  GoogleCloudStorageCollectorConfExtractor
+> = z.object({
+  key: z.string(),
+  expression: z.string(),
+});
+
+export function googleCloudStorageCollectorConfExtractorToJSON(
+  googleCloudStorageCollectorConfExtractor:
+    GoogleCloudStorageCollectorConfExtractor,
+): string {
+  return JSON.stringify(
+    GoogleCloudStorageCollectorConfExtractor$outboundSchema.parse(
+      googleCloudStorageCollectorConfExtractor,
+    ),
+  );
+}
+export function googleCloudStorageCollectorConfExtractorFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  GoogleCloudStorageCollectorConfExtractor,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      GoogleCloudStorageCollectorConfExtractor$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'GoogleCloudStorageCollectorConfExtractor' from JSON`,
+  );
+}
+
+/** @internal */
+export const GoogleCloudStorageCollectorConfAuthenticationMethod$inboundSchema:
+  z.ZodType<
+    GoogleCloudStorageCollectorConfAuthenticationMethod,
+    z.ZodTypeDef,
+    unknown
+  > = openEnums.inboundSchema(
+    GoogleCloudStorageCollectorConfAuthenticationMethod,
+  );
+/** @internal */
+export const GoogleCloudStorageCollectorConfAuthenticationMethod$outboundSchema:
+  z.ZodType<
+    string,
+    z.ZodTypeDef,
+    GoogleCloudStorageCollectorConfAuthenticationMethod
+  > = openEnums.outboundSchema(
+    GoogleCloudStorageCollectorConfAuthenticationMethod,
+  );
+
+/** @internal */
+export const GoogleCloudStorageCollectorConf$inboundSchema: z.ZodType<
+  GoogleCloudStorageCollectorConf,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  outputName: z.string().optional(),
+  bucket: z.string(),
+  path: z.string().optional(),
+  extractors: z.array(
+    z.lazy(() => GoogleCloudStorageCollectorConfExtractor$inboundSchema),
+  ).optional(),
+  endpoint: z.string().optional(),
+  disableTimeFilter: z.boolean().default(false),
+  recurse: z.boolean().default(true),
+  maxBatchSize: z.number().default(10),
+  authType: GoogleCloudStorageCollectorConfAuthenticationMethod$inboundSchema
+    .default("manual"),
+  parquetChunkSizeMB: z.number().default(5),
+  parquetChunkDownloadTimeout: z.number().default(600),
+});
+/** @internal */
+export type GoogleCloudStorageCollectorConf$Outbound = {
+  outputName?: string | undefined;
+  bucket: string;
+  path?: string | undefined;
+  extractors?:
+    | Array<GoogleCloudStorageCollectorConfExtractor$Outbound>
+    | undefined;
+  endpoint?: string | undefined;
+  disableTimeFilter: boolean;
+  recurse: boolean;
+  maxBatchSize: number;
+  authType: string;
+  parquetChunkSizeMB: number;
+  parquetChunkDownloadTimeout: number;
+};
+
+/** @internal */
+export const GoogleCloudStorageCollectorConf$outboundSchema: z.ZodType<
+  GoogleCloudStorageCollectorConf$Outbound,
+  z.ZodTypeDef,
+  GoogleCloudStorageCollectorConf
+> = z.object({
+  outputName: z.string().optional(),
+  bucket: z.string(),
+  path: z.string().optional(),
+  extractors: z.array(
+    z.lazy(() => GoogleCloudStorageCollectorConfExtractor$outboundSchema),
+  ).optional(),
+  endpoint: z.string().optional(),
+  disableTimeFilter: z.boolean().default(false),
+  recurse: z.boolean().default(true),
+  maxBatchSize: z.number().default(10),
+  authType: GoogleCloudStorageCollectorConfAuthenticationMethod$outboundSchema
+    .default("manual"),
+  parquetChunkSizeMB: z.number().default(5),
+  parquetChunkDownloadTimeout: z.number().default(600),
+});
+
+export function googleCloudStorageCollectorConfToJSON(
+  googleCloudStorageCollectorConf: GoogleCloudStorageCollectorConf,
+): string {
+  return JSON.stringify(
+    GoogleCloudStorageCollectorConf$outboundSchema.parse(
+      googleCloudStorageCollectorConf,
+    ),
+  );
+}
+export function googleCloudStorageCollectorConfFromJSON(
+  jsonString: string,
+): SafeParseResult<GoogleCloudStorageCollectorConf, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GoogleCloudStorageCollectorConf$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GoogleCloudStorageCollectorConf' from JSON`,
+  );
+}