cribl-control-plane 0.2.1rc4__py3-none-any.whl → 0.2.1rc5__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Potentially problematic release.


This version of cribl-control-plane might be problematic. Click here for more details.

Files changed (110) hide show
  1. cribl_control_plane/_version.py +3 -3
  2. cribl_control_plane/groups_sdk.py +3 -0
  3. cribl_control_plane/mappings.py +1185 -0
  4. cribl_control_plane/models/__init__.py +149 -105
  5. cribl_control_plane/models/createadminproductsmappingsactivatebyproductop.py +52 -0
  6. cribl_control_plane/models/createadminproductsmappingsbyproductop.py +53 -0
  7. cribl_control_plane/models/deleteadminproductsmappingsbyproductandidop.py +51 -0
  8. cribl_control_plane/models/getadminproductsmappingsbyproductandidop.py +51 -0
  9. cribl_control_plane/models/getadminproductsmappingsbyproductop.py +44 -0
  10. cribl_control_plane/models/input.py +14 -14
  11. cribl_control_plane/models/inputappscope.py +16 -20
  12. cribl_control_plane/models/inputconfluentcloud.py +0 -110
  13. cribl_control_plane/models/inputcriblhttp.py +16 -20
  14. cribl_control_plane/models/inputcribllakehttp.py +16 -20
  15. cribl_control_plane/models/inputcribltcp.py +16 -20
  16. cribl_control_plane/models/inputdatadogagent.py +16 -20
  17. cribl_control_plane/models/inputedgeprometheus.py +36 -44
  18. cribl_control_plane/models/inputelastic.py +27 -44
  19. cribl_control_plane/models/inputeventhub.py +0 -118
  20. cribl_control_plane/models/inputfirehose.py +16 -20
  21. cribl_control_plane/models/inputgrafana.py +31 -39
  22. cribl_control_plane/models/inputhttp.py +16 -20
  23. cribl_control_plane/models/inputhttpraw.py +16 -20
  24. cribl_control_plane/models/inputkafka.py +0 -108
  25. cribl_control_plane/models/inputloki.py +16 -20
  26. cribl_control_plane/models/inputmetrics.py +16 -20
  27. cribl_control_plane/models/inputmodeldriventelemetry.py +16 -20
  28. cribl_control_plane/models/inputopentelemetry.py +15 -19
  29. cribl_control_plane/models/inputprometheus.py +36 -44
  30. cribl_control_plane/models/inputprometheusrw.py +16 -20
  31. cribl_control_plane/models/inputsplunk.py +16 -20
  32. cribl_control_plane/models/inputsplunkhec.py +15 -19
  33. cribl_control_plane/models/inputsyslog.py +31 -39
  34. cribl_control_plane/models/inputsystemmetrics.py +10 -20
  35. cribl_control_plane/models/inputtcp.py +16 -30
  36. cribl_control_plane/models/inputtcpjson.py +16 -20
  37. cribl_control_plane/models/inputwindowsmetrics.py +10 -20
  38. cribl_control_plane/models/inputwineventlogs.py +0 -14
  39. cribl_control_plane/models/inputwizwebhook.py +16 -20
  40. cribl_control_plane/models/inputzscalerhec.py +15 -19
  41. cribl_control_plane/models/mappingruleset.py +53 -0
  42. cribl_control_plane/models/mappingrulesetevalmappingfunction.py +71 -0
  43. cribl_control_plane/models/mappingrulesetgenericmappingfunction.py +29 -0
  44. cribl_control_plane/models/output.py +22 -22
  45. cribl_control_plane/models/outputazureblob.py +0 -7
  46. cribl_control_plane/models/outputazuredataexplorer.py +93 -283
  47. cribl_control_plane/models/outputazureeventhub.py +21 -169
  48. cribl_control_plane/models/outputazurelogs.py +21 -49
  49. cribl_control_plane/models/outputchronicle.py +21 -49
  50. cribl_control_plane/models/outputclickhouse.py +21 -49
  51. cribl_control_plane/models/outputcloudwatch.py +21 -49
  52. cribl_control_plane/models/outputconfluentcloud.py +22 -167
  53. cribl_control_plane/models/outputcriblhttp.py +21 -49
  54. cribl_control_plane/models/outputcribltcp.py +21 -49
  55. cribl_control_plane/models/outputcrowdstrikenextgensiem.py +22 -50
  56. cribl_control_plane/models/outputdatabricks.py +0 -7
  57. cribl_control_plane/models/outputdatadog.py +21 -49
  58. cribl_control_plane/models/outputdataset.py +21 -49
  59. cribl_control_plane/models/outputdls3.py +0 -7
  60. cribl_control_plane/models/outputdynatracehttp.py +21 -49
  61. cribl_control_plane/models/outputdynatraceotlp.py +21 -49
  62. cribl_control_plane/models/outputelastic.py +21 -74
  63. cribl_control_plane/models/outputelasticcloud.py +21 -74
  64. cribl_control_plane/models/outputfilesystem.py +0 -7
  65. cribl_control_plane/models/outputgooglechronicle.py +22 -65
  66. cribl_control_plane/models/outputgooglecloudlogging.py +22 -50
  67. cribl_control_plane/models/outputgooglecloudstorage.py +0 -7
  68. cribl_control_plane/models/outputgooglepubsub.py +21 -49
  69. cribl_control_plane/models/outputgrafanacloud.py +42 -98
  70. cribl_control_plane/models/outputgraphite.py +21 -49
  71. cribl_control_plane/models/outputhoneycomb.py +21 -49
  72. cribl_control_plane/models/outputhumiohec.py +21 -49
  73. cribl_control_plane/models/outputinfluxdb.py +21 -49
  74. cribl_control_plane/models/outputkafka.py +19 -162
  75. cribl_control_plane/models/outputkinesis.py +21 -56
  76. cribl_control_plane/models/outputloki.py +19 -47
  77. cribl_control_plane/models/outputminio.py +0 -7
  78. cribl_control_plane/models/outputmsk.py +19 -54
  79. cribl_control_plane/models/outputnewrelic.py +21 -49
  80. cribl_control_plane/models/outputnewrelicevents.py +22 -50
  81. cribl_control_plane/models/outputopentelemetry.py +21 -49
  82. cribl_control_plane/models/outputprometheus.py +21 -49
  83. cribl_control_plane/models/outputs3.py +0 -7
  84. cribl_control_plane/models/outputsentinel.py +21 -49
  85. cribl_control_plane/models/outputsentineloneaisiem.py +22 -50
  86. cribl_control_plane/models/outputservicenow.py +21 -49
  87. cribl_control_plane/models/outputsignalfx.py +21 -49
  88. cribl_control_plane/models/outputsns.py +19 -47
  89. cribl_control_plane/models/outputsplunk.py +21 -49
  90. cribl_control_plane/models/outputsplunkhec.py +21 -49
  91. cribl_control_plane/models/outputsplunklb.py +21 -49
  92. cribl_control_plane/models/outputsqs.py +19 -47
  93. cribl_control_plane/models/outputstatsd.py +21 -49
  94. cribl_control_plane/models/outputstatsdext.py +21 -49
  95. cribl_control_plane/models/outputsumologic.py +21 -49
  96. cribl_control_plane/models/outputsyslog.py +99 -129
  97. cribl_control_plane/models/outputtcpjson.py +21 -49
  98. cribl_control_plane/models/outputwavefront.py +21 -49
  99. cribl_control_plane/models/outputwebhook.py +21 -49
  100. cribl_control_plane/models/outputxsiam.py +19 -47
  101. cribl_control_plane/models/pipeline.py +4 -4
  102. cribl_control_plane/models/rulesetid.py +13 -0
  103. cribl_control_plane/models/runnablejobcollection.py +8 -12
  104. cribl_control_plane/models/runnablejobexecutor.py +8 -12
  105. cribl_control_plane/models/runnablejobscheduledsearch.py +8 -12
  106. cribl_control_plane/models/updateadminproductsmappingsbyproductandidop.py +63 -0
  107. cribl_control_plane/pipelines.py +8 -8
  108. {cribl_control_plane-0.2.1rc4.dist-info → cribl_control_plane-0.2.1rc5.dist-info}/METADATA +11 -2
  109. {cribl_control_plane-0.2.1rc4.dist-info → cribl_control_plane-0.2.1rc5.dist-info}/RECORD +110 -99
  110. {cribl_control_plane-0.2.1rc4.dist-info → cribl_control_plane-0.2.1rc5.dist-info}/WHEEL +0 -0
