cribl-control-plane 0.5.0-beta.5 → 0.5.0-beta.7

package/src/models/functionconfschemagrok.ts

@@ -23,7 +23,7 @@ export type FunctionConfSchemaGrok = {
   /**
    * Field on which to perform Grok extractions
    */
-  source?: string | undefined;
+  source: string;
 };
 
 /** @internal */

package/src/models/functionconfschemahandlebars.ts

@@ -23,7 +23,7 @@ export type FunctionConfSchemaHandlebarsTemplateDefinition = {
   /**
    * Type categorization for the template (e.g., Universal, Email, Slack)
    */
-  type?: string | undefined;
+  type: string;
 };
 
 export type FunctionConfSchemaHandlebars = {
@@ -34,15 +34,15 @@ export type FunctionConfSchemaHandlebars = {
   /**
    * Field name to store the rendered template result. Defaults to _raw.
    */
-  targetField?: string | undefined;
+  targetField: string;
   /**
    * Parse the rendered template as JSON and store as an object instead of a string. Useful for building structured data like Slack blocks.
    */
-  parseJson?: boolean | undefined;
+  parseJson: boolean;
   /**
    * Remove the target field if the rendered result is empty or null.
    */
-  removeOnNull?: boolean | undefined;
+  removeOnNull: boolean;
 };
 
 /** @internal */

package/src/models/functionconfschemalakeexport.ts

@@ -19,15 +19,15 @@ export type FunctionConfSchemaLakeExport = {
   /**
    * Name of the lake
    */
-  lake?: string | undefined;
+  lake: string;
   /**
    * Tee results to search. When set to true results will be shipped instead of stats
    */
-  tee?: string | undefined;
+  tee: string;
   /**
    * How often are stats flushed in ms
    */
-  flushMs?: number | undefined;
+  flushMs: number;
   /**
    * Disables generation of intermediate stats. When true stats will be emitted only on end
    */

package/src/models/functionconfschemalookup.ts

@@ -41,7 +41,7 @@ export type FunctionConfSchemaLookup = {
   /**
    * Enable to use a disk-based lookup. This option displays only the settings relevant to disk-based mode and hides those for in-memory lookups.
    */
-  dbLookup?: boolean | undefined;
+  dbLookup: boolean;
   matchMode?: any | undefined;
   matchType?: any | undefined;
   reloadPeriodSec?: any | undefined;
@@ -56,7 +56,7 @@ export type FunctionConfSchemaLookup = {
   /**
    * Add the looked-up values to _raw, as key=value pairs
    */
-  addToEvent?: boolean | undefined;
+  addToEvent: boolean;
   ignoreCase?: any | undefined;
 };
 

package/src/models/functionconfschemamask.ts

@@ -15,11 +15,11 @@ export type FunctionConfSchemaMaskRule = {
   /**
    * A JavaScript expression or literal to replace the matching content. Capturing groups can be referenced as g1, g2, and so on, and event fields as event.<fieldName>.
    */
-  replaceExpr?: string | undefined;
+  replaceExpr: string;
   /**
    * Set to No to disable the evaluation of an individual rule
    */
-  disabled?: boolean | undefined;
+  disabled: boolean;
 };
 
 export type FunctionConfSchemaMaskFlag = {
@@ -39,7 +39,7 @@ export type FunctionConfSchemaMask = {
   /**
    * Depth to which the Mask Function will search for fields to mask
    */
-  depth?: number | undefined;
+  depth: number;
   /**
    * Fields to evaluate if one or more masking rules are matched
    */

package/src/models/functionconfschemamvexpand.ts

@@ -41,7 +41,7 @@ export type FunctionConfSchemaMvExpand = {
   /**
    * max. number of rows generated out of every source events
    */
-  rowLimit?: number | undefined;
+  rowLimit: number;
   /**
    * name of an optional index property generated into the output
    */
@@ -49,7 +49,7 @@ export type FunctionConfSchemaMvExpand = {
   /**
    * decides if bag-values are expanded to bags or arrays
    */
-  bagExpansionMode?: FunctionConfSchemaMvExpandBagExpansionMode | undefined;
+  bagExpansionMode: FunctionConfSchemaMvExpandBagExpansionMode;
 };
 
 /** @internal */

package/src/models/functionconfschemamvpull.ts

@@ -23,11 +23,11 @@ export type FunctionConfSchemaMvPull = {
   /**
    * Optionally, specify a bag as the target for K-V entries. If not specified, these entries are stored on each top-level event.
    */
-  targetBagPath?: string | null | undefined;
+  targetBagPath: string | null;
   /**
    * Toggle this on to remove each original array of data objects after extraction. If toggled off, arrays are retained.
    */
-  deleteOriginal?: boolean | undefined;
+  deleteOriginal: boolean;
 };
 
 /** @internal */

package/src/models/functionconfschemanotify.ts

@@ -69,11 +69,11 @@ export type FunctionConfSchemaNotify = {
   /**
    * Group the notification belongs to
    */
-  group?: string | undefined;
+  group: string;
   /**
    * Workspace within the deployment to send the search results to.
    */
-  notificationId?: string | undefined;
+  notificationId: string;
   /**
    * Id of the search this function is running on.
    */
@@ -97,11 +97,11 @@ export type FunctionConfSchemaNotify = {
   /**
    * How many results that match trigger the condition
    */
-  triggerCount?: number | undefined;
+  triggerCount: number;
   /**
    * Number of results to include in the notification event
    */
-  resultsLimit?: number | undefined;
+  resultsLimit: number;
   /**
    * Url of the search results
    */

package/src/models/functionconfschemapack.ts

@@ -15,7 +15,7 @@ export type FunctionConfSchemaPack = {
   /**
    * Name of the (packed) target field
    */
-  target?: string | undefined;
+  target: string;
 };
 
 /** @internal */

package/src/models/functionconfschemaredis.ts

@@ -79,12 +79,12 @@ export type FunctionConfSchemaRedis = {
   /**
    * How the Redis server is configured. Defaults to Standalone
    */
-  deploymentType?: FunctionConfSchemaRedisDeploymentType | undefined;
-  authType?: FunctionConfSchemaRedisAuthenticationMethod | undefined;
+  deploymentType: FunctionConfSchemaRedisDeploymentType;
+  authType: FunctionConfSchemaRedisAuthenticationMethod;
   /**
    * Maximum amount of time (seconds) to wait before assuming that Redis is down and passing events through. Use 0 to disable.
    */
-  maxBlockSecs?: number | undefined;
+  maxBlockSecs: number;
   /**
    * Enable client-side cache. Redundant when using Redis write operations. See more options at Settings > General > Limits > Redis Cache.
    */

package/src/models/functionconfschemaregexextract.ts

@@ -23,11 +23,11 @@ export type FunctionConfSchemaRegexExtract = {
   /**
    * Field on which to perform regex field extraction
    */
-  source?: string | undefined;
+  source: string;
   /**
    * The maximum number of times to apply regex to source field when the global flag is set, or when using _NAME_ and _VALUE_ capturing groups
    */
-  iterations?: number | undefined;
+  iterations: number;
   /**
    * JavaScript expression to format field names when _NAME_n and _VALUE_n capturing groups are used. Original field name is in global variable 'name'. Example: To append XX to all field names, use `${name}_XX` (backticks are literal). If empty, names will be sanitized using this regex: /^[_0-9]+|[^a-zA-Z0-9_]+/g. You can access other fields values via __e.<fieldName>.
    */
@@ -35,7 +35,7 @@ export type FunctionConfSchemaRegexExtract = {
   /**
    * Overwrite existing event fields with extracted values. If disabled, existing fields will be converted to an array.
    */
-  overwrite?: boolean | undefined;
+  overwrite: boolean;
 };
 
 /** @internal */

package/src/models/functionconfschemasend.ts

@@ -31,11 +31,11 @@ export type FunctionConfSchemaSend = {
   /**
    * Group within the workspace we're sending to.
    */
-  group?: string | undefined;
+  group: string;
   /**
    * Workspace within the deployment to send the search results to.
    */
-  workspace?: string | undefined;
+  workspace: string;
   /**
    * Template to build the URL to send from.
    */
@@ -47,11 +47,11 @@ export type FunctionConfSchemaSend = {
   /**
    * Tee results to search. When set to true results will be shipped instead of stats
    */
-  tee?: string | undefined;
+  tee: string;
   /**
    * How often are stats flushed in ms
    */
-  flushMs?: number | undefined;
+  flushMs: number;
   /**
    * Disables generation of intermediate stats. When true stats will be emitted only on end
    */

package/src/models/functionconfschemasensitivedatascanner.ts

@@ -15,8 +15,8 @@ export type FunctionConfSchemaSensitiveDataScannerRule = {
   /**
    * A JavaScript expression or literal to replace the matching content. Capturing groups can be referenced as g1, g2, and so on, and event fields as event.<fieldName>.
    */
-  replaceExpr?: string | undefined;
-  disabled?: boolean | undefined;
+  replaceExpr: string;
+  disabled: boolean;
 };
 
 export type FunctionConfSchemaSensitiveDataScannerFlag = {
@@ -41,8 +41,8 @@ export type FunctionConfSchemaSensitiveDataScanner = {
   /**
    * Add matching ruleset IDs to a field called "__detected"
    */
-  includeDetectedRules?: boolean | undefined;
-  backgroundDetection?: boolean | undefined;
+  includeDetectedRules: boolean;
+  backgroundDetection: boolean;
 };
 
 /** @internal */

package/src/models/functionconfschemaserde.ts

@@ -77,11 +77,11 @@ export type FunctionConfSchemaSerde = {
   /**
    * Extract creates new fields. Reserialize extracts and filters fields, and then reserializes.
    */
-  mode?: FunctionConfSchemaSerdeOperationMode | undefined;
+  mode: FunctionConfSchemaSerdeOperationMode;
   /**
    * Parser or formatter type to use
    */
-  type?: FunctionConfSchemaSerdeType | undefined;
+  type: FunctionConfSchemaSerdeType;
   delimChar?: any | undefined;
   quoteChar?: any | undefined;
   escapeChar?: any | undefined;
@@ -89,7 +89,7 @@ export type FunctionConfSchemaSerde = {
   /**
    * Field containing text to be parsed
    */
-  srcField?: string | undefined;
+  srcField: string;
   /**
    * Name of the field to add fields to. Extract mode only.
    */

package/src/models/functionconfschemaserialize.ts

@@ -49,7 +49,7 @@ export type FunctionConfSchemaSerialize = {
   /**
    * Data output format
    */
-  type?: FunctionConfSchemaSerializeType | undefined;
+  type: FunctionConfSchemaSerializeType;
   delimChar?: any | undefined;
   quoteChar?: any | undefined;
   escapeChar?: any | undefined;
@@ -65,7 +65,7 @@ export type FunctionConfSchemaSerialize = {
   /**
    * Field to serialize data to
    */
-  dstField?: string | undefined;
+  dstField: string;
 };
 
 /** @internal */

package/src/models/functionconfschemastore.ts

@@ -16,7 +16,7 @@ export type FunctionConfSchemaStore = {
   /**
    * The type of knowledge object, generated by the function (i.e., 'lookup')
    */
-  type?: string | undefined;
+  type: string;
   /**
    * Configures where and how the data should be stored
    */
@@ -32,27 +32,27 @@ export type FunctionConfSchemaStore = {
   /**
    * Character to be used as value delimiter in output
    */
-  separator?: string | undefined;
+  separator: string;
   /**
    * For existing files, an error is thrown if overwrite is false or the file is replaced if overwrite is true
    */
-  overwrite?: boolean | undefined;
+  overwrite: boolean;
   /**
    * True will compress output, false leaves it as it is and auto decides based on size
    */
-  compress?: string | undefined;
+  compress: string;
   /**
    * Tee results to the next operator
    */
-  tee?: boolean | undefined;
+  tee: boolean;
   /**
    * Limits how many events can be stored
    */
-  maxEvents?: number | undefined;
+  maxEvents: number;
   /**
    * Suppresses the timer-based export stats generating
    */
-  suppressPreviews?: boolean | undefined;
+  suppressPreviews: boolean;
 };
 
 /** @internal */

package/src/models/functionconfschemasuppress.ts

@@ -15,27 +15,27 @@ export type FunctionConfSchemaSuppress = {
   /**
    * The number of events to allow per time period
    */
-  allow?: number | undefined;
+  allow: number;
   /**
    * The number of seconds to suppress events after 'Number to allow' events are received
    */
-  suppressPeriodSec?: number | undefined;
+  suppressPeriodSec: number;
   /**
    * If disabled, suppressed events will be tagged with suppress=1 but not dropped
    */
-  dropEventsMode?: boolean | undefined;
+  dropEventsMode: boolean;
   /**
    * The maximum number of keys that can be cached before idle entries are removed. Leave at default unless you understand the implications of changing.
    */
-  maxCacheSize?: number | undefined;
+  maxCacheSize: number;
   /**
    * The number of suppression periods 'Suppression Period' of inactivity before a cache entry is considered idle. Leave at default unless you understand the implications of changing.
    */
-  cacheIdleTimeoutPeriods?: number | undefined;
+  cacheIdleTimeoutPeriods: number;
   /**
    * Check cache for idle sessions every N events when cache size is > 'Maximum Cache Size'. Leave at default unless you understand the implications of changing.
    */
-  numEventsIdleTimeoutTrigger?: number | undefined;
+  numEventsIdleTimeoutTrigger: number;
 };
 
 /** @internal */

package/src/models/functionconfschematee.ts

@@ -16,7 +16,7 @@ export type FunctionConfSchemaTee = {
   /**
    * Restart the process if it exits and/or we fail to write to it
    */
-  restartOnExit?: boolean | undefined;
+  restartOnExit: boolean;
   /**
    * Environment variables to overwrite or set
    */

package/src/models/functionconfschemaunroll.ts

@@ -11,11 +11,11 @@ export type FunctionConfSchemaUnroll = {
   /**
    * Field in which to find/calculate the array to unroll. Example: _raw, _raw.split(/\n/)
    */
-  srcExpr?: string | undefined;
+  srcExpr: string;
   /**
    * Field in destination event in which to place the unrolled value
    */
-  dstField?: string | undefined;
+  dstField: string;
 };
 
 /** @internal */

package/src/models/functionconfschemawindow.ts

@@ -19,11 +19,11 @@ export type FunctionConfSchemaWindow = {
   /**
    * Number of events to keep before the current event in the window
    */
-  tailEventCount?: number | undefined;
+  tailEventCount: number;
   /**
    * Number of events to keep after the current event in the window
    */
-  headEventCount?: number | undefined;
+  headEventCount: number;
 };
 
 /** @internal */

package/src/models/functionconfschemaxmlunroll.ts

@@ -19,11 +19,11 @@ export type FunctionConfSchemaXmlUnroll = {
   /**
    * Add a field with this name, containing the index at which the item was located, starting from 0
    */
-  unrollIdxField?: string | undefined;
+  unrollIdxField: string;
   /**
    * Pretty print the output XML
    */
-  pretty?: boolean | undefined;
+  pretty: boolean;
 };
 
 /** @internal */

package/src/models/pipeline.ts

@@ -36,7 +36,7 @@ export type PipelineConf = {
   /**
    * The output destination for events processed by this Pipeline
    */
-  output?: string | undefined;
+  output: string;
   description?: string | undefined;
   /**
    * Tags for filtering and grouping in @{product}

package/src/models/pipelinefunctioncef.ts

@@ -15,7 +15,7 @@ export type PipelineFunctionCef = {
   /**
    * Filter that selects data to be fed through this Function
    */
-  filter?: string | undefined;
+  filter: string;
   /**
    * Function ID
    */