cribl-control-plane 0.5.0-rc.1 → 0.5.0-rc.10

package/src/models/pipelinefunctiondnslookup.ts

@@ -0,0 +1,99 @@
+/*
+ * 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";
+import {
+  FunctionConfSchemaDnsLookup,
+  FunctionConfSchemaDnsLookup$inboundSchema,
+  FunctionConfSchemaDnsLookup$Outbound,
+  FunctionConfSchemaDnsLookup$outboundSchema,
+} from "./functionconfschemadnslookup.js";
+
+export type PipelineFunctionDnsLookup = {
+  /**
+   * Filter that selects data to be fed through this Function
+   */
+  filter?: string | undefined;
+  /**
+   * Function ID
+   */
+  id: "dns_lookup";
+  /**
+   * Simple description of this step
+   */
+  description?: string | undefined;
+  /**
+   * If true, data will not be pushed through this function
+   */
+  disabled?: boolean | undefined;
+  /**
+   * If enabled, stops the results of this Function from being passed to the downstream Functions
+   */
+  final?: boolean | undefined;
+  conf: FunctionConfSchemaDnsLookup;
+  /**
+   * Group ID
+   */
+  groupId?: string | undefined;
+};
+
+/** @internal */
+export const PipelineFunctionDnsLookup$inboundSchema: z.ZodType<
+  PipelineFunctionDnsLookup,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  filter: z.string().default("true"),
+  id: z.literal("dns_lookup"),
+  description: z.string().optional(),
+  disabled: z.boolean().optional(),
+  final: z.boolean().optional(),
+  conf: FunctionConfSchemaDnsLookup$inboundSchema,
+  groupId: z.string().optional(),
+});
+/** @internal */
+export type PipelineFunctionDnsLookup$Outbound = {
+  filter: string;
+  id: "dns_lookup";
+  description?: string | undefined;
+  disabled?: boolean | undefined;
+  final?: boolean | undefined;
+  conf: FunctionConfSchemaDnsLookup$Outbound;
+  groupId?: string | undefined;
+};
+
+/** @internal */
+export const PipelineFunctionDnsLookup$outboundSchema: z.ZodType<
+  PipelineFunctionDnsLookup$Outbound,
+  z.ZodTypeDef,
+  PipelineFunctionDnsLookup
+> = z.object({
+  filter: z.string().default("true"),
+  id: z.literal("dns_lookup"),
+  description: z.string().optional(),
+  disabled: z.boolean().optional(),
+  final: z.boolean().optional(),
+  conf: FunctionConfSchemaDnsLookup$outboundSchema,
+  groupId: z.string().optional(),
+});
+
+export function pipelineFunctionDnsLookupToJSON(
+  pipelineFunctionDnsLookup: PipelineFunctionDnsLookup,
+): string {
+  return JSON.stringify(
+    PipelineFunctionDnsLookup$outboundSchema.parse(pipelineFunctionDnsLookup),
+  );
+}
+export function pipelineFunctionDnsLookupFromJSON(
+  jsonString: string,
+): SafeParseResult<PipelineFunctionDnsLookup, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PipelineFunctionDnsLookup$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PipelineFunctionDnsLookup' from JSON`,
+  );
+}

package/src/models/pipelinefunctiondrop.ts