@@ -113,17 +113,6 @@ class OutputPrometheusAuthenticationType(str, Enum, metaclass=utils.OpenEnumMeta
113
113
  OAUTH = "oauth"
114
114
 
115
115
 
116
- class OutputPrometheusMode(str, Enum, metaclass=utils.OpenEnumMeta):
117
- r"""In Error mode, PQ writes events to the filesystem if the Destination is unavailable. In Backpressure mode, PQ writes events to the filesystem when it detects backpressure from the Destination. In Always On mode, PQ always writes events to the filesystem."""
118
-
119
- # Error
120
- ERROR = "error"
121
- # Backpressure
122
- ALWAYS = "always"
123
- # Always On
124
- BACKPRESSURE = "backpressure"
125
-
126
-
127
116
  class OutputPrometheusCompression(str, Enum, metaclass=utils.OpenEnumMeta):
128
117
  r"""Codec to use to compress the persisted data"""
129
118
 
@@ -142,6 +131,17 @@ class OutputPrometheusQueueFullBehavior(str, Enum, metaclass=utils.OpenEnumMeta)
142
131
  DROP = "drop"
143
132
 
144
133
 
134
+ class OutputPrometheusMode(str, Enum, metaclass=utils.OpenEnumMeta):
135
+ r"""In Error mode, PQ writes events to the filesystem if the Destination is unavailable. In Backpressure mode, PQ writes events to the filesystem when it detects backpressure from the Destination. In Always On mode, PQ always writes events to the filesystem."""
136
+
137
+ # Error
138
+ ERROR = "error"
139
+ # Backpressure
140
+ BACKPRESSURE = "backpressure"
141
+ # Always On
142
+ ALWAYS = "always"
143
+
144
+
145
145
  class OutputPrometheusPqControlsTypedDict(TypedDict):
146
146
  pass
147
147
 
@@ -235,16 +235,6 @@ class OutputPrometheusTypedDict(TypedDict):
235
235
  description: NotRequired[str]
236
236
  metrics_flush_period_sec: NotRequired[float]
237
237
  r"""How frequently metrics metadata is sent out. Value cannot be smaller than the base Flush period set above."""
238
- pq_strict_ordering: NotRequired[bool]
239
- r"""Use FIFO (first in, first out) processing. Disable to forward new events to receivers before queue is flushed."""
240
- pq_rate_per_sec: NotRequired[float]
241
- r"""Throttling rate (in events per second) to impose while writing to Destinations from PQ. Defaults to 0, which disables throttling."""
242
- pq_mode: NotRequired[OutputPrometheusMode]
243
- r"""In Error mode, PQ writes events to the filesystem if the Destination is unavailable. In Backpressure mode, PQ writes events to the filesystem when it detects backpressure from the Destination. In Always On mode, PQ always writes events to the filesystem."""
244
- pq_max_buffer_size: NotRequired[float]
245
- r"""The maximum number of events to hold in memory before writing the events to disk"""
246
- pq_max_backpressure_sec: NotRequired[float]
247
- r"""How long (in seconds) to wait for backpressure to resolve before engaging the queue"""
248
238
  pq_max_file_size: NotRequired[str]
249
239
  r"""The maximum size to store in each queue file before closing and optionally compressing (KB, MB, etc.)"""
250
240
  pq_max_size: NotRequired[str]
@@ -255,6 +245,8 @@ class OutputPrometheusTypedDict(TypedDict):
255
245
  r"""Codec to use to compress the persisted data"""
256
246
  pq_on_backpressure: NotRequired[OutputPrometheusQueueFullBehavior]
257
247
  r"""How to handle events when the queue is exerting backpressure (full capacity or low disk). 'Block' is the same behavior as non-PQ blocking. 'Drop new data' throws away incoming data, while leaving the contents of the PQ unchanged."""
248
+ pq_mode: NotRequired[OutputPrometheusMode]
249
+ r"""In Error mode, PQ writes events to the filesystem if the Destination is unavailable. In Backpressure mode, PQ writes events to the filesystem when it detects backpressure from the Destination. In Always On mode, PQ always writes events to the filesystem."""
258
250
  pq_controls: NotRequired[OutputPrometheusPqControlsTypedDict]
259
251
  username: NotRequired[str]
260
252
  password: NotRequired[str]
@@ -410,34 +402,6 @@ class OutputPrometheus(BaseModel):
410
402
  ] = 60
