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

package/src/models/functionconfschemanotificationpolicies.ts

@@ -0,0 +1,312 @@
+/*
+ * 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";
+
+/**
+ * Comparison operator
+ */
+export const Operator = {
+  Equal: "=",
+  NotEqual: "!=",
+  RegexMatch: "=~",
+  RegexNotMatch: "!~",
+} as const;
+/**
+ * Comparison operator
+ */
+export type Operator = OpenEnum<typeof Operator>;
+
+/**
+ * Value to compare against (string, number, boolean)
+ */
+export type Value = string | number | boolean;
+
+export type Condition = {
+  /**
+   * Event field name to match against
+   */
+  key: string;
+  /**
+   * Comparison operator
+   */
+  operator: Operator;
+  /**
+   * Value to compare against (string, number, boolean)
+   */
+  value: string | number | boolean;
+};
+
+export type TemplateTargetPair = {
+  /**
+   * ID of the notification template to use
+   */
+  templateId: string;
+  /**
+   * ID of the notification target (output)
+   */
+  targetId: string;
+};
+
+export type Policy = {
+  /**
+   * Unique identifier for this policy
+   */
+  id: string;
+  /**
+   * If true, this policy will be skipped during evaluation
+   */
+  disabled?: boolean | undefined;
+  /**
+   * Time to wait (in minutes) to group similar alerts before sending
+   */
+  waitToGroup?: number | undefined;
+  /**
+   * Event fields to use for grouping
+   */
+  groupByLabels?: Array<string> | undefined;
+  /**
+   * List of conditions. If ANY condition matches (OR), the policy applies. Each condition is a list of tags that must ALL match (AND).
+   */
+  conditions?: Array<Array<Condition>> | undefined;
+  /**
+   * List of targets to route to and the templates to use
+   */
+  templateTargetPairs: Array<TemplateTargetPair>;
+  /**
+   * If true, stop evaluating further policies after this one matches
+   */
+  final?: boolean | undefined;
+};
+
+export type FunctionConfSchemaNotificationPolicies = {
+  /**
+   * List of notification routing policies evaluated in order
+   */
+  policies?: Array<Policy> | undefined;
+};
+
+/** @internal */
+export const Operator$inboundSchema: z.ZodType<
+  Operator,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(Operator);
+/** @internal */
+export const Operator$outboundSchema: z.ZodType<
+  string,
+  z.ZodTypeDef,
+  Operator
+> = openEnums.outboundSchema(Operator);
+
+/** @internal */
+export const Value$inboundSchema: z.ZodType<Value, z.ZodTypeDef, unknown> = z
+  .union([z.string(), z.number(), z.boolean()]);
+/** @internal */
+export type Value$Outbound = string | number | boolean;
+
+/** @internal */
+export const Value$outboundSchema: z.ZodType<
+  Value$Outbound,
+  z.ZodTypeDef,
+  Value
+> = z.union([z.string(), z.number(), z.boolean()]);
+
+export function valueToJSON(value: Value): string {
+  return JSON.stringify(Value$outboundSchema.parse(value));
+}
+export function valueFromJSON(
+  jsonString: string,
+): SafeParseResult<Value, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Value$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Value' from JSON`,
+  );
+}
+
+/** @internal */
+export const Condition$inboundSchema: z.ZodType<
+  Condition,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  key: z.string(),
+  operator: Operator$inboundSchema,
+  value: z.union([z.string(), z.number(), z.boolean()]),
+});
+/** @internal */
+export type Condition$Outbound = {
+  key: string;
+  operator: string;
+  value: string | number | boolean;
+};
+
+/** @internal */
+export const Condition$outboundSchema: z.ZodType<
+  Condition$Outbound,
+  z.ZodTypeDef,
+  Condition
+> = z.object({
+  key: z.string(),
+  operator: Operator$outboundSchema,
+  value: z.union([z.string(), z.number(), z.boolean()]),
+});
+
+export function conditionToJSON(condition: Condition): string {
+  return JSON.stringify(Condition$outboundSchema.parse(condition));
+}
+export function conditionFromJSON(
+  jsonString: string,
+): SafeParseResult<Condition, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Condition$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Condition' from JSON`,
+  );
+}
+
+/** @internal */
+export const TemplateTargetPair$inboundSchema: z.ZodType<
+  TemplateTargetPair,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  templateId: z.string(),
+  targetId: z.string(),
+});
+/** @internal */
+export type TemplateTargetPair$Outbound = {
+  templateId: string;
+  targetId: string;
+};
+
+/** @internal */
+export const TemplateTargetPair$outboundSchema: z.ZodType<
+  TemplateTargetPair$Outbound,
+  z.ZodTypeDef,
+  TemplateTargetPair
+> = z.object({
+  templateId: z.string(),
+  targetId: z.string(),
+});
+
+export function templateTargetPairToJSON(
+  templateTargetPair: TemplateTargetPair,
+): string {
+  return JSON.stringify(
+    TemplateTargetPair$outboundSchema.parse(templateTargetPair),
+  );
+}
+export function templateTargetPairFromJSON(
+  jsonString: string,
+): SafeParseResult<TemplateTargetPair, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => TemplateTargetPair$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'TemplateTargetPair' from JSON`,
+  );
+}
+
+/** @internal */
+export const Policy$inboundSchema: z.ZodType<Policy, z.ZodTypeDef, unknown> = z
+  .object({
+    id: z.string(),
+    disabled: z.boolean().default(false),
+    waitToGroup: z.number().optional(),
+    groupByLabels: z.array(z.string()).optional(),
+    conditions: z.array(z.array(z.lazy(() => Condition$inboundSchema)))
+      .optional(),
+    templateTargetPairs: z.array(
+      z.lazy(() => TemplateTargetPair$inboundSchema),
+    ),
+    final: z.boolean().default(false),
+  });
+/** @internal */
+export type Policy$Outbound = {
+  id: string;
+  disabled: boolean;
+  waitToGroup?: number | undefined;
+  groupByLabels?: Array<string> | undefined;
+  conditions?: Array<Array<Condition$Outbound>> | undefined;
+  templateTargetPairs: Array<TemplateTargetPair$Outbound>;
+  final: boolean;
+};
+
+/** @internal */
+export const Policy$outboundSchema: z.ZodType<
+  Policy$Outbound,
+  z.ZodTypeDef,
+  Policy
+> = z.object({
+  id: z.string(),
+  disabled: z.boolean().default(false),
+  waitToGroup: z.number().optional(),
+  groupByLabels: z.array(z.string()).optional(),
+  conditions: z.array(z.array(z.lazy(() => Condition$outboundSchema)))
+    .optional(),
+  templateTargetPairs: z.array(z.lazy(() => TemplateTargetPair$outboundSchema)),
+  final: z.boolean().default(false),
+});
+
+export function policyToJSON(policy: Policy): string {
+  return JSON.stringify(Policy$outboundSchema.parse(policy));
+}
+export function policyFromJSON(
+  jsonString: string,
+): SafeParseResult<Policy, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Policy$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Policy' from JSON`,
+  );
+}
+
+/** @internal */
+export const FunctionConfSchemaNotificationPolicies$inboundSchema: z.ZodType<
+  FunctionConfSchemaNotificationPolicies,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  policies: z.array(z.lazy(() => Policy$inboundSchema)).optional(),
+});
+/** @internal */
+export type FunctionConfSchemaNotificationPolicies$Outbound = {
+  policies?: Array<Policy$Outbound> | undefined;
+};
+
+/** @internal */
+export const FunctionConfSchemaNotificationPolicies$outboundSchema: z.ZodType<
+  FunctionConfSchemaNotificationPolicies$Outbound,
+  z.ZodTypeDef,
+  FunctionConfSchemaNotificationPolicies
+> = z.object({
+  policies: z.array(z.lazy(() => Policy$outboundSchema)).optional(),
+});
+
+export function functionConfSchemaNotificationPoliciesToJSON(
+  functionConfSchemaNotificationPolicies:
+    FunctionConfSchemaNotificationPolicies,
+): string {
+  return JSON.stringify(
+    FunctionConfSchemaNotificationPolicies$outboundSchema.parse(
+      functionConfSchemaNotificationPolicies,
+    ),
+  );
+}
+export function functionConfSchemaNotificationPoliciesFromJSON(
+  jsonString: string,
+): SafeParseResult<FunctionConfSchemaNotificationPolicies, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      FunctionConfSchemaNotificationPolicies$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'FunctionConfSchemaNotificationPolicies' from JSON`,
+  );
+}

package/src/models/functionconfschemanotifications.ts

@@ -0,0 +1,44 @@
+/*
+ * 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 FunctionConfSchemaNotifications = {
+  /**
+   * Notification ID
+   */
+  id?: string | undefined;
+  /**
+   * Notification event state field name
+   */
+  field?: string | undefined;
+  /**
+   * Toggle deduplication.
+   */
+  deduplicate?: boolean | undefined;
+};
+
+/** @internal */
+export const FunctionConfSchemaNotifications$inboundSchema: z.ZodType<
+  FunctionConfSchemaNotifications,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.string().optional(),
+  field: z.string().optional(),
+  deduplicate: z.boolean().optional(),
+});
+
+export function functionConfSchemaNotificationsFromJSON(
+  jsonString: string,
+): SafeParseResult<FunctionConfSchemaNotifications, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => FunctionConfSchemaNotifications$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'FunctionConfSchemaNotifications' from JSON`,
+  );
+}

