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

package/src/models/collectors3.ts

@@ -1,348 +0,0 @@
-/*
- * 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";
-
-/**
- * Partitioning scheme used for this dataset. Using a known scheme like DDSS enables more efficient data reading and retrieval.
- */
-export const PartitioningScheme = {
-  /**
-   * Defined in Path
-   */
-  None: "none",
-  /**
-   * DDSS
-   */
-  Ddss: "ddss",
-} as const;
-/**
- * Partitioning scheme used for this dataset. Using a known scheme like DDSS enables more efficient data reading and retrieval.
- */
-export type PartitioningScheme = OpenEnum<typeof PartitioningScheme>;
-
-export type CollectorS3Extractor = {
-  /**
-   * 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. Example: {date: new Date(+value*1000)}
-   */
-  expression: string;
-};
-
-/**
- * AWS authentication method. Choose Auto to use IAM roles.
- */
-export const CollectorS3AuthenticationMethod = {
-  /**
-   * Auto
-   */
-  Auto: "auto",
-  /**
-   * Manual
-   */
-  Manual: "manual",
-  /**
-   * Secret Key pair
-   */
-  Secret: "secret",
-} as const;
-/**
- * AWS authentication method. Choose Auto to use IAM roles.
- */
-export type CollectorS3AuthenticationMethod = OpenEnum<
-  typeof CollectorS3AuthenticationMethod
->;
-
-/**
- * Signature version to use for signing S3 requests
- */
-export const CollectorS3SignatureVersion = {
-  V2: "v2",
-  V4: "v4",
-} as const;
-/**
- * Signature version to use for signing S3 requests
- */
-export type CollectorS3SignatureVersion = OpenEnum<
-  typeof CollectorS3SignatureVersion
->;
-
-export type CollectorS3 = {
-  /**
-   * Collector type: s3
-   */
-  type: "s3";
-  /**
-   * Name of the predefined Destination that will be used to auto-populate Collector settings
-   */
-  outputName?: string | undefined;
-  /**
-   * S3 Bucket from which to collect data
-   */
-  bucket: string;
-  /**
-   * Maximum file size for each Parquet chunk
-   */
-  parquetChunkSizeMB?: number | undefined;
-  /**
-   * Maximum time allowed for downloading a Parquet chunk. Processing will stop if a chunk cannot be downloaded within the time specified.
-   */
-  parquetChunkDownloadTimeout?: number | undefined;
-  /**
-   * Region from which to retrieve data
-   */
-  region?: string | undefined;
-  /**
-   * Directory where data will be collected. Templating (such as 'myDir/${datacenter}/${host}/${app}/') and time-based tokens (such as 'myOtherDir/${_time:%Y}/${_time:%m}/${_time:%d}/') are supported. Can be a constant (enclosed in quotes) or a JavaScript expression.
-   */
-  path?: string | undefined;
-  /**
-   * Partitioning scheme used for this dataset. Using a known scheme like DDSS enables more efficient data reading and retrieval.
-   */
-  partitioningScheme?: PartitioningScheme | 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<CollectorS3Extractor> | undefined;
-  /**
-   * AWS authentication method. Choose Auto to use IAM roles.
-   */
-  awsAuthenticationMethod?: CollectorS3AuthenticationMethod | undefined;
-  /**
-   * Must point to an S3-compatible endpoint. If empty, defaults to an AWS region-specific endpoint.
-   */
-  endpoint?: string | undefined;
-  /**
-   * Signature version to use for signing S3 requests
-   */
-  signatureVersion?: CollectorS3SignatureVersion | undefined;
-  /**
-   * Use AssumeRole credentials
-   */
-  enableAssumeRole?: boolean | undefined;
-  /**
-   * Amazon Resource Name (ARN) of the role to assume
-   */
-  assumeRoleArn?: string | undefined;
-  /**
-   * External ID to use when assuming role
-   */
-  assumeRoleExternalId?: string | undefined;
-  /**
-   * Duration of the Assumed Role's session, in seconds. Minimum is 900 (15 minutes), default is 3600 (1 hour), and maximum is 43200 (12 hours).
-   */
-  durationSeconds?: number | undefined;
-  /**
-   * Maximum number of metadata objects to batch before recording as results
-   */
-  maxBatchSize?: number | undefined;
-  recurse?: any | undefined;
-  /**
-   * Reuse connections between requests to improve performance
-   */
-  reuseConnections?: boolean | undefined;
-  /**
-   * Reject certificates that cannot be verified against a valid CA (such as a self-signed certificate)
-   */
-  rejectUnauthorized?: boolean | undefined;
-  /**
-   * Disable if you can access files within the bucket but not the bucket itself. Resolves errors of the form "discover task initialization failed...error: Forbidden".
-   */
-  verifyPermissions?: boolean | undefined;
-  /**
-   * Disable Collector event time filtering when a date range is specified
-   */
-  disableTimeFilter?: boolean | undefined;
-};
-
-/** @internal */
-export const PartitioningScheme$inboundSchema: z.ZodType<
-  PartitioningScheme,
-  z.ZodTypeDef,
-  unknown
-> = openEnums.inboundSchema(PartitioningScheme);
-/** @internal */
-export const PartitioningScheme$outboundSchema: z.ZodType<
-  string,
-  z.ZodTypeDef,
-  PartitioningScheme
-> = openEnums.outboundSchema(PartitioningScheme);
-
-/** @internal */
-export const CollectorS3Extractor$inboundSchema: z.ZodType<
-  CollectorS3Extractor,
-  z.ZodTypeDef,
-  unknown
-> = z.object({
-  key: z.string(),
-  expression: z.string(),
-});
-/** @internal */
-export type CollectorS3Extractor$Outbound = {
-  key: string;
-  expression: string;
-};
-
-/** @internal */
-export const CollectorS3Extractor$outboundSchema: z.ZodType<
-  CollectorS3Extractor$Outbound,
-  z.ZodTypeDef,
-  CollectorS3Extractor
-> = z.object({
-  key: z.string(),
-  expression: z.string(),
-});
-
-export function collectorS3ExtractorToJSON(
-  collectorS3Extractor: CollectorS3Extractor,
-): string {
-  return JSON.stringify(
-    CollectorS3Extractor$outboundSchema.parse(collectorS3Extractor),
-  );
-}
-export function collectorS3ExtractorFromJSON(
-  jsonString: string,
-): SafeParseResult<CollectorS3Extractor, SDKValidationError> {
-  return safeParse(
-    jsonString,
-    (x) => CollectorS3Extractor$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'CollectorS3Extractor' from JSON`,
-  );
-}
-
-/** @internal */
-export const CollectorS3AuthenticationMethod$inboundSchema: z.ZodType<
-  CollectorS3AuthenticationMethod,
-  z.ZodTypeDef,
-  unknown
-> = openEnums.inboundSchema(CollectorS3AuthenticationMethod);
-/** @internal */
-export const CollectorS3AuthenticationMethod$outboundSchema: z.ZodType<
-  string,
-  z.ZodTypeDef,
-  CollectorS3AuthenticationMethod
-> = openEnums.outboundSchema(CollectorS3AuthenticationMethod);
-
-/** @internal */
-export const CollectorS3SignatureVersion$inboundSchema: z.ZodType<
-  CollectorS3SignatureVersion,
-  z.ZodTypeDef,
-  unknown
-> = openEnums.inboundSchema(CollectorS3SignatureVersion);
-/** @internal */
-export const CollectorS3SignatureVersion$outboundSchema: z.ZodType<
-  string,
-  z.ZodTypeDef,
-  CollectorS3SignatureVersion
-> = openEnums.outboundSchema(CollectorS3SignatureVersion);
-
-/** @internal */
-export const CollectorS3$inboundSchema: z.ZodType<
-  CollectorS3,
-  z.ZodTypeDef,
-  unknown
-> = z.object({
-  type: z.literal("s3"),
-  outputName: z.string().optional(),
-  bucket: z.string(),
-  parquetChunkSizeMB: z.number().default(5),
-  parquetChunkDownloadTimeout: z.number().default(600),
-  region: z.string().optional(),
-  path: z.string().optional(),
-  partitioningScheme: PartitioningScheme$inboundSchema.default("none"),
-  extractors: z.array(z.lazy(() => CollectorS3Extractor$inboundSchema))
-    .optional(),
-  awsAuthenticationMethod: CollectorS3AuthenticationMethod$inboundSchema
-    .default("auto"),
-  endpoint: z.string().optional(),
-  signatureVersion: CollectorS3SignatureVersion$inboundSchema.default("v4"),
-  enableAssumeRole: z.boolean().default(false),
-  assumeRoleArn: z.string().optional(),
-  assumeRoleExternalId: z.string().optional(),
-  durationSeconds: z.number().default(3600),
-  maxBatchSize: z.number().default(10),
-  recurse: z.any().optional(),
-  reuseConnections: z.boolean().default(true),
-  rejectUnauthorized: z.boolean().default(true),
-  verifyPermissions: z.boolean().default(true),
-  disableTimeFilter: z.boolean().default(false),
-});
-/** @internal */
-export type CollectorS3$Outbound = {
-  type: "s3";
-  outputName?: string | undefined;
-  bucket: string;
-  parquetChunkSizeMB: number;
-  parquetChunkDownloadTimeout: number;
-  region?: string | undefined;
-  path?: string | undefined;
-  partitioningScheme: string;
-  extractors?: Array<CollectorS3Extractor$Outbound> | undefined;
-  awsAuthenticationMethod: string;
-  endpoint?: string | undefined;
-  signatureVersion: string;
-  enableAssumeRole: boolean;
-  assumeRoleArn?: string | undefined;
-  assumeRoleExternalId?: string | undefined;
-  durationSeconds: number;
-  maxBatchSize: number;
-  recurse?: any | undefined;
-  reuseConnections: boolean;
-  rejectUnauthorized: boolean;
-  verifyPermissions: boolean;
-  disableTimeFilter: boolean;
-};
-
-/** @internal */
-export const CollectorS3$outboundSchema: z.ZodType<
-  CollectorS3$Outbound,
-  z.ZodTypeDef,
-  CollectorS3
-> = z.object({
-  type: z.literal("s3"),
-  outputName: z.string().optional(),
-  bucket: z.string(),
-  parquetChunkSizeMB: z.number().default(5),
-  parquetChunkDownloadTimeout: z.number().default(600),
-  region: z.string().optional(),
-  path: z.string().optional(),
-  partitioningScheme: PartitioningScheme$outboundSchema.default("none"),
-  extractors: z.array(z.lazy(() => CollectorS3Extractor$outboundSchema))
-    .optional(),
-  awsAuthenticationMethod: CollectorS3AuthenticationMethod$outboundSchema
-    .default("auto"),
-  endpoint: z.string().optional(),
-  signatureVersion: CollectorS3SignatureVersion$outboundSchema.default("v4"),
-  enableAssumeRole: z.boolean().default(false),
-  assumeRoleArn: z.string().optional(),
-  assumeRoleExternalId: z.string().optional(),
-  durationSeconds: z.number().default(3600),
-  maxBatchSize: z.number().default(10),
-  recurse: z.any().optional(),
-  reuseConnections: z.boolean().default(true),
-  rejectUnauthorized: z.boolean().default(true),
-  verifyPermissions: z.boolean().default(true),
-  disableTimeFilter: z.boolean().default(false),
-});
-
-export function collectorS3ToJSON(collectorS3: CollectorS3): string {
-  return JSON.stringify(CollectorS3$outboundSchema.parse(collectorS3));
-}
-export function collectorS3FromJSON(
-  jsonString: string,
-): SafeParseResult<CollectorS3, SDKValidationError> {
-  return safeParse(
-    jsonString,
-    (x) => CollectorS3$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'CollectorS3' from JSON`,
-  );
-}