411
403
  r"""How frequently metrics metadata is sent out. Value cannot be smaller than the base Flush period set above."""
412
404
 
413
- pq_strict_ordering: Annotated[
414
- Optional[bool], pydantic.Field(alias="pqStrictOrdering")
415
- ] = True
416
- r"""Use FIFO (first in, first out) processing. Disable to forward new events to receivers before queue is flushed."""
417
-
418
- pq_rate_per_sec: Annotated[
419
- Optional[float], pydantic.Field(alias="pqRatePerSec")
420
- ] = 0
421
- r"""Throttling rate (in events per second) to impose while writing to Destinations from PQ. Defaults to 0, which disables throttling."""
422
-
423
- pq_mode: Annotated[
424
- Annotated[
425
- Optional[OutputPrometheusMode], PlainValidator(validate_open_enum(False))
426
- ],
427
- pydantic.Field(alias="pqMode"),
428
- ] = OutputPrometheusMode.ERROR
429
- r"""In Error mode, PQ writes events to the filesystem if the Destination is unavailable. In Backpressure mode, PQ writes events to the filesystem when it detects backpressure from the Destination. In Always On mode, PQ always writes events to the filesystem."""
430
-
431
- pq_max_buffer_size: Annotated[
432
- Optional[float], pydantic.Field(alias="pqMaxBufferSize")
433
- ] = 42
434
- r"""The maximum number of events to hold in memory before writing the events to disk"""
435
-
436
- pq_max_backpressure_sec: Annotated[
437
- Optional[float], pydantic.Field(alias="pqMaxBackpressureSec")
438
- ] = 30
439
- r"""How long (in seconds) to wait for backpressure to resolve before engaging the queue"""
440
-
441
405
  pq_max_file_size: Annotated[
442
406
  Optional[str], pydantic.Field(alias="pqMaxFileSize")
443
407
  ] = "1 MB"
@@ -469,6 +433,14 @@ class OutputPrometheus(BaseModel):
469
433
  ] = OutputPrometheusQueueFullBehavior.BLOCK
470
434
  r"""How to handle events when the queue is exerting backpressure (full capacity or low disk). 'Block' is the same behavior as non-PQ blocking. 'Drop new data' throws away incoming data, while leaving the contents of the PQ unchanged."""
471
435
 
436
+ pq_mode: Annotated[
437
+ Annotated[
438
+ Optional[OutputPrometheusMode], PlainValidator(validate_open_enum(False))
439
+ ],
440
+ pydantic.Field(alias="pqMode"),
441
+ ] = OutputPrometheusMode.ERROR
442
+ r"""In Error mode, PQ writes events to the filesystem if the Destination is unavailable. In Backpressure mode, PQ writes events to the filesystem when it detects backpressure from the Destination. In Always On mode, PQ always writes events to the filesystem."""
443
+
472
444
  pq_controls: Annotated[
473
445
  Optional[OutputPrometheusPqControls], pydantic.Field(alias="pqControls")
474
446
  ] = None
@@ -254,8 +254,6 @@ class OutputS3TypedDict(TypedDict):
254
254
  r"""Compression level to apply before moving files to final destination"""
255
255
  automatic_schema: NotRequired[bool]
256
256
  r"""Automatically calculate the schema based on the events of each Parquet file generated"""
257
- parquet_schema: NotRequired[str]
258
- r"""To add a new schema, navigate to Processing > Knowledge > Parquet Schemas"""
259
257
  parquet_version: NotRequired[OutputS3ParquetVersion]
260
258
  r"""Determines which data types are supported and how they are represented"""
261
259
  parquet_data_page_version: NotRequired[OutputS3DataPageVersion]
@@ -525,11 +523,6 @@ class OutputS3(BaseModel):
525
523
  ] = False
526
524
  r"""Automatically calculate the schema based on the events of each Parquet file generated"""
527
525
 