@@ -0,0 +1,99 @@
+/*
+ * 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";
+import {
+  FunctionConfSchemaDrop,
+  FunctionConfSchemaDrop$inboundSchema,
+  FunctionConfSchemaDrop$Outbound,
+  FunctionConfSchemaDrop$outboundSchema,
+} from "./functionconfschemadrop.js";
+
+export type PipelineFunctionDrop = {
+  /**
+   * Filter that selects data to be fed through this Function
+   */
+  filter?: string | undefined;
+  /**
+   * Function ID
+   */
+  id: "drop";
+  /**
+   * Simple description of this step
+   */
+  description?: string | undefined;
+  /**
+   * If true, data will not be pushed through this function
+   */
+  disabled?: boolean | undefined;
+  /**
+   * If enabled, stops the results of this Function from being passed to the downstream Functions
+   */
+  final?: boolean | undefined;
+  conf: FunctionConfSchemaDrop;
+  /**
+   * Group ID
+   */
+  groupId?: string | undefined;
+};
+
+/** @internal */
+export const PipelineFunctionDrop$inboundSchema: z.ZodType<
+  PipelineFunctionDrop,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  filter: z.string().default("true"),
+  id: z.literal("drop"),
+  description: z.string().optional(),
+  disabled: z.boolean().optional(),
+  final: z.boolean().optional(),
+  conf: FunctionConfSchemaDrop$inboundSchema,
+  groupId: z.string().optional(),
+});
+/** @internal */
+export type PipelineFunctionDrop$Outbound = {
+  filter: string;
+  id: "drop";
+  description?: string | undefined;
+  disabled?: boolean | undefined;
+  final?: boolean | undefined;
+  conf: FunctionConfSchemaDrop$Outbound;
+  groupId?: string | undefined;
+};
+
+/** @internal */
+export const PipelineFunctionDrop$outboundSchema: z.ZodType<
+  PipelineFunctionDrop$Outbound,
+  z.ZodTypeDef,
+  PipelineFunctionDrop
+> = z.object({
+  filter: z.string().default("true"),
+  id: z.literal("drop"),
+  description: z.string().optional(),
+  disabled: z.boolean().optional(),
+  final: z.boolean().optional(),
+  conf: FunctionConfSchemaDrop$outboundSchema,
+  groupId: z.string().optional(),
+});
+
+export function pipelineFunctionDropToJSON(
+  pipelineFunctionDrop: PipelineFunctionDrop,
+): string {
+  return JSON.stringify(
+    PipelineFunctionDrop$outboundSchema.parse(pipelineFunctionDrop),
+  );
+}
+export function pipelineFunctionDropFromJSON(
+  jsonString: string,
+): SafeParseResult<PipelineFunctionDrop, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PipelineFunctionDrop$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PipelineFunctionDrop' from JSON`,
+  );
+}

package/src/models/pipelinefunctiondropdimensions.ts