package/src/models/functionconfschemanotify.ts

@@ -0,0 +1,172 @@
+/*
+ * 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";
+
+/**
+ * Type of the trigger condition. custom applies a kusto expression over the results, and results count applies a comparison over results count
+ */
+export const FunctionConfSchemaNotifyTriggerType = {
+  /**
+   * Where
+   */
+  Custom: "custom",
+  /**
+   * Count of Results
+   */
+  ResultsCount: "resultsCount",
+} as const;
+/**
+ * Type of the trigger condition. custom applies a kusto expression over the results, and results count applies a comparison over results count
+ */
+export type FunctionConfSchemaNotifyTriggerType = OpenEnum<
+  typeof FunctionConfSchemaNotifyTriggerType
+>;
+
+/**
+ * Operation to be applied over the results count
+ */
+export const FunctionConfSchemaNotifyCountComparator = {
+  /**
+   * greater than
+   */
+  GreaterThan: ">",
+  /**
+   * less than
+   */
+  LessThan: "<",
+  /**
+   * equals
+   */
+  EqualEqualEqual: "===",
+  /**
+   * not equal to
+   */
+  NotEqualEqual: "!==",
+  /**
+   * greater than or equal to
+   */
+  GreaterThanEqual: ">=",
+  /**
+   * less than or equal to
+   */
+  LessThanEqual: "<=",
+} as const;
+/**
+ * Operation to be applied over the results count
+ */
+export type FunctionConfSchemaNotifyCountComparator = OpenEnum<
+  typeof FunctionConfSchemaNotifyCountComparator
+>;
+
+export type FunctionConfSchemaNotify = {
+  /**
+   * Group the notification belongs to
+   */
+  group?: string | undefined;
+  /**
+   * Workspace within the deployment to send the search results to.
+   */
+  notificationId?: string | undefined;
+  /**
+   * Id of the search this function is running on.
+   */
+  searchId?: string | undefined;
+  /**
+   * Id of the saved query
+   */
+  savedQueryId?: string | undefined;
+  /**
+   * Js expression that filters events, a greater than 'Trigger Count' events will trigger the notification
+   */
+  trigger?: string | undefined;
+  /**
+   * Type of the trigger condition. custom applies a kusto expression over the results, and results count applies a comparison over results count
+   */
+  triggerType?: FunctionConfSchemaNotifyTriggerType | undefined;
+  /**
+   * Operation to be applied over the results count
+   */
+  triggerComparator?: FunctionConfSchemaNotifyCountComparator | undefined;
+  /**
+   * How many results that match trigger the condition
+   */
+  triggerCount?: number | undefined;
+  /**
+   * Number of results to include in the notification event
+   */
+  resultsLimit?: number | undefined;
+  /**
+   * Url of the search results
+   */
+  searchUrl?: string | undefined;
+  /**
+   * Message content template, available fields: searchId, resultSet, savedQueryId, notificationId, searchResultsUrl
+   */
+  message?: string | undefined;
+  /**
+   * Auth token for sending notification messages
+   */
+  authToken?: string | undefined;
+  /**
+   * System messages api endpoint
+   */
+  messagesEndpoint?: string | undefined;
+  /**
+   * Current tenant id
+   */
+  tenantId?: string | undefined;
+};
+
+/** @internal */
+export const FunctionConfSchemaNotifyTriggerType$inboundSchema: z.ZodType<
+  FunctionConfSchemaNotifyTriggerType,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(FunctionConfSchemaNotifyTriggerType);
+
+/** @internal */
+export const FunctionConfSchemaNotifyCountComparator$inboundSchema: z.ZodType<
+  FunctionConfSchemaNotifyCountComparator,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(FunctionConfSchemaNotifyCountComparator);
+
+/** @internal */
+export const FunctionConfSchemaNotify$inboundSchema: z.ZodType<
+  FunctionConfSchemaNotify,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  group: z.string().default("default"),
+  notificationId: z.string().default("main"),
+  searchId: z.string().optional(),
+  savedQueryId: z.string().optional(),
+  trigger: z.string().optional(),
+  triggerType: FunctionConfSchemaNotifyTriggerType$inboundSchema.optional(),
+  triggerComparator: FunctionConfSchemaNotifyCountComparator$inboundSchema
+    .optional(),
+  triggerCount: z.number().default(0),
+  resultsLimit: z.number().default(50),
+  searchUrl: z.string().optional(),
+  message: z.string().optional(),
+  authToken: z.string().optional(),
+  messagesEndpoint: z.string().optional(),
+  tenantId: z.string().optional(),
+});
+
+export function functionConfSchemaNotifyFromJSON(
+  jsonString: string,
+): SafeParseResult<FunctionConfSchemaNotify, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => FunctionConfSchemaNotify$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'FunctionConfSchemaNotify' from JSON`,
+  );
+}

package/src/models/functionconfschemanumerify.ts

@@ -0,0 +1,109 @@
+/*
+ * 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 FunctionConfSchemaNumerifyFormat = {
+  /**
+   * None
+   */
+  None: "none",
+  /**
+   * Fix
+   */
+  Fix: "fix",
+  /**
+   * Floor
+   */
+  Floor: "floor",
+  /**
+   * Ceil
+   */
+  Ceil: "ceil",
+} as const;
+export type FunctionConfSchemaNumerifyFormat = OpenEnum<
+  typeof FunctionConfSchemaNumerifyFormat
+>;
+
+export type FunctionConfSchemaNumerify = {
+  /**
+   * Depth to which the Numerify Function will search within a nested event. Depth greater than 5 (the default) could decrease performance.
+   */
+  depth?: number | undefined;
+  /**
+   * Fields to NOT numerify. Takes precedence over 'Include expression' when set. Supports wildcards. A '!' before field name(s) means: numerify all fields EXCEPT these. For syntax details, see [Wildcard Lists](https://docs.cribl.io/stream/introduction-reference/#wildcard-lists).
+   */
+  ignoreFields?: Array<string> | undefined;
+  /**
+   * Optional JavaScript expression to determine whether a field should be numerified. If left blank, all fields will be numerified. Use the 'name' and 'value' global variables to access fields' names/values. Examples: `value != null`, `name=='fieldname'`. You can access other fields' values via `__e.<fieldName>`.
+   */
+  filterExpr?: string | undefined;
+  format?: FunctionConfSchemaNumerifyFormat | undefined;
+};
+
+/** @internal */
+export const FunctionConfSchemaNumerifyFormat$inboundSchema: z.ZodType<
+  FunctionConfSchemaNumerifyFormat,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(FunctionConfSchemaNumerifyFormat);
+/** @internal */
+export const FunctionConfSchemaNumerifyFormat$outboundSchema: z.ZodType<
+  string,
+  z.ZodTypeDef,
+  FunctionConfSchemaNumerifyFormat
+> = openEnums.outboundSchema(FunctionConfSchemaNumerifyFormat);
+
+/** @internal */
+export const FunctionConfSchemaNumerify$inboundSchema: z.ZodType<
+  FunctionConfSchemaNumerify,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  depth: z.number().int().default(5),
+  ignoreFields: z.array(z.string()).optional(),
+  filterExpr: z.string().optional(),
+  format: FunctionConfSchemaNumerifyFormat$inboundSchema.default("none"),
+});
+/** @internal */
+export type FunctionConfSchemaNumerify$Outbound = {
+  depth: number;
+  ignoreFields?: Array<string> | undefined;
+  filterExpr?: string | undefined;
+  format: string;
+};
+
+/** @internal */
+export const FunctionConfSchemaNumerify$outboundSchema: z.ZodType<
+  FunctionConfSchemaNumerify$Outbound,
+  z.ZodTypeDef,
+  FunctionConfSchemaNumerify
+> = z.object({
+  depth: z.number().int().default(5),
+  ignoreFields: z.array(z.string()).optional(),
+  filterExpr: z.string().optional(),
+  format: FunctionConfSchemaNumerifyFormat$outboundSchema.default("none"),
+});
+
+export function functionConfSchemaNumerifyToJSON(
+  functionConfSchemaNumerify: FunctionConfSchemaNumerify,
+): string {
+  return JSON.stringify(
+    FunctionConfSchemaNumerify$outboundSchema.parse(functionConfSchemaNumerify),
+  );
+}
+export function functionConfSchemaNumerifyFromJSON(
+  jsonString: string,
+): SafeParseResult<FunctionConfSchemaNumerify, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => FunctionConfSchemaNumerify$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'FunctionConfSchemaNumerify' from JSON`,
+  );
+}