528
- parquet_schema: Annotated[Optional[str], pydantic.Field(alias="parquetSchema")] = (
529
- None
530
- )
531
- r"""To add a new schema, navigate to Processing > Knowledge > Parquet Schemas"""
532
-
533
526
  parquet_version: Annotated[
534
527
  Annotated[
535
528
  Optional[OutputS3ParquetVersion], PlainValidator(validate_open_enum(False))
@@ -122,17 +122,6 @@ class OutputSentinelFormat(str, Enum, metaclass=utils.OpenEnumMeta):
122
122
  ADVANCED = "advanced"
123
123
 
124
124
 
125
- class OutputSentinelMode(str, Enum, metaclass=utils.OpenEnumMeta):
126
- r"""In Error mode, PQ writes events to the filesystem if the Destination is unavailable. In Backpressure mode, PQ writes events to the filesystem when it detects backpressure from the Destination. In Always On mode, PQ always writes events to the filesystem."""
127
-
128
- # Error
129
- ERROR = "error"
130
- # Backpressure
131
- ALWAYS = "always"
132
- # Always On
133
- BACKPRESSURE = "backpressure"
134
-
135
-
136
125
  class OutputSentinelCompression(str, Enum, metaclass=utils.OpenEnumMeta):
137
126
  r"""Codec to use to compress the persisted data"""
138
127
 
@@ -151,6 +140,17 @@ class OutputSentinelQueueFullBehavior(str, Enum, metaclass=utils.OpenEnumMeta):
151
140
  DROP = "drop"
152
141
 
153
142
 
143
+ class OutputSentinelMode(str, Enum, metaclass=utils.OpenEnumMeta):
144
+ r"""In Error mode, PQ writes events to the filesystem if the Destination is unavailable. In Backpressure mode, PQ writes events to the filesystem when it detects backpressure from the Destination. In Always On mode, PQ always writes events to the filesystem."""
145
+
146
+ # Error
147
+ ERROR = "error"
148
+ # Backpressure
149
+ BACKPRESSURE = "backpressure"
150
+ # Always On
151
+ ALWAYS = "always"
152
+
153
+
154
154
  class OutputSentinelPqControlsTypedDict(TypedDict):
155
155
  pass
156
156
 
@@ -238,16 +238,6 @@ class OutputSentinelTypedDict(TypedDict):
238
238
  r"""Custom JavaScript code to format incoming event data accessible through the __e variable. The formatted content is added to (__e['__eventOut']) if available. Otherwise, the original event is serialized as JSON. Caution: This function is evaluated in an unprotected context, allowing you to execute almost any JavaScript code."""
239
239
  format_payload_code: NotRequired[str]
240
240
  r"""Optional JavaScript code to format the payload sent to the Destination. The payload, containing a batch of formatted events, is accessible through the __e['payload'] variable. The formatted payload is returned in the __e['__payloadOut'] variable. Caution: This function is evaluated in an unprotected context, allowing you to execute almost any JavaScript code."""
241
- pq_strict_ordering: NotRequired[bool]
242
- r"""Use FIFO (first in, first out) processing. Disable to forward new events to receivers before queue is flushed."""
243
- pq_rate_per_sec: NotRequired[float]
244
- r"""Throttling rate (in events per second) to impose while writing to Destinations from PQ. Defaults to 0, which disables throttling."""
245
- pq_mode: NotRequired[OutputSentinelMode]
246
- r"""In Error mode, PQ writes events to the filesystem if the Destination is unavailable. In Backpressure mode, PQ writes events to the filesystem when it detects backpressure from the Destination. In Always On mode, PQ always writes events to the filesystem."""
247
- pq_max_buffer_size: NotRequired[float]
248
- r"""The maximum number of events to hold in memory before writing the events to disk"""
249
- pq_max_backpressure_sec: NotRequired[float]
250
- r"""How long (in seconds) to wait for backpressure to resolve before engaging the queue"""
251
241
  pq_max_file_size: NotRequired[str]
252
242
  r"""The maximum size to store in each queue file before closing and optionally compressing (KB, MB, etc.)"""
253
243
  pq_max_size: NotRequired[str]
@@ -258,6 +248,8 @@ class OutputSentinelTypedDict(TypedDict):
258
248
  r"""Codec to use to compress the persisted data"""
259
249
  pq_on_backpressure: NotRequired[OutputSentinelQueueFullBehavior]
260
250
  r"""How to handle events when the queue is exerting backpressure (full capacity or low disk). 'Block' is the same behavior as non-PQ blocking. 'Drop new data' throws away incoming data, while leaving the contents of the PQ unchanged."""
251
+ pq_mode: NotRequired[OutputSentinelMode]
252
+ r"""In Error mode, PQ writes events to the filesystem if the Destination is unavailable. In Backpressure mode, PQ writes events to the filesystem when it detects backpressure from the Destination. In Always On mode, PQ always writes events to the filesystem."""
261
253
  pq_controls: NotRequired[OutputSentinelPqControlsTypedDict]
262
254
  url: NotRequired[str]
263
255
  r"""URL to send events to. Can be overwritten by an event's __url field."""
@@ -453,34 +445,6 @@ class OutputSentinel(BaseModel):
453
445
  ] = None
454
446
  r"""Optional JavaScript code to format the payload sent to the Destination. The payload, containing a batch of formatted events, is accessible through the __e['payload'] variable. The formatted payload is returned in the __e['__payloadOut'] variable. Caution: This function is evaluated in an unprotected context, allowing you to execute almost any JavaScript code."""
455
447
 
456
- pq_strict_ordering: Annotated[
457
- Optional[bool], pydantic.Field(alias="pqStrictOrdering")
458
- ] = True
459
- r"""Use FIFO (first in, first out) processing. Disable to forward new events to receivers before queue is flushed."""
460
-
461
- pq_rate_per_sec: Annotated[
462
- Optional[float], pydantic.Field(alias="pqRatePerSec")
463
- ] = 0
464
- r"""Throttling rate (in events per second) to impose while writing to Destinations from PQ. Defaults to 0, which disables throttling."""
465
-
466
- pq_mode: Annotated[
467
- Annotated[
468
- Optional[OutputSentinelMode], PlainValidator(validate_open_enum(False))
469
- ],
470
- pydantic.Field(alias="pqMode"),
471
- ] = OutputSentinelMode.ERROR
472
- r"""In Error mode, PQ writes events to the filesystem if the Destination is unavailable. In Backpressure mode, PQ writes events to the filesystem when it detects backpressure from the Destination. In Always On mode, PQ always writes events to the filesystem."""
473
-
474
- pq_max_buffer_size: Annotated[
475
- Optional[float], pydantic.Field(alias="pqMaxBufferSize")
476
- ] = 42
477
- r"""The maximum number of events to hold in memory before writing the events to disk"""
478
-
479
- pq_max_backpressure_sec: Annotated[
480
- Optional[float], pydantic.Field(alias="pqMaxBackpressureSec")
481
- ] = 30
482
- r"""How long (in seconds) to wait for backpressure to resolve before engaging the queue"""
483
-
484
448
  pq_max_file_size: Annotated[
485
449
  Optional[str], pydantic.Field(alias="pqMaxFileSize")
486
450
  ] = "1 MB"
@@ -512,6 +476,14 @@ class OutputSentinel(BaseModel):
512
476
  ] = OutputSentinelQueueFullBehavior.BLOCK