package/src/models/collectorscript.ts

@@ -1,126 +0,0 @@
-/*
- * 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 CollectorScript = {
-  /**
-   * Collector type: script
-   */
-  type: "script";
-  /**
-   * 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 CollectorScript$inboundSchema: z.ZodType<
-  CollectorScript,
-  z.ZodTypeDef,
-  unknown
-> = z.object({
-  type: z.literal("script"),
-  discoverScript: z.string(),
-  collectScript: z.string(),
-  shell: z.string().default("/bin/bash"),
-  envVars: z.array(z.lazy(() => EnvVar$inboundSchema)).optional(),
-});
-/** @internal */
-export type CollectorScript$Outbound = {
-  type: "script";
-  discoverScript: string;
-  collectScript: string;
-  shell: string;
-  envVars?: Array<EnvVar$Outbound> | undefined;
-};
-
-/** @internal */
-export const CollectorScript$outboundSchema: z.ZodType<
-  CollectorScript$Outbound,
-  z.ZodTypeDef,
-  CollectorScript
-> = z.object({
-  type: z.literal("script"),
-  discoverScript: z.string(),
-  collectScript: z.string(),
-  shell: z.string().default("/bin/bash"),
-  envVars: z.array(z.lazy(() => EnvVar$outboundSchema)).optional(),
-});
-
-export function collectorScriptToJSON(
-  collectorScript: CollectorScript,
-): string {
-  return JSON.stringify(CollectorScript$outboundSchema.parse(collectorScript));
-}
-export function collectorScriptFromJSON(
-  jsonString: string,
-): SafeParseResult<CollectorScript, SDKValidationError> {
-  return safeParse(
-    jsonString,
-    (x) => CollectorScript$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'CollectorScript' from JSON`,
-  );
-}