package/src/models/functionconfschemaotlplogs.ts

@@ -0,0 +1,58 @@
+/*
+ * 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 FunctionConfSchemaOtlpLogs = {
+  dropNonLogEvents?: boolean | undefined;
+  /**
+   * Batch OTLP log records by shared top-level `resource` attributes
+   */
+  batchOTLPLogs?: boolean | undefined;
+};
+
+/** @internal */
+export const FunctionConfSchemaOtlpLogs$inboundSchema: z.ZodType<
+  FunctionConfSchemaOtlpLogs,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  dropNonLogEvents: z.boolean().default(false),
+  batchOTLPLogs: z.boolean().default(false),
+});
+/** @internal */
+export type FunctionConfSchemaOtlpLogs$Outbound = {
+  dropNonLogEvents: boolean;
+  batchOTLPLogs: boolean;
+};
+
+/** @internal */
+export const FunctionConfSchemaOtlpLogs$outboundSchema: z.ZodType<
+  FunctionConfSchemaOtlpLogs$Outbound,
+  z.ZodTypeDef,
+  FunctionConfSchemaOtlpLogs
+> = z.object({
+  dropNonLogEvents: z.boolean().default(false),
+  batchOTLPLogs: z.boolean().default(false),
+});
+
+export function functionConfSchemaOtlpLogsToJSON(
+  functionConfSchemaOtlpLogs: FunctionConfSchemaOtlpLogs,
+): string {
+  return JSON.stringify(
+    FunctionConfSchemaOtlpLogs$outboundSchema.parse(functionConfSchemaOtlpLogs),
+  );
+}
+export function functionConfSchemaOtlpLogsFromJSON(
+  jsonString: string,
+): SafeParseResult<FunctionConfSchemaOtlpLogs, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => FunctionConfSchemaOtlpLogs$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'FunctionConfSchemaOtlpLogs' from JSON`,
+  );
+}