513
477
  r"""How to handle events when the queue is exerting backpressure (full capacity or low disk). 'Block' is the same behavior as non-PQ blocking. 'Drop new data' throws away incoming data, while leaving the contents of the PQ unchanged."""
514
478
 
479
+ pq_mode: Annotated[
480
+ Annotated[
481
+ Optional[OutputSentinelMode], PlainValidator(validate_open_enum(False))
482
+ ],
483
+ pydantic.Field(alias="pqMode"),
484
+ ] = OutputSentinelMode.ERROR
485
+ r"""In Error mode, PQ writes events to the filesystem if the Destination is unavailable. In Backpressure mode, PQ writes events to the filesystem when it detects backpressure from the Destination. In Always On mode, PQ always writes events to the filesystem."""
486
+
515
487
  pq_controls: Annotated[
516
488
  Optional[OutputSentinelPqControls], pydantic.Field(alias="pqControls")
517
489
  ] = None
@@ -134,17 +134,6 @@ class OutputSentinelOneAiSiemBackpressureBehavior(
134
134
  QUEUE = "queue"
135
135
 
136
136
 
137
- class OutputSentinelOneAiSiemMode(str, Enum, metaclass=utils.OpenEnumMeta):
138
- r"""In Error mode, PQ writes events to the filesystem if the Destination is unavailable. In Backpressure mode, PQ writes events to the filesystem when it detects backpressure from the Destination. In Always On mode, PQ always writes events to the filesystem."""
139
-
140
- # Error
141
- ERROR = "error"
142
- # Backpressure
143
- ALWAYS = "always"
144
- # Always On
145
- BACKPRESSURE = "backpressure"
146
-
147
-
148
137
  class OutputSentinelOneAiSiemCompression(str, Enum, metaclass=utils.OpenEnumMeta):
149
138
  r"""Codec to use to compress the persisted data"""
150
139
 
@@ -163,6 +152,17 @@ class OutputSentinelOneAiSiemQueueFullBehavior(str, Enum, metaclass=utils.OpenEn
163
152
  DROP = "drop"
164
153
 
165
154
 
155
+ class OutputSentinelOneAiSiemMode(str, Enum, metaclass=utils.OpenEnumMeta):
156
+ r"""In Error mode, PQ writes events to the filesystem if the Destination is unavailable. In Backpressure mode, PQ writes events to the filesystem when it detects backpressure from the Destination. In Always On mode, PQ always writes events to the filesystem."""
157
+
158
+ # Error
159
+ ERROR = "error"
160
+ # Backpressure
161
+ BACKPRESSURE = "backpressure"
162
+ # Always On
163
+ ALWAYS = "always"
164
+
165
+
166
166
  class OutputSentinelOneAiSiemPqControlsTypedDict(TypedDict):
167
167
  pass
168
168
 
@@ -262,16 +262,6 @@ class OutputSentinelOneAiSiemTypedDict(TypedDict):
262
262
  r"""Specify the dataSource.vendorvalue to pass as a parameter to AI SIEM. This value should reflect the vendor of the data being inserted. Don't quote this value. The default is cribl."""
263
263
  event_type: NotRequired[str]
264
264
  r"""Specify the event.type value to pass as an optional parameter to AI SIEM. This value acts as a label, grouping events into meaningful categories like Process Creation, File Modification, or Network Connection. Don't quote this value. By default, this field is empty."""
265
- pq_strict_ordering: NotRequired[bool]
266
- r"""Use FIFO (first in, first out) processing. Disable to forward new events to receivers before queue is flushed."""
267
- pq_rate_per_sec: NotRequired[float]
268
- r"""Throttling rate (in events per second) to impose while writing to Destinations from PQ. Defaults to 0, which disables throttling."""
269
- pq_mode: NotRequired[OutputSentinelOneAiSiemMode]
270
- r"""In Error mode, PQ writes events to the filesystem if the Destination is unavailable. In Backpressure mode, PQ writes events to the filesystem when it detects backpressure from the Destination. In Always On mode, PQ always writes events to the filesystem."""
271
- pq_max_buffer_size: NotRequired[float]
272
- r"""The maximum number of events to hold in memory before writing the events to disk"""
273
- pq_max_backpressure_sec: NotRequired[float]
274
- r"""How long (in seconds) to wait for backpressure to resolve before engaging the queue"""
275
265
  pq_max_file_size: NotRequired[str]
276
266
  r"""The maximum size to store in each queue file before closing and optionally compressing (KB, MB, etc.)"""
277
267
  pq_max_size: NotRequired[str]
@@ -282,6 +272,8 @@ class OutputSentinelOneAiSiemTypedDict(TypedDict):
282
272
  r"""Codec to use to compress the persisted data"""
283
273
  pq_on_backpressure: NotRequired[OutputSentinelOneAiSiemQueueFullBehavior]
284
274
  r"""How to handle events when the queue is exerting backpressure (full capacity or low disk). 'Block' is the same behavior as non-PQ blocking. 'Drop new data' throws away incoming data, while leaving the contents of the PQ unchanged."""
275
+ pq_mode: NotRequired[OutputSentinelOneAiSiemMode]
276
+ r"""In Error mode, PQ writes events to the filesystem if the Destination is unavailable. In Backpressure mode, PQ writes events to the filesystem when it detects backpressure from the Destination. In Always On mode, PQ always writes events to the filesystem."""
285
277
  pq_controls: NotRequired[OutputSentinelOneAiSiemPqControlsTypedDict]
286
278
 
287
279
 
@@ -479,35 +471,6 @@ class OutputSentinelOneAiSiem(BaseModel):
479
471
  event_type: Annotated[Optional[str], pydantic.Field(alias="eventType")] = ""
480
472
  r"""Specify the event.type value to pass as an optional parameter to AI SIEM. This value acts as a label, grouping events into meaningful categories like Process Creation, File Modification, or Network Connection. Don't quote this value. By default, this field is empty."""
481
473
 
482
- pq_strict_ordering: Annotated[
483
- Optional[bool], pydantic.Field(alias="pqStrictOrdering")
484
- ] = True
485
- r"""Use FIFO (first in, first out) processing. Disable to forward new events to receivers before queue is flushed."""
486
-
487
- pq_rate_per_sec: Annotated[
488
- Optional[float], pydantic.Field(alias="pqRatePerSec")
489
- ] = 0
490
- r"""Throttling rate (in events per second) to impose while writing to Destinations from PQ. Defaults to 0, which disables throttling."""
491
-
492
- pq_mode: Annotated[
493
- Annotated[
494
- Optional[OutputSentinelOneAiSiemMode],
495
- PlainValidator(validate_open_enum(False)),
496
- ],
497
- pydantic.Field(alias="pqMode"),
498
- ] = OutputSentinelOneAiSiemMode.ERROR
499
- r"""In Error mode, PQ writes events to the filesystem if the Destination is unavailable. In Backpressure mode, PQ writes events to the filesystem when it detects backpressure from the Destination. In Always On mode, PQ always writes events to the filesystem."""
500
-
501
- pq_max_buffer_size: Annotated[
502
- Optional[float], pydantic.Field(alias="pqMaxBufferSize")
503
- ] = 42
504
- r"""The maximum number of events to hold in memory before writing the events to disk"""
505
-
506
- pq_max_backpressure_sec: Annotated[
507
- Optional[float], pydantic.Field(alias="pqMaxBackpressureSec")
508
- ] = 30
509
- r"""How long (in seconds) to wait for backpressure to resolve before engaging the queue"""
510
-
511
474
  pq_max_file_size: Annotated[
512
475
  Optional[str], pydantic.Field(alias="pqMaxFileSize")
513
476
  ] = "1 MB"
@@ -539,6 +502,15 @@ class OutputSentinelOneAiSiem(BaseModel):
539
502
  ] = OutputSentinelOneAiSiemQueueFullBehavior.BLOCK
540
503
  r"""How to handle events when the queue is exerting backpressure (full capacity or low disk). 'Block' is the same behavior as non-PQ blocking. 'Drop new data' throws away incoming data, while leaving the contents of the PQ unchanged."""
541
504
 
505
+ pq_mode: Annotated[
506
+ Annotated[
507
+ Optional[OutputSentinelOneAiSiemMode],
508
+ PlainValidator(validate_open_enum(False)),
509
+ ],
510
+ pydantic.Field(alias="pqMode"),
511
+ ] = OutputSentinelOneAiSiemMode.ERROR
512
+ r"""In Error mode, PQ writes events to the filesystem if the Destination is unavailable. In Backpressure mode, PQ writes events to the filesystem when it detects backpressure from the Destination. In Always On mode, PQ always writes events to the filesystem."""
513
+
542
514
  pq_controls: Annotated[
543
515
  Optional[OutputSentinelOneAiSiemPqControls], pydantic.Field(alias="pqControls")
544
516
  ] = None
@@ -227,17 +227,6 @@ class OutputServiceNowTLSSettingsClientSide(BaseModel):
227
227
  ] = None