@@ -0,0 +1,158 @@
+/*
+ * 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 PipelineFunctionDropDimensionsConf = {
+  /**
+   * The time span of the tumbling window for aggregating events. Must be a valid time string (such as 10s).
+   */
+  timeWindow?: string | undefined;
+  /**
+   * One or more dimensions to be dropped. Supports wildcard expressions. Warning: Using wildcard '*' causes all dimensions in the event to be dropped.
+   */
+  dropDimensions: Array<string>;
+  /**
+   * Flush aggregations when an input stream is closed. If disabled, aggregations are flushed based on Time Window Settings instead.
+   */
+  flushOnInputClose?: boolean | undefined;
+};
+
+export type PipelineFunctionDropDimensions = {
+  /**
+   * Filter that selects data to be fed through this Function
+   */
+  filter?: string | undefined;
+  /**
+   * Function ID
+   */
+  id: "drop_dimensions";
+  /**
+   * Simple description of this step
+   */
+  description?: string | undefined;
+  /**
+   * If true, data will not be pushed through this function
+   */
+  disabled?: boolean | undefined;
+  /**
+   * If enabled, stops the results of this Function from being passed to the downstream Functions
+   */
+  final?: boolean | undefined;
+  conf: PipelineFunctionDropDimensionsConf;
+  /**
+   * Group ID
+   */
+  groupId?: string | undefined;
+};
+
+/** @internal */
+export const PipelineFunctionDropDimensionsConf$inboundSchema: z.ZodType<
+  PipelineFunctionDropDimensionsConf,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  timeWindow: z.string().default("10s"),
+  dropDimensions: z.array(z.string()),
+  flushOnInputClose: z.boolean().default(true),
+});
+/** @internal */
+export type PipelineFunctionDropDimensionsConf$Outbound = {
+  timeWindow: string;
+  dropDimensions: Array<string>;
+  flushOnInputClose: boolean;
+};
+
+/** @internal */
+export const PipelineFunctionDropDimensionsConf$outboundSchema: z.ZodType<
+  PipelineFunctionDropDimensionsConf$Outbound,
+  z.ZodTypeDef,
+  PipelineFunctionDropDimensionsConf
+> = z.object({
+  timeWindow: z.string().default("10s"),
+  dropDimensions: z.array(z.string()),
+  flushOnInputClose: z.boolean().default(true),
+});
+
+export function pipelineFunctionDropDimensionsConfToJSON(
+  pipelineFunctionDropDimensionsConf: PipelineFunctionDropDimensionsConf,
+): string {
+  return JSON.stringify(
+    PipelineFunctionDropDimensionsConf$outboundSchema.parse(
+      pipelineFunctionDropDimensionsConf,
+    ),
+  );
+}
+export function pipelineFunctionDropDimensionsConfFromJSON(
+  jsonString: string,
+): SafeParseResult<PipelineFunctionDropDimensionsConf, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      PipelineFunctionDropDimensionsConf$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PipelineFunctionDropDimensionsConf' from JSON`,
+  );
+}
+
+/** @internal */
+export const PipelineFunctionDropDimensions$inboundSchema: z.ZodType<
+  PipelineFunctionDropDimensions,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  filter: z.string().default("true"),
+  id: z.literal("drop_dimensions"),
+  description: z.string().optional(),
+  disabled: z.boolean().optional(),
+  final: z.boolean().optional(),
+  conf: z.lazy(() => PipelineFunctionDropDimensionsConf$inboundSchema),
+  groupId: z.string().optional(),
+});
+/** @internal */
+export type PipelineFunctionDropDimensions$Outbound = {
+  filter: string;
+  id: "drop_dimensions";
+  description?: string | undefined;
+  disabled?: boolean | undefined;
+  final?: boolean | undefined;
+  conf: PipelineFunctionDropDimensionsConf$Outbound;
+  groupId?: string | undefined;
+};
+
+/** @internal */
+export const PipelineFunctionDropDimensions$outboundSchema: z.ZodType<
+  PipelineFunctionDropDimensions$Outbound,
+  z.ZodTypeDef,
+  PipelineFunctionDropDimensions
+> = z.object({
+  filter: z.string().default("true"),
+  id: z.literal("drop_dimensions"),
+  description: z.string().optional(),
+  disabled: z.boolean().optional(),
+  final: z.boolean().optional(),
+  conf: z.lazy(() => PipelineFunctionDropDimensionsConf$outboundSchema),
+  groupId: z.string().optional(),
+});
+
+export function pipelineFunctionDropDimensionsToJSON(
+  pipelineFunctionDropDimensions: PipelineFunctionDropDimensions,
+): string {
+  return JSON.stringify(
+    PipelineFunctionDropDimensions$outboundSchema.parse(
+      pipelineFunctionDropDimensions,
+    ),
+  );
+}
+export function pipelineFunctionDropDimensionsFromJSON(
+  jsonString: string,
+): SafeParseResult<PipelineFunctionDropDimensions, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PipelineFunctionDropDimensions$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PipelineFunctionDropDimensions' from JSON`,
+  );
+}

package/src/models/pipelinefunctiondynamicsampling.ts