228
228
 
229
229
 
230
- class OutputServiceNowMode(str, Enum, metaclass=utils.OpenEnumMeta):
231
- r"""In Error mode, PQ writes events to the filesystem if the Destination is unavailable. In Backpressure mode, PQ writes events to the filesystem when it detects backpressure from the Destination. In Always On mode, PQ always writes events to the filesystem."""
232
-
233
- # Error
234
- ERROR = "error"
235
- # Backpressure
236
- ALWAYS = "always"
237
- # Always On
238
- BACKPRESSURE = "backpressure"
239
-
240
-
241
230
  class OutputServiceNowPqCompressCompression(str, Enum, metaclass=utils.OpenEnumMeta):
242
231
  r"""Codec to use to compress the persisted data"""
243
232
 
@@ -256,6 +245,17 @@ class OutputServiceNowQueueFullBehavior(str, Enum, metaclass=utils.OpenEnumMeta)
256
245
  DROP = "drop"
257
246
 
258
247
 
248
+ class OutputServiceNowMode(str, Enum, metaclass=utils.OpenEnumMeta):
249
+ r"""In Error mode, PQ writes events to the filesystem if the Destination is unavailable. In Backpressure mode, PQ writes events to the filesystem when it detects backpressure from the Destination. In Always On mode, PQ always writes events to the filesystem."""
250
+
251
+ # Error
252
+ ERROR = "error"
253
+ # Backpressure
254
+ BACKPRESSURE = "backpressure"
255
+ # Always On
256
+ ALWAYS = "always"
257
+
258
+
259
259
  class OutputServiceNowPqControlsTypedDict(TypedDict):
260
260
  pass
261
261
 
@@ -335,16 +335,6 @@ class OutputServiceNowTypedDict(TypedDict):
335
335
  response_honor_retry_after_header: NotRequired[bool]
336
336
  r"""Honor any Retry-After header that specifies a delay (in seconds) no longer than 180 seconds after the retry request. @{product} limits the delay to 180 seconds, even if the Retry-After header specifies a longer delay. When enabled, takes precedence over user-configured retry options. When disabled, all Retry-After headers are ignored."""
337
337
  tls: NotRequired[OutputServiceNowTLSSettingsClientSideTypedDict]
338
- pq_strict_ordering: NotRequired[bool]
339
- r"""Use FIFO (first in, first out) processing. Disable to forward new events to receivers before queue is flushed."""
340
- pq_rate_per_sec: NotRequired[float]
341
- r"""Throttling rate (in events per second) to impose while writing to Destinations from PQ. Defaults to 0, which disables throttling."""
342
- pq_mode: NotRequired[OutputServiceNowMode]
343
- r"""In Error mode, PQ writes events to the filesystem if the Destination is unavailable. In Backpressure mode, PQ writes events to the filesystem when it detects backpressure from the Destination. In Always On mode, PQ always writes events to the filesystem."""
344
- pq_max_buffer_size: NotRequired[float]
345
- r"""The maximum number of events to hold in memory before writing the events to disk"""
346
- pq_max_backpressure_sec: NotRequired[float]
347
- r"""How long (in seconds) to wait for backpressure to resolve before engaging the queue"""
348
338
  pq_max_file_size: NotRequired[str]
349
339
  r"""The maximum size to store in each queue file before closing and optionally compressing (KB, MB, etc.)"""
350
340
  pq_max_size: NotRequired[str]
@@ -355,6 +345,8 @@ class OutputServiceNowTypedDict(TypedDict):
355
345
  r"""Codec to use to compress the persisted data"""
356
346
  pq_on_backpressure: NotRequired[OutputServiceNowQueueFullBehavior]
357
347
  r"""How to handle events when the queue is exerting backpressure (full capacity or low disk). 'Block' is the same behavior as non-PQ blocking. 'Drop new data' throws away incoming data, while leaving the contents of the PQ unchanged."""
348
+ pq_mode: NotRequired[OutputServiceNowMode]
349
+ r"""In Error mode, PQ writes events to the filesystem if the Destination is unavailable. In Backpressure mode, PQ writes events to the filesystem when it detects backpressure from the Destination. In Always On mode, PQ always writes events to the filesystem."""
358
350
  pq_controls: NotRequired[OutputServiceNowPqControlsTypedDict]
359
351
 
360
352
 
@@ -526,34 +518,6 @@ class OutputServiceNow(BaseModel):
526
518
 
527
519
  tls: Optional[OutputServiceNowTLSSettingsClientSide] = None
528
520
 
529
- pq_strict_ordering: Annotated[
530
- Optional[bool], pydantic.Field(alias="pqStrictOrdering")
531
- ] = True
532
- r"""Use FIFO (first in, first out) processing. Disable to forward new events to receivers before queue is flushed."""
533
-
534
- pq_rate_per_sec: Annotated[
535
- Optional[float], pydantic.Field(alias="pqRatePerSec")
536
- ] = 0
537
- r"""Throttling rate (in events per second) to impose while writing to Destinations from PQ. Defaults to 0, which disables throttling."""
538
-
539
- pq_mode: Annotated[
540
- Annotated[
541
- Optional[OutputServiceNowMode], PlainValidator(validate_open_enum(False))
542
- ],
543
- pydantic.Field(alias="pqMode"),
544
- ] = OutputServiceNowMode.ERROR
545
- r"""In Error mode, PQ writes events to the filesystem if the Destination is unavailable. In Backpressure mode, PQ writes events to the filesystem when it detects backpressure from the Destination. In Always On mode, PQ always writes events to the filesystem."""
546
-
547
- pq_max_buffer_size: Annotated[
548
- Optional[float], pydantic.Field(alias="pqMaxBufferSize")
549
- ] = 42
550
- r"""The maximum number of events to hold in memory before writing the events to disk"""
551
-
552
- pq_max_backpressure_sec: Annotated[
553
- Optional[float], pydantic.Field(alias="pqMaxBackpressureSec")
554
- ] = 30
555
- r"""How long (in seconds) to wait for backpressure to resolve before engaging the queue"""
556
-
557
521
  pq_max_file_size: Annotated[
558
522
  Optional[str], pydantic.Field(alias="pqMaxFileSize")
559
523
  ] = "1 MB"
@@ -585,6 +549,14 @@ class OutputServiceNow(BaseModel):
585
549
  ] = OutputServiceNowQueueFullBehavior.BLOCK
586
550
  r"""How to handle events when the queue is exerting backpressure (full capacity or low disk). 'Block' is the same behavior as non-PQ blocking. 'Drop new data' throws away incoming data, while leaving the contents of the PQ unchanged."""
587
551
 
552
+ pq_mode: Annotated[
553
+ Annotated[
554
+ Optional[OutputServiceNowMode], PlainValidator(validate_open_enum(False))
555
+ ],
556
+ pydantic.Field(alias="pqMode"),
557
+ ] = OutputServiceNowMode.ERROR
558
+ r"""In Error mode, PQ writes events to the filesystem if the Destination is unavailable. In Backpressure mode, PQ writes events to the filesystem when it detects backpressure from the Destination. In Always On mode, PQ always writes events to the filesystem."""
559
+
588
560
  pq_controls: Annotated[
589
561
  Optional[OutputServiceNowPqControls], pydantic.Field(alias="pqControls")
590
562
  ] = None