@@ -0,0 +1,205 @@
+/*
+ * 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";
+
+/**
+ * Defines how sample rate will be derived: log(previousPeriodCount) or sqrt(previousPeriodCount)
+ */
+export const PipelineFunctionDynamicSamplingSampleMode = {
+  /**
+   * Logarithmic
+   */
+  Log: "log",
+  /**
+   * Square Root
+   */
+  Sqrt: "sqrt",
+} as const;
+/**
+ * Defines how sample rate will be derived: log(previousPeriodCount) or sqrt(previousPeriodCount)
+ */
+export type PipelineFunctionDynamicSamplingSampleMode = OpenEnum<
+  typeof PipelineFunctionDynamicSamplingSampleMode
+>;
+
+export type PipelineFunctionDynamicSamplingConf = {
+  /**
+   * Defines how sample rate will be derived: log(previousPeriodCount) or sqrt(previousPeriodCount)
+   */
+  mode?: PipelineFunctionDynamicSamplingSampleMode | undefined;
+  /**
+   * Expression used to derive sample group key. Example:`${domain}:${status}`. Each sample group will have its own derived sampling rate based on volume. Defaults to `${host}`.
+   */
+  keyExpr?: string | undefined;
+  /**
+   * How often (in seconds) sample rates will be adjusted
+   */
+  samplePeriod?: number | undefined;
+  /**
+   * Minimum number of events that must be received in previous sample period for sampling mode to be applied to current period. If the number of events received for a sample group is less than this minimum, a sample rate of 1:1 is used.
+   */
+  minEvents?: number | undefined;
+  /**
+   * Maximum sampling rate. If computed sampling rate is above this value, it will be limited to this value.
+   */
+  maxSampleRate?: number | undefined;
+};
+
+export type PipelineFunctionDynamicSampling = {
+  /**
+   * Filter that selects data to be fed through this Function
+   */
+  filter?: string | undefined;
+  /**
+   * Function ID
+   */
+  id: "dynamic_sampling";
+  /**
+   * Simple description of this step
+   */
+  description?: string | undefined;
+  /**
+   * If true, data will not be pushed through this function
+   */
+  disabled?: boolean | undefined;
+  /**
+   * If enabled, stops the results of this Function from being passed to the downstream Functions
+   */
+  final?: boolean | undefined;
+  conf: PipelineFunctionDynamicSamplingConf;
+  /**
+   * Group ID
+   */
+  groupId?: string | undefined;
+};
+
+/** @internal */
+export const PipelineFunctionDynamicSamplingSampleMode$inboundSchema: z.ZodType<
+  PipelineFunctionDynamicSamplingSampleMode,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(PipelineFunctionDynamicSamplingSampleMode);
+/** @internal */
+export const PipelineFunctionDynamicSamplingSampleMode$outboundSchema:
+  z.ZodType<string, z.ZodTypeDef, PipelineFunctionDynamicSamplingSampleMode> =
+    openEnums.outboundSchema(PipelineFunctionDynamicSamplingSampleMode);
+
+/** @internal */
+export const PipelineFunctionDynamicSamplingConf$inboundSchema: z.ZodType<
+  PipelineFunctionDynamicSamplingConf,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  mode: PipelineFunctionDynamicSamplingSampleMode$inboundSchema.default("log"),
+  keyExpr: z.string().default("`${host}`"),
+  samplePeriod: z.number().default(30),
+  minEvents: z.number().default(30),
+  maxSampleRate: z.number().default(100),
+});
+/** @internal */
+export type PipelineFunctionDynamicSamplingConf$Outbound = {
+  mode: string;
+  keyExpr: string;
+  samplePeriod: number;
+  minEvents: number;
+  maxSampleRate: number;
+};
+
+/** @internal */
+export const PipelineFunctionDynamicSamplingConf$outboundSchema: z.ZodType<
+  PipelineFunctionDynamicSamplingConf$Outbound,
+  z.ZodTypeDef,
+  PipelineFunctionDynamicSamplingConf
+> = z.object({
+  mode: PipelineFunctionDynamicSamplingSampleMode$outboundSchema.default("log"),
+  keyExpr: z.string().default("`${host}`"),
+  samplePeriod: z.number().default(30),
+  minEvents: z.number().default(30),
+  maxSampleRate: z.number().default(100),
+});
+
+export function pipelineFunctionDynamicSamplingConfToJSON(
+  pipelineFunctionDynamicSamplingConf: PipelineFunctionDynamicSamplingConf,
+): string {
+  return JSON.stringify(
+    PipelineFunctionDynamicSamplingConf$outboundSchema.parse(
+      pipelineFunctionDynamicSamplingConf,
+    ),
+  );
+}
+export function pipelineFunctionDynamicSamplingConfFromJSON(
+  jsonString: string,
+): SafeParseResult<PipelineFunctionDynamicSamplingConf, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      PipelineFunctionDynamicSamplingConf$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PipelineFunctionDynamicSamplingConf' from JSON`,
+  );
+}
+
+/** @internal */
+export const PipelineFunctionDynamicSampling$inboundSchema: z.ZodType<
+  PipelineFunctionDynamicSampling,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  filter: z.string().default("true"),
+  id: z.literal("dynamic_sampling"),
+  description: z.string().optional(),
+  disabled: z.boolean().optional(),
+  final: z.boolean().optional(),
+  conf: z.lazy(() => PipelineFunctionDynamicSamplingConf$inboundSchema),
+  groupId: z.string().optional(),
+});
+/** @internal */
+export type PipelineFunctionDynamicSampling$Outbound = {
+  filter: string;
+  id: "dynamic_sampling";
+  description?: string | undefined;
+  disabled?: boolean | undefined;
+  final?: boolean | undefined;
+  conf: PipelineFunctionDynamicSamplingConf$Outbound;
+  groupId?: string | undefined;
+};
+
+/** @internal */
+export const PipelineFunctionDynamicSampling$outboundSchema: z.ZodType<
+  PipelineFunctionDynamicSampling$Outbound,
+  z.ZodTypeDef,
+  PipelineFunctionDynamicSampling
+> = z.object({
+  filter: z.string().default("true"),
+  id: z.literal("dynamic_sampling"),
+  description: z.string().optional(),
+  disabled: z.boolean().optional(),
+  final: z.boolean().optional(),
+  conf: z.lazy(() => PipelineFunctionDynamicSamplingConf$outboundSchema),
+  groupId: z.string().optional(),
+});
+
+export function pipelineFunctionDynamicSamplingToJSON(
+  pipelineFunctionDynamicSampling: PipelineFunctionDynamicSampling,
+): string {
+  return JSON.stringify(
+    PipelineFunctionDynamicSampling$outboundSchema.parse(
+      pipelineFunctionDynamicSampling,
+    ),
+  );
+}
+export function pipelineFunctionDynamicSamplingFromJSON(
+  jsonString: string,
+): SafeParseResult<PipelineFunctionDynamicSampling, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PipelineFunctionDynamicSampling$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PipelineFunctionDynamicSampling' from JSON`,
+  );
+}