@@ -109,17 +109,6 @@ class OutputSignalfxBackpressureBehavior(str, Enum, metaclass=utils.OpenEnumMeta
109
109
  QUEUE = "queue"
110
110
 
111
111
 
112
- class OutputSignalfxMode(str, Enum, metaclass=utils.OpenEnumMeta):
113
- r"""In Error mode, PQ writes events to the filesystem if the Destination is unavailable. In Backpressure mode, PQ writes events to the filesystem when it detects backpressure from the Destination. In Always On mode, PQ always writes events to the filesystem."""
114
-
115
- # Error
116
- ERROR = "error"
117
- # Backpressure
118
- ALWAYS = "always"
119
- # Always On
120
- BACKPRESSURE = "backpressure"
121
-
122
-
123
112
  class OutputSignalfxCompression(str, Enum, metaclass=utils.OpenEnumMeta):
124
113
  r"""Codec to use to compress the persisted data"""
125
114
 
@@ -138,6 +127,17 @@ class OutputSignalfxQueueFullBehavior(str, Enum, metaclass=utils.OpenEnumMeta):
138
127
  DROP = "drop"
139
128
 
140
129
 
130
+ class OutputSignalfxMode(str, Enum, metaclass=utils.OpenEnumMeta):
131
+ r"""In Error mode, PQ writes events to the filesystem if the Destination is unavailable. In Backpressure mode, PQ writes events to the filesystem when it detects backpressure from the Destination. In Always On mode, PQ always writes events to the filesystem."""
132
+
133
+ # Error
134
+ ERROR = "error"
135
+ # Backpressure
136
+ BACKPRESSURE = "backpressure"
137
+ # Always On
138
+ ALWAYS = "always"
139
+
140
+
141
141
  class OutputSignalfxPqControlsTypedDict(TypedDict):
142
142
  pass
143
143
 
@@ -201,16 +201,6 @@ class OutputSignalfxTypedDict(TypedDict):
201
201
  r"""SignalFx API access token (see [here](https://docs.signalfx.com/en/latest/admin-guide/tokens.html#working-with-access-tokens))"""
202
202
  text_secret: NotRequired[str]
203
203
  r"""Select or create a stored text secret"""
204
- pq_strict_ordering: NotRequired[bool]
205
- r"""Use FIFO (first in, first out) processing. Disable to forward new events to receivers before queue is flushed."""
206
- pq_rate_per_sec: NotRequired[float]
207
- r"""Throttling rate (in events per second) to impose while writing to Destinations from PQ. Defaults to 0, which disables throttling."""
208
- pq_mode: NotRequired[OutputSignalfxMode]
209
- r"""In Error mode, PQ writes events to the filesystem if the Destination is unavailable. In Backpressure mode, PQ writes events to the filesystem when it detects backpressure from the Destination. In Always On mode, PQ always writes events to the filesystem."""
210
- pq_max_buffer_size: NotRequired[float]
211
- r"""The maximum number of events to hold in memory before writing the events to disk"""
212
- pq_max_backpressure_sec: NotRequired[float]
213
- r"""How long (in seconds) to wait for backpressure to resolve before engaging the queue"""
214
204
  pq_max_file_size: NotRequired[str]
215
205
  r"""The maximum size to store in each queue file before closing and optionally compressing (KB, MB, etc.)"""
216
206
  pq_max_size: NotRequired[str]
@@ -221,6 +211,8 @@ class OutputSignalfxTypedDict(TypedDict):
221
211
  r"""Codec to use to compress the persisted data"""
222
212
  pq_on_backpressure: NotRequired[OutputSignalfxQueueFullBehavior]
223
213
  r"""How to handle events when the queue is exerting backpressure (full capacity or low disk). 'Block' is the same behavior as non-PQ blocking. 'Drop new data' throws away incoming data, while leaving the contents of the PQ unchanged."""
214
+ pq_mode: NotRequired[OutputSignalfxMode]
215
+ r"""In Error mode, PQ writes events to the filesystem if the Destination is unavailable. In Backpressure mode, PQ writes events to the filesystem when it detects backpressure from the Destination. In Always On mode, PQ always writes events to the filesystem."""
224
216
  pq_controls: NotRequired[OutputSignalfxPqControlsTypedDict]
225
217
 
226
218
 
@@ -346,34 +338,6 @@ class OutputSignalfx(BaseModel):
346
338
  text_secret: Annotated[Optional[str], pydantic.Field(alias="textSecret")] = None
347
339
  r"""Select or create a stored text secret"""
348
340
 
349
- pq_strict_ordering: Annotated[
350
- Optional[bool], pydantic.Field(alias="pqStrictOrdering")
351
- ] = True
352
- r"""Use FIFO (first in, first out) processing. Disable to forward new events to receivers before queue is flushed."""
353
-
354
- pq_rate_per_sec: Annotated[
355
- Optional[float], pydantic.Field(alias="pqRatePerSec")
356
- ] = 0
357
- r"""Throttling rate (in events per second) to impose while writing to Destinations from PQ. Defaults to 0, which disables throttling."""
358
-
359
- pq_mode: Annotated[
360
- Annotated[
361
- Optional[OutputSignalfxMode], PlainValidator(validate_open_enum(False))
362
- ],
363
- pydantic.Field(alias="pqMode"),
364
- ] = OutputSignalfxMode.ERROR
365
- r"""In Error mode, PQ writes events to the filesystem if the Destination is unavailable. In Backpressure mode, PQ writes events to the filesystem when it detects backpressure from the Destination. In Always On mode, PQ always writes events to the filesystem."""
366
-
367
- pq_max_buffer_size: Annotated[
368
- Optional[float], pydantic.Field(alias="pqMaxBufferSize")
369
- ] = 42
370
- r"""The maximum number of events to hold in memory before writing the events to disk"""
371
-
372
- pq_max_backpressure_sec: Annotated[
373
- Optional[float], pydantic.Field(alias="pqMaxBackpressureSec")
374
- ] = 30
375
- r"""How long (in seconds) to wait for backpressure to resolve before engaging the queue"""
376
-
377
341
  pq_max_file_size: Annotated[
378
342
  Optional[str], pydantic.Field(alias="pqMaxFileSize")
379
343
  ] = "1 MB"
@@ -405,6 +369,14 @@ class OutputSignalfx(BaseModel):
405
369
  ] = OutputSignalfxQueueFullBehavior.BLOCK
406
370
  r"""How to handle events when the queue is exerting backpressure (full capacity or low disk). 'Block' is the same behavior as non-PQ blocking. 'Drop new data' throws away incoming data, while leaving the contents of the PQ unchanged."""
407
371
 
372
+ pq_mode: Annotated[
373
+ Annotated[
374
+ Optional[OutputSignalfxMode], PlainValidator(validate_open_enum(False))
375
+ ],
376
+ pydantic.Field(alias="pqMode"),
377
+ ] = OutputSignalfxMode.ERROR
378
+ r"""In Error mode, PQ writes events to the filesystem if the Destination is unavailable. In Backpressure mode, PQ writes events to the filesystem when it detects backpressure from the Destination. In Always On mode, PQ always writes events to the filesystem."""
379
+
408
380
  pq_controls: Annotated[
409
381
  Optional[OutputSignalfxPqControls], pydantic.Field(alias="pqControls")
410
382
  ] = None