package/src/models/pipelinefunctioneval.ts

@@ -0,0 +1,99 @@
+/*
+ * 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";
+import {
+  FunctionConfSchemaEval,
+  FunctionConfSchemaEval$inboundSchema,
+  FunctionConfSchemaEval$Outbound,
+  FunctionConfSchemaEval$outboundSchema,
+} from "./functionconfschemaeval.js";
+
+export type PipelineFunctionEval = {
+  /**
+   * Filter that selects data to be fed through this Function
+   */
+  filter?: string | undefined;
+  /**
+   * Function ID
+   */
+  id: "eval";
+  /**
+   * Simple description of this step
+   */
+  description?: string | undefined;
+  /**
+   * If true, data will not be pushed through this function
+   */
+  disabled?: boolean | undefined;
+  /**
+   * If enabled, stops the results of this Function from being passed to the downstream Functions
+   */
+  final?: boolean | undefined;
+  conf: FunctionConfSchemaEval;
+  /**
+   * Group ID
+   */
+  groupId?: string | undefined;
+};
+
+/** @internal */
+export const PipelineFunctionEval$inboundSchema: z.ZodType<
+  PipelineFunctionEval,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  filter: z.string().default("true"),
+  id: z.literal("eval"),
+  description: z.string().optional(),
+  disabled: z.boolean().optional(),
+  final: z.boolean().optional(),
+  conf: FunctionConfSchemaEval$inboundSchema,
+  groupId: z.string().optional(),
+});
+/** @internal */
+export type PipelineFunctionEval$Outbound = {
+  filter: string;
+  id: "eval";
+  description?: string | undefined;
+  disabled?: boolean | undefined;
+  final?: boolean | undefined;
+  conf: FunctionConfSchemaEval$Outbound;
+  groupId?: string | undefined;
+};
+
+/** @internal */
+export const PipelineFunctionEval$outboundSchema: z.ZodType<
+  PipelineFunctionEval$Outbound,
+  z.ZodTypeDef,
+  PipelineFunctionEval
+> = z.object({
+  filter: z.string().default("true"),
+  id: z.literal("eval"),
+  description: z.string().optional(),
+  disabled: z.boolean().optional(),
+  final: z.boolean().optional(),
+  conf: FunctionConfSchemaEval$outboundSchema,
+  groupId: z.string().optional(),
+});
+
+export function pipelineFunctionEvalToJSON(
+  pipelineFunctionEval: PipelineFunctionEval,
+): string {
+  return JSON.stringify(
+    PipelineFunctionEval$outboundSchema.parse(pipelineFunctionEval),
+  );
+}
+export function pipelineFunctionEvalFromJSON(
+  jsonString: string,
+): SafeParseResult<PipelineFunctionEval, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PipelineFunctionEval$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PipelineFunctionEval' from JSON`,
+  );
+}