cribl-control-plane 0.2.1rc7__py3-none-any.whl → 0.3.0a1__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 (179) hide show
  1. cribl_control_plane/_version.py +4 -4
  2. cribl_control_plane/errors/__init__.py +5 -8
  3. cribl_control_plane/errors/{healthserverstatus_error.py → healthstatus_error.py} +9 -10
  4. cribl_control_plane/groups_sdk.py +28 -52
  5. cribl_control_plane/health.py +16 -22
  6. cribl_control_plane/models/__init__.py +54 -217
  7. cribl_control_plane/models/appmode.py +14 -0
  8. cribl_control_plane/models/authtoken.py +1 -5
  9. cribl_control_plane/models/cacheconnection.py +0 -20
  10. cribl_control_plane/models/configgroup.py +7 -55
  11. cribl_control_plane/models/configgroupcloud.py +1 -11
  12. cribl_control_plane/models/createconfiggroupbyproductop.py +5 -17
  13. cribl_control_plane/models/createroutesappendbyidop.py +2 -2
  14. cribl_control_plane/models/createversionundoop.py +3 -3
  15. cribl_control_plane/models/cribllakedataset.py +1 -11
  16. cribl_control_plane/models/cribllakedatasetupdate.py +1 -11
  17. cribl_control_plane/models/datasetmetadata.py +1 -11
  18. cribl_control_plane/models/deleteconfiggroupbyproductandidop.py +0 -11
  19. cribl_control_plane/models/deleteoutputpqbyidop.py +2 -2
  20. cribl_control_plane/models/distributedsummary.py +0 -6
  21. cribl_control_plane/models/error.py +16 -0
  22. cribl_control_plane/models/getconfiggroupaclbyproductandidop.py +0 -20
  23. cribl_control_plane/models/getconfiggroupaclteamsbyproductandidop.py +0 -20
  24. cribl_control_plane/models/getconfiggroupbyproductandidop.py +0 -11
  25. cribl_control_plane/models/getconfiggroupconfigversionbyproductandidop.py +0 -11
  26. cribl_control_plane/models/gethealthinfoop.py +17 -0
  27. cribl_control_plane/models/getsummaryop.py +0 -11
  28. cribl_control_plane/models/hbcriblinfo.py +3 -24
  29. cribl_control_plane/models/{healthserverstatus.py → healthstatus.py} +8 -27
  30. cribl_control_plane/models/heartbeatmetadata.py +0 -3
  31. cribl_control_plane/models/input.py +78 -80
  32. cribl_control_plane/models/inputappscope.py +17 -80
  33. cribl_control_plane/models/inputazureblob.py +1 -33
  34. cribl_control_plane/models/inputcollection.py +1 -24
  35. cribl_control_plane/models/inputconfluentcloud.py +18 -195
  36. cribl_control_plane/models/inputcribl.py +1 -24
  37. cribl_control_plane/models/inputcriblhttp.py +17 -62
  38. cribl_control_plane/models/inputcribllakehttp.py +17 -62
  39. cribl_control_plane/models/inputcriblmetrics.py +1 -24
  40. cribl_control_plane/models/inputcribltcp.py +17 -62
  41. cribl_control_plane/models/inputcrowdstrike.py +1 -54
  42. cribl_control_plane/models/inputdatadogagent.py +17 -62
  43. cribl_control_plane/models/inputdatagen.py +1 -24
  44. cribl_control_plane/models/inputedgeprometheus.py +34 -147
  45. cribl_control_plane/models/inputelastic.py +27 -119
  46. cribl_control_plane/models/inputeventhub.py +1 -182
  47. cribl_control_plane/models/inputexec.py +1 -33
  48. cribl_control_plane/models/inputfile.py +3 -42
  49. cribl_control_plane/models/inputfirehose.py +17 -62
  50. cribl_control_plane/models/inputgooglepubsub.py +1 -36
  51. cribl_control_plane/models/inputgrafana.py +32 -157
  52. cribl_control_plane/models/inputhttp.py +17 -62
  53. cribl_control_plane/models/inputhttpraw.py +17 -62
  54. cribl_control_plane/models/inputjournalfiles.py +1 -24
  55. cribl_control_plane/models/inputkafka.py +17 -189
  56. cribl_control_plane/models/inputkinesis.py +1 -80
  57. cribl_control_plane/models/inputkubeevents.py +1 -24
  58. cribl_control_plane/models/inputkubelogs.py +1 -33
  59. cribl_control_plane/models/inputkubemetrics.py +1 -33
  60. cribl_control_plane/models/inputloki.py +17 -71
  61. cribl_control_plane/models/inputmetrics.py +17 -62
  62. cribl_control_plane/models/inputmodeldriventelemetry.py +17 -62
  63. cribl_control_plane/models/inputmsk.py +18 -81
  64. cribl_control_plane/models/inputnetflow.py +1 -24
  65. cribl_control_plane/models/inputoffice365mgmt.py +1 -67
  66. cribl_control_plane/models/inputoffice365msgtrace.py +1 -67
  67. cribl_control_plane/models/inputoffice365service.py +1 -67
  68. cribl_control_plane/models/inputopentelemetry.py +16 -92
  69. cribl_control_plane/models/inputprometheus.py +34 -138
  70. cribl_control_plane/models/inputprometheusrw.py +17 -71
  71. cribl_control_plane/models/inputrawudp.py +1 -24
  72. cribl_control_plane/models/inputs3.py +1 -45
  73. cribl_control_plane/models/inputs3inventory.py +1 -54
  74. cribl_control_plane/models/inputsecuritylake.py +1 -54
  75. cribl_control_plane/models/inputsnmp.py +1 -40
  76. cribl_control_plane/models/inputsplunk.py +17 -85
  77. cribl_control_plane/models/inputsplunkhec.py +16 -70
  78. cribl_control_plane/models/inputsplunksearch.py +1 -63
  79. cribl_control_plane/models/inputsqs.py +1 -56
  80. cribl_control_plane/models/inputsyslog.py +32 -121
  81. cribl_control_plane/models/inputsystemmetrics.py +9 -142
  82. cribl_control_plane/models/inputsystemstate.py +1 -33
  83. cribl_control_plane/models/inputtcp.py +17 -81
  84. cribl_control_plane/models/inputtcpjson.py +17 -71
  85. cribl_control_plane/models/inputwef.py +1 -71
  86. cribl_control_plane/models/inputwindowsmetrics.py +9 -129
  87. cribl_control_plane/models/inputwineventlogs.py +1 -60
  88. cribl_control_plane/models/inputwiz.py +1 -45
  89. cribl_control_plane/models/inputwizwebhook.py +17 -62
  90. cribl_control_plane/models/inputzscalerhec.py +16 -70
  91. cribl_control_plane/models/jobinfo.py +1 -4
  92. cribl_control_plane/models/jobstatus.py +3 -34
  93. cribl_control_plane/models/listconfiggroupbyproductop.py +0 -11
  94. cribl_control_plane/models/logininfo.py +3 -3
  95. cribl_control_plane/models/masterworkerentry.py +1 -11
  96. cribl_control_plane/models/nodeprovidedinfo.py +1 -11
  97. cribl_control_plane/models/nodeupgradestatus.py +0 -38
  98. cribl_control_plane/models/output.py +88 -93
  99. cribl_control_plane/models/outputazureblob.py +1 -110
  100. cribl_control_plane/models/outputazuredataexplorer.py +87 -452
  101. cribl_control_plane/models/outputazureeventhub.py +19 -281
  102. cribl_control_plane/models/outputazurelogs.py +19 -115
  103. cribl_control_plane/models/outputchronicle.py +19 -115
  104. cribl_control_plane/models/outputclickhouse.py +19 -155
  105. cribl_control_plane/models/outputcloudwatch.py +19 -106
  106. cribl_control_plane/models/outputconfluentcloud.py +38 -311
  107. cribl_control_plane/models/outputcriblhttp.py +19 -135
  108. cribl_control_plane/models/outputcribllake.py +1 -97
  109. cribl_control_plane/models/outputcribltcp.py +19 -132
  110. cribl_control_plane/models/outputcrowdstrikenextgensiem.py +20 -129
  111. cribl_control_plane/models/outputdatadog.py +19 -159
  112. cribl_control_plane/models/outputdataset.py +19 -143
  113. cribl_control_plane/models/outputdiskspool.py +1 -11
  114. cribl_control_plane/models/outputdls3.py +1 -152
  115. cribl_control_plane/models/outputdynatracehttp.py +19 -160
  116. cribl_control_plane/models/outputdynatraceotlp.py +19 -160
  117. cribl_control_plane/models/outputelastic.py +19 -163
  118. cribl_control_plane/models/outputelasticcloud.py +19 -140
  119. cribl_control_plane/models/outputexabeam.py +1 -61
  120. cribl_control_plane/models/outputfilesystem.py +1 -87
  121. cribl_control_plane/models/outputgooglechronicle.py +20 -166
  122. cribl_control_plane/models/outputgooglecloudlogging.py +20 -131
  123. cribl_control_plane/models/outputgooglecloudstorage.py +1 -136
  124. cribl_control_plane/models/outputgooglepubsub.py +19 -106
  125. cribl_control_plane/models/outputgrafanacloud.py +37 -288
  126. cribl_control_plane/models/outputgraphite.py +19 -105
  127. cribl_control_plane/models/outputhoneycomb.py +19 -115
  128. cribl_control_plane/models/outputhumiohec.py +19 -126
  129. cribl_control_plane/models/outputinfluxdb.py +19 -130
  130. cribl_control_plane/models/outputkafka.py +34 -302
  131. cribl_control_plane/models/outputkinesis.py +19 -133
  132. cribl_control_plane/models/outputloki.py +17 -129
  133. cribl_control_plane/models/outputminio.py +1 -145
  134. cribl_control_plane/models/outputmsk.py +34 -193
  135. cribl_control_plane/models/outputnewrelic.py +19 -136
  136. cribl_control_plane/models/outputnewrelicevents.py +20 -128
  137. cribl_control_plane/models/outputopentelemetry.py +19 -178
  138. cribl_control_plane/models/outputprometheus.py +19 -115
  139. cribl_control_plane/models/outputring.py +1 -31
  140. cribl_control_plane/models/outputs3.py +1 -152
  141. cribl_control_plane/models/outputsecuritylake.py +1 -114
  142. cribl_control_plane/models/outputsentinel.py +19 -135
  143. cribl_control_plane/models/outputsentineloneaisiem.py +20 -134
  144. cribl_control_plane/models/outputservicenow.py +19 -168
  145. cribl_control_plane/models/outputsignalfx.py +19 -115
  146. cribl_control_plane/models/outputsns.py +17 -113
  147. cribl_control_plane/models/outputsplunk.py +19 -153
  148. cribl_control_plane/models/outputsplunkhec.py +19 -208
  149. cribl_control_plane/models/outputsplunklb.py +19 -182
  150. cribl_control_plane/models/outputsqs.py +17 -124
  151. cribl_control_plane/models/outputstatsd.py +19 -105
  152. cribl_control_plane/models/outputstatsdext.py +19 -105
  153. cribl_control_plane/models/outputsumologic.py +19 -117
  154. cribl_control_plane/models/outputsyslog.py +96 -259
  155. cribl_control_plane/models/outputtcpjson.py +19 -141
  156. cribl_control_plane/models/outputwavefront.py +19 -115
  157. cribl_control_plane/models/outputwebhook.py +19 -161
  158. cribl_control_plane/models/outputxsiam.py +17 -113
  159. cribl_control_plane/models/packinfo.py +5 -8
  160. cribl_control_plane/models/packinstallinfo.py +5 -8
  161. cribl_control_plane/models/resourcepolicy.py +0 -11
  162. cribl_control_plane/models/{uploadpackresponse.py → routecloneconf.py} +4 -4
  163. cribl_control_plane/models/routeconf.py +4 -3
  164. cribl_control_plane/models/runnablejobcollection.py +9 -72
  165. cribl_control_plane/models/runnablejobexecutor.py +9 -32
  166. cribl_control_plane/models/runnablejobscheduledsearch.py +9 -23
  167. cribl_control_plane/models/updateconfiggroupbyproductandidop.py +0 -11
  168. cribl_control_plane/models/updateconfiggroupdeploybyproductandidop.py +0 -11
  169. cribl_control_plane/packs.py +7 -202
  170. cribl_control_plane/routes_sdk.py +6 -6
  171. cribl_control_plane/tokens.py +15 -23
  172. {cribl_control_plane-0.2.1rc7.dist-info → cribl_control_plane-0.3.0a1.dist-info}/METADATA +9 -50
  173. cribl_control_plane-0.3.0a1.dist-info/RECORD +330 -0
  174. cribl_control_plane/models/groupcreaterequest.py +0 -171
  175. cribl_control_plane/models/outpostnodeinfo.py +0 -16
  176. cribl_control_plane/models/outputdatabricks.py +0 -482
  177. cribl_control_plane/models/updatepacksop.py +0 -25
  178. cribl_control_plane-0.2.1rc7.dist-info/RECORD +0 -331
  179. {cribl_control_plane-0.2.1rc7.dist-info → cribl_control_plane-0.3.0a1.dist-info}/WHEEL +0 -0
@@ -1,12 +1,11 @@
1
1
  """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
2
2
 
3
3
  from __future__ import annotations
4
- from cribl_control_plane import models, utils
4
+ from cribl_control_plane import utils
5
5
  from cribl_control_plane.types import BaseModel
6
6
  from cribl_control_plane.utils import validate_open_enum
7
7
  from enum import Enum
8
8
  import pydantic
9
- from pydantic import field_serializer
10
9
  from pydantic.functional_validators import PlainValidator
11
10
  from typing import List, Optional
12
11
  from typing_extensions import Annotated, NotRequired, TypedDict
@@ -19,52 +18,40 @@ class OutputGraphiteType(str, Enum):
19
18
  class OutputGraphiteDestinationProtocol(str, Enum, metaclass=utils.OpenEnumMeta):
20
19
  r"""Protocol to use when communicating with the destination."""
21
20
 
22
- # UDP
23
21
  UDP = "udp"
24
- # TCP
25
22
  TCP = "tcp"
26
23
 
27
24
 
28
25
  class OutputGraphiteBackpressureBehavior(str, Enum, metaclass=utils.OpenEnumMeta):
29
26
  r"""How to handle events when all receivers are exerting backpressure"""
30
27
 
31
- # Block
32
28
  BLOCK = "block"
33
- # Drop
34
29
  DROP = "drop"
35
- # Persistent Queue
36
30
  QUEUE = "queue"
37
31
 
38
32
 
39
- class OutputGraphiteMode(str, Enum, metaclass=utils.OpenEnumMeta):
40
- 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."""
41
-
42
- # Error
43
- ERROR = "error"
44
- # Backpressure
45
- ALWAYS = "always"
46
- # Always On
47
- BACKPRESSURE = "backpressure"
48
-
49
-
50
33
  class OutputGraphiteCompression(str, Enum, metaclass=utils.OpenEnumMeta):
51
34
  r"""Codec to use to compress the persisted data"""
52
35
 
53
- # None
54
36
  NONE = "none"
55
- # Gzip
56
37
  GZIP = "gzip"
57
38
 
58
39
 
59
40
  class OutputGraphiteQueueFullBehavior(str, Enum, metaclass=utils.OpenEnumMeta):
60
41
  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."""
61
42
 
62
- # Block
63
43
  BLOCK = "block"
64
- # Drop new data
65
44
  DROP = "drop"
66
45
 
67
46
 
47
+ class OutputGraphiteMode(str, Enum, metaclass=utils.OpenEnumMeta):
48
+ 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."""
49
+
50
+ ERROR = "error"
51
+ BACKPRESSURE = "backpressure"
52
+ ALWAYS = "always"
53
+
54
+
68
55
  class OutputGraphitePqControlsTypedDict(TypedDict):
69
56
  pass
70
57
 
@@ -106,16 +93,6 @@ class OutputGraphiteTypedDict(TypedDict):
106
93
  r"""Amount of time (milliseconds) to wait for a write to complete before assuming connection is dead"""
107
94
  on_backpressure: NotRequired[OutputGraphiteBackpressureBehavior]
108
95
  r"""How to handle events when all receivers are exerting backpressure"""
109
- pq_strict_ordering: NotRequired[bool]
110
- r"""Use FIFO (first in, first out) processing. Disable to forward new events to receivers before queue is flushed."""
111
- pq_rate_per_sec: NotRequired[float]
112
- r"""Throttling rate (in events per second) to impose while writing to Destinations from PQ. Defaults to 0, which disables throttling."""
113
- pq_mode: NotRequired[OutputGraphiteMode]
114
- 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."""
115
- pq_max_buffer_size: NotRequired[float]
116
- r"""The maximum number of events to hold in memory before writing the events to disk"""
117
- pq_max_backpressure_sec: NotRequired[float]
118
- r"""How long (in seconds) to wait for backpressure to resolve before engaging the queue"""
119
96
  pq_max_file_size: NotRequired[str]
120
97
  r"""The maximum size to store in each queue file before closing and optionally compressing (KB, MB, etc.)"""
121
98
  pq_max_size: NotRequired[str]
@@ -126,6 +103,8 @@ class OutputGraphiteTypedDict(TypedDict):
126
103
  r"""Codec to use to compress the persisted data"""
127
104
  pq_on_backpressure: NotRequired[OutputGraphiteQueueFullBehavior]
128
105
  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."""
106
+ pq_mode: NotRequired[OutputGraphiteMode]
107
+ 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."""
129
108
  pq_controls: NotRequired[OutputGraphitePqControlsTypedDict]
130
109
 
131
110
 
@@ -200,34 +179,6 @@ class OutputGraphite(BaseModel):
200
179
  ] = OutputGraphiteBackpressureBehavior.BLOCK
201
180
  r"""How to handle events when all receivers are exerting backpressure"""
202
181
 
203
- pq_strict_ordering: Annotated[
204
- Optional[bool], pydantic.Field(alias="pqStrictOrdering")
205
- ] = True
206
- r"""Use FIFO (first in, first out) processing. Disable to forward new events to receivers before queue is flushed."""
207
-
208
- pq_rate_per_sec: Annotated[
209
- Optional[float], pydantic.Field(alias="pqRatePerSec")
210
- ] = 0
211
- r"""Throttling rate (in events per second) to impose while writing to Destinations from PQ. Defaults to 0, which disables throttling."""
212
-
213
- pq_mode: Annotated[
214
- Annotated[
215
- Optional[OutputGraphiteMode], PlainValidator(validate_open_enum(False))
216
- ],
217
- pydantic.Field(alias="pqMode"),
218
- ] = OutputGraphiteMode.ERROR
219
- 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."""
220
-
221
- pq_max_buffer_size: Annotated[
222
- Optional[float], pydantic.Field(alias="pqMaxBufferSize")
223
- ] = 42
224
- r"""The maximum number of events to hold in memory before writing the events to disk"""
225
-
226
- pq_max_backpressure_sec: Annotated[
227
- Optional[float], pydantic.Field(alias="pqMaxBackpressureSec")
228
- ] = 30
229
- r"""How long (in seconds) to wait for backpressure to resolve before engaging the queue"""
230
-
231
182
  pq_max_file_size: Annotated[
232
183
  Optional[str], pydantic.Field(alias="pqMaxFileSize")
233
184
  ] = "1 MB"
@@ -259,51 +210,14 @@ class OutputGraphite(BaseModel):
259
210
  ] = OutputGraphiteQueueFullBehavior.BLOCK
260
211
  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."""
261
212
 
213
+ pq_mode: Annotated[
214
+ Annotated[
215
+ Optional[OutputGraphiteMode], PlainValidator(validate_open_enum(False))
216
+ ],
217
+ pydantic.Field(alias="pqMode"),
218
+ ] = OutputGraphiteMode.ERROR
219
+ 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."""
220
+
262
221
  pq_controls: Annotated[
263
222
  Optional[OutputGraphitePqControls], pydantic.Field(alias="pqControls")
264
223
  ] = None
265
-
266
- @field_serializer("protocol")
267
- def serialize_protocol(self, value):
268
- if isinstance(value, str):
269
- try:
270
- return models.OutputGraphiteDestinationProtocol(value)
271
- except ValueError:
272
- return value
273
- return value
274
-
275
- @field_serializer("on_backpressure")
276
- def serialize_on_backpressure(self, value):
277
- if isinstance(value, str):
278
- try:
279
- return models.OutputGraphiteBackpressureBehavior(value)
280
- except ValueError:
281
- return value
282
- return value
283
-
284
- @field_serializer("pq_mode")
285
- def serialize_pq_mode(self, value):
286
- if isinstance(value, str):
287
- try:
288
- return models.OutputGraphiteMode(value)
289
- except ValueError:
290
- return value
291
- return value
292
-
293
- @field_serializer("pq_compress")
294
- def serialize_pq_compress(self, value):
295
- if isinstance(value, str):
296
- try:
297
- return models.OutputGraphiteCompression(value)
298
- except ValueError:
299
- return value
300
- return value
301
-
302
- @field_serializer("pq_on_backpressure")
303
- def serialize_pq_on_backpressure(self, value):
304
- if isinstance(value, str):
305
- try:
306
- return models.OutputGraphiteQueueFullBehavior(value)
307
- except ValueError:
308
- return value
309
- return value
@@ -1,12 +1,11 @@
1
1
  """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
2
2
 
3
3
  from __future__ import annotations
4
- from cribl_control_plane import models, utils
4
+ from cribl_control_plane import utils
5
5
  from cribl_control_plane.types import BaseModel
6
6
  from cribl_control_plane.utils import validate_open_enum
7
7
  from enum import Enum
8
8
  import pydantic
9
- from pydantic import field_serializer
10
9
  from pydantic.functional_validators import PlainValidator
11
10
  from typing import List, Optional
12
11
  from typing_extensions import Annotated, NotRequired, TypedDict
@@ -30,11 +29,8 @@ class OutputHoneycombExtraHTTPHeader(BaseModel):
30
29
  class OutputHoneycombFailedRequestLoggingMode(str, Enum, metaclass=utils.OpenEnumMeta):
31
30
  r"""Data to log when a request fails. All headers are redacted by default, unless listed as safe headers below."""
32
31
 
33
- # Payload
34
32
  PAYLOAD = "payload"
35
- # Payload + Headers
36
33
  PAYLOAD_AND_HEADERS = "payloadAndHeaders"
37
- # None
38
34
  NONE = "none"
39
35
 
40
36
 
@@ -95,11 +91,8 @@ class OutputHoneycombTimeoutRetrySettings(BaseModel):
95
91
  class OutputHoneycombBackpressureBehavior(str, Enum, metaclass=utils.OpenEnumMeta):
96
92
  r"""How to handle events when all receivers are exerting backpressure"""
97
93
 
98
- # Block
99
94
  BLOCK = "block"
100
- # Drop
101
95
  DROP = "drop"
102
- # Persistent Queue
103
96
  QUEUE = "queue"
104
97
 
105
98
 
@@ -110,35 +103,28 @@ class OutputHoneycombAuthenticationMethod(str, Enum, metaclass=utils.OpenEnumMet
110
103
  SECRET = "secret"
111
104
 
112
105
 
113
- class OutputHoneycombMode(str, Enum, metaclass=utils.OpenEnumMeta):
114
- 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."""
115
-
116
- # Error
117
- ERROR = "error"
118
- # Backpressure
119
- ALWAYS = "always"
120
- # Always On
121
- BACKPRESSURE = "backpressure"
122
-
123
-
124
106
  class OutputHoneycombCompression(str, Enum, metaclass=utils.OpenEnumMeta):
125
107
  r"""Codec to use to compress the persisted data"""
126
108
 
127
- # None
128
109
  NONE = "none"
129
- # Gzip
130
110
  GZIP = "gzip"
131
111
 
132
112
 
133
113
  class OutputHoneycombQueueFullBehavior(str, Enum, metaclass=utils.OpenEnumMeta):
134
114
  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."""
135
115
 
136
- # Block
137
116
  BLOCK = "block"
138
- # Drop new data
139
117
  DROP = "drop"
140
118
 
141
119
 
120
+ class OutputHoneycombMode(str, Enum, metaclass=utils.OpenEnumMeta):
121
+ 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."""
122
+
123
+ ERROR = "error"
124
+ BACKPRESSURE = "backpressure"
125
+ ALWAYS = "always"
126
+
127
+
142
128
  class OutputHoneycombPqControlsTypedDict(TypedDict):
143
129
  pass
144
130
 
@@ -198,16 +184,6 @@ class OutputHoneycombTypedDict(TypedDict):
198
184
  auth_type: NotRequired[OutputHoneycombAuthenticationMethod]
199
185
  r"""Enter API key directly, or select a stored secret"""
200
186
  description: NotRequired[str]
201
- pq_strict_ordering: NotRequired[bool]
202
- r"""Use FIFO (first in, first out) processing. Disable to forward new events to receivers before queue is flushed."""
203
- pq_rate_per_sec: NotRequired[float]
204
- r"""Throttling rate (in events per second) to impose while writing to Destinations from PQ. Defaults to 0, which disables throttling."""
205
- pq_mode: NotRequired[OutputHoneycombMode]
206
- 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."""
207
- pq_max_buffer_size: NotRequired[float]
208
- r"""The maximum number of events to hold in memory before writing the events to disk"""
209
- pq_max_backpressure_sec: NotRequired[float]
210
- r"""How long (in seconds) to wait for backpressure to resolve before engaging the queue"""
211
187
  pq_max_file_size: NotRequired[str]
212
188
  r"""The maximum size to store in each queue file before closing and optionally compressing (KB, MB, etc.)"""
213
189
  pq_max_size: NotRequired[str]
@@ -218,6 +194,8 @@ class OutputHoneycombTypedDict(TypedDict):
218
194
  r"""Codec to use to compress the persisted data"""
219
195
  pq_on_backpressure: NotRequired[OutputHoneycombQueueFullBehavior]
220
196
  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."""
197
+ pq_mode: NotRequired[OutputHoneycombMode]
198
+ 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."""
221
199
  pq_controls: NotRequired[OutputHoneycombPqControlsTypedDict]
222
200
  team: NotRequired[str]
223
201
  r"""Team API key where the dataset belongs"""
@@ -341,34 +319,6 @@ class OutputHoneycomb(BaseModel):
341
319
 
342
320
  description: Optional[str] = None
343
321
 
344
- pq_strict_ordering: Annotated[
345
- Optional[bool], pydantic.Field(alias="pqStrictOrdering")
346
- ] = True
347
- r"""Use FIFO (first in, first out) processing. Disable to forward new events to receivers before queue is flushed."""
348
-
349
- pq_rate_per_sec: Annotated[
350
- Optional[float], pydantic.Field(alias="pqRatePerSec")
351
- ] = 0
352
- r"""Throttling rate (in events per second) to impose while writing to Destinations from PQ. Defaults to 0, which disables throttling."""
353
-
354
- pq_mode: Annotated[
355
- Annotated[
356
- Optional[OutputHoneycombMode], PlainValidator(validate_open_enum(False))
357
- ],
358
- pydantic.Field(alias="pqMode"),
359
- ] = OutputHoneycombMode.ERROR
360
- 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."""
361
-
362
- pq_max_buffer_size: Annotated[
363
- Optional[float], pydantic.Field(alias="pqMaxBufferSize")
364
- ] = 42
365
- r"""The maximum number of events to hold in memory before writing the events to disk"""
366
-
367
- pq_max_backpressure_sec: Annotated[
368
- Optional[float], pydantic.Field(alias="pqMaxBackpressureSec")
369
- ] = 30
370
- r"""How long (in seconds) to wait for backpressure to resolve before engaging the queue"""
371
-
372
322
  pq_max_file_size: Annotated[
373
323
  Optional[str], pydantic.Field(alias="pqMaxFileSize")
374
324
  ] = "1 MB"
@@ -400,6 +350,14 @@ class OutputHoneycomb(BaseModel):
400
350
  ] = OutputHoneycombQueueFullBehavior.BLOCK
401
351
  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."""
402
352
 
353
+ pq_mode: Annotated[
354
+ Annotated[
355
+ Optional[OutputHoneycombMode], PlainValidator(validate_open_enum(False))
356
+ ],
357
+ pydantic.Field(alias="pqMode"),
358
+ ] = OutputHoneycombMode.ERROR
359
+ 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."""
360
+
403
361
  pq_controls: Annotated[
404
362
  Optional[OutputHoneycombPqControls], pydantic.Field(alias="pqControls")
405
363
  ] = None
@@ -409,57 +367,3 @@ class OutputHoneycomb(BaseModel):
409
367
 
410
368
  text_secret: Annotated[Optional[str], pydantic.Field(alias="textSecret")] = None
411
369
  r"""Select or create a stored text secret"""
412
-
413
- @field_serializer("failed_request_logging_mode")
414
- def serialize_failed_request_logging_mode(self, value):
415
- if isinstance(value, str):
416
- try:
417
- return models.OutputHoneycombFailedRequestLoggingMode(value)
418
- except ValueError:
419
- return value
420
- return value
421
-
422
- @field_serializer("on_backpressure")
423
- def serialize_on_backpressure(self, value):
424
- if isinstance(value, str):
425
- try:
426
- return models.OutputHoneycombBackpressureBehavior(value)
427
- except ValueError:
428
- return value
429
- return value
430
-
431
- @field_serializer("auth_type")
432
- def serialize_auth_type(self, value):
433
- if isinstance(value, str):
434
- try:
435
- return models.OutputHoneycombAuthenticationMethod(value)
436
- except ValueError:
437
- return value
438
- return value
439
-
440
- @field_serializer("pq_mode")
441
- def serialize_pq_mode(self, value):
442
- if isinstance(value, str):
443
- try:
444
- return models.OutputHoneycombMode(value)
445
- except ValueError:
446
- return value
447
- return value
448
-
449
- @field_serializer("pq_compress")
450
- def serialize_pq_compress(self, value):
451
- if isinstance(value, str):
452
- try:
453
- return models.OutputHoneycombCompression(value)
454
- except ValueError:
455
- return value
456
- return value
457
-
458
- @field_serializer("pq_on_backpressure")
459
- def serialize_pq_on_backpressure(self, value):
460
- if isinstance(value, str):
461
- try:
462
- return models.OutputHoneycombQueueFullBehavior(value)
463
- except ValueError:
464
- return value
465
- return value
@@ -1,12 +1,11 @@
1
1
  """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
2
2
 
3
3
  from __future__ import annotations
4
- from cribl_control_plane import models, utils
4
+ from cribl_control_plane import utils
5
5
  from cribl_control_plane.types import BaseModel
6
6
  from cribl_control_plane.utils import validate_open_enum
7
7
  from enum import Enum
8
8
  import pydantic
9
- from pydantic import field_serializer
10
9
  from pydantic.functional_validators import PlainValidator
11
10
  from typing import List, Optional
12
11
  from typing_extensions import Annotated, NotRequired, TypedDict
@@ -30,20 +29,15 @@ class OutputHumioHecExtraHTTPHeader(BaseModel):
30
29
  class OutputHumioHecFailedRequestLoggingMode(str, Enum, metaclass=utils.OpenEnumMeta):
31
30
  r"""Data to log when a request fails. All headers are redacted by default, unless listed as safe headers below."""
32
31
 
33
- # Payload
34
32
  PAYLOAD = "payload"
35
- # Payload + Headers
36
33
  PAYLOAD_AND_HEADERS = "payloadAndHeaders"
37
- # None
38
34
  NONE = "none"
39
35
 
40
36
 
41
37
  class OutputHumioHecRequestFormat(str, Enum, metaclass=utils.OpenEnumMeta):
42
38
  r"""When set to JSON, the event is automatically formatted with required fields before sending. When set to Raw, only the event's `_raw` value is sent."""
43
39
 
44
- # JSON
45
40
  JSON = "JSON"
46
- # Raw
47
41
  RAW = "raw"
48
42
 
49
43
 
@@ -111,43 +105,33 @@ class OutputHumioHecTimeoutRetrySettings(BaseModel):
111
105
  class OutputHumioHecBackpressureBehavior(str, Enum, metaclass=utils.OpenEnumMeta):
112
106
  r"""How to handle events when all receivers are exerting backpressure"""
113
107
 
114
- # Block
115
108
  BLOCK = "block"
116
- # Drop
117
109
  DROP = "drop"
118
- # Persistent Queue
119
110
  QUEUE = "queue"
120
111
 
121
112
 
122
- class OutputHumioHecMode(str, Enum, metaclass=utils.OpenEnumMeta):
123
- 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."""
124
-
125
- # Error
126
- ERROR = "error"
127
- # Backpressure
128
- ALWAYS = "always"
129
- # Always On
130
- BACKPRESSURE = "backpressure"
131
-
132
-
133
113
  class OutputHumioHecCompression(str, Enum, metaclass=utils.OpenEnumMeta):
134
114
  r"""Codec to use to compress the persisted data"""
135
115
 
136
- # None
137
116
  NONE = "none"
138
- # Gzip
139
117
  GZIP = "gzip"
140
118
 
141
119
 
142
120
  class OutputHumioHecQueueFullBehavior(str, Enum, metaclass=utils.OpenEnumMeta):
143
121
  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."""
144
122
 
145
- # Block
146
123
  BLOCK = "block"
147
- # Drop new data
148
124
  DROP = "drop"
149
125
 
150
126
 
127
+ class OutputHumioHecMode(str, Enum, metaclass=utils.OpenEnumMeta):
128
+ 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."""
129
+
130
+ ERROR = "error"
131
+ BACKPRESSURE = "backpressure"
132
+ ALWAYS = "always"
133
+
134
+
151
135
  class OutputHumioHecPqControlsTypedDict(TypedDict):
152
136
  pass
153
137
 
@@ -213,16 +197,6 @@ class OutputHumioHecTypedDict(TypedDict):
213
197
  r"""CrowdStrike Falcon LogScale authentication token"""
214
198
  text_secret: NotRequired[str]
215
199
  r"""Select or create a stored text secret"""
216
- pq_strict_ordering: NotRequired[bool]
217
- r"""Use FIFO (first in, first out) processing. Disable to forward new events to receivers before queue is flushed."""
218
- pq_rate_per_sec: NotRequired[float]
219
- r"""Throttling rate (in events per second) to impose while writing to Destinations from PQ. Defaults to 0, which disables throttling."""
220
- pq_mode: NotRequired[OutputHumioHecMode]
221
- 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."""
222
- pq_max_buffer_size: NotRequired[float]
223
- r"""The maximum number of events to hold in memory before writing the events to disk"""
224
- pq_max_backpressure_sec: NotRequired[float]
225
- r"""How long (in seconds) to wait for backpressure to resolve before engaging the queue"""
226
200
  pq_max_file_size: NotRequired[str]
227
201
  r"""The maximum size to store in each queue file before closing and optionally compressing (KB, MB, etc.)"""
228
202
  pq_max_size: NotRequired[str]
@@ -233,6 +207,8 @@ class OutputHumioHecTypedDict(TypedDict):
233
207
  r"""Codec to use to compress the persisted data"""
234
208
  pq_on_backpressure: NotRequired[OutputHumioHecQueueFullBehavior]
235
209
  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."""
210
+ pq_mode: NotRequired[OutputHumioHecMode]
211
+ 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."""
236
212
  pq_controls: NotRequired[OutputHumioHecPqControlsTypedDict]
237
213
 
238
214
 
@@ -367,34 +343,6 @@ class OutputHumioHec(BaseModel):
367
343
  text_secret: Annotated[Optional[str], pydantic.Field(alias="textSecret")] = None
368
344
  r"""Select or create a stored text secret"""
369
345
 
370
- pq_strict_ordering: Annotated[
371
- Optional[bool], pydantic.Field(alias="pqStrictOrdering")
372
- ] = True
373
- r"""Use FIFO (first in, first out) processing. Disable to forward new events to receivers before queue is flushed."""
374
-
375
- pq_rate_per_sec: Annotated[
376
- Optional[float], pydantic.Field(alias="pqRatePerSec")
377
- ] = 0
378
- r"""Throttling rate (in events per second) to impose while writing to Destinations from PQ. Defaults to 0, which disables throttling."""
379
-
380
- pq_mode: Annotated[
381
- Annotated[
382
- Optional[OutputHumioHecMode], PlainValidator(validate_open_enum(False))
383
- ],
384
- pydantic.Field(alias="pqMode"),
385
- ] = OutputHumioHecMode.ERROR
386
- 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."""
387
-
388
- pq_max_buffer_size: Annotated[
389
- Optional[float], pydantic.Field(alias="pqMaxBufferSize")
390
- ] = 42
391
- r"""The maximum number of events to hold in memory before writing the events to disk"""
392
-
393
- pq_max_backpressure_sec: Annotated[
394
- Optional[float], pydantic.Field(alias="pqMaxBackpressureSec")
395
- ] = 30
396
- r"""How long (in seconds) to wait for backpressure to resolve before engaging the queue"""
397
-
398
346
  pq_max_file_size: Annotated[
399
347
  Optional[str], pydantic.Field(alias="pqMaxFileSize")
400
348
  ] = "1 MB"
@@ -426,69 +374,14 @@ class OutputHumioHec(BaseModel):
426
374
  ] = OutputHumioHecQueueFullBehavior.BLOCK
427
375
  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."""
428
376
 
377
+ pq_mode: Annotated[
378
+ Annotated[
379
+ Optional[OutputHumioHecMode], PlainValidator(validate_open_enum(False))
380
+ ],
381
+ pydantic.Field(alias="pqMode"),
382
+ ] = OutputHumioHecMode.ERROR
383
+ 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."""
384
+
429
385
  pq_controls: Annotated[
430
386
  Optional[OutputHumioHecPqControls], pydantic.Field(alias="pqControls")
431
387
  ] = None
432
-
433
- @field_serializer("failed_request_logging_mode")
434
- def serialize_failed_request_logging_mode(self, value):
435
- if isinstance(value, str):
436
- try:
437
- return models.OutputHumioHecFailedRequestLoggingMode(value)
438
- except ValueError:
439
- return value
440
- return value
441
-
442
- @field_serializer("format_")
443
- def serialize_format_(self, value):
444
- if isinstance(value, str):
445
- try:
446
- return models.OutputHumioHecRequestFormat(value)
447
- except ValueError:
448
- return value
449
- return value
450
-
451
- @field_serializer("auth_type")
452
- def serialize_auth_type(self, value):
453
- if isinstance(value, str):
454
- try:
455
- return models.OutputHumioHecAuthenticationMethod(value)
456
- except ValueError:
457
- return value
458
- return value
459
-
460
- @field_serializer("on_backpressure")
461
- def serialize_on_backpressure(self, value):
462
- if isinstance(value, str):
463
- try:
464
- return models.OutputHumioHecBackpressureBehavior(value)
465
- except ValueError:
466
- return value
467
- return value
468
-
469
- @field_serializer("pq_mode")
470
- def serialize_pq_mode(self, value):
471
- if isinstance(value, str):
472
- try:
473
- return models.OutputHumioHecMode(value)
474
- except ValueError:
475
- return value
476
- return value
477
-
478
- @field_serializer("pq_compress")
479
- def serialize_pq_compress(self, value):
480
- if isinstance(value, str):
481
- try:
482
- return models.OutputHumioHecCompression(value)
483
- except ValueError:
484
- return value
485
- return value
486
-
487
- @field_serializer("pq_on_backpressure")
488
- def serialize_pq_on_backpressure(self, value):
489
- if isinstance(value, str):
490
- try:
491
- return models.OutputHumioHecQueueFullBehavior(value)
492
- except ValueError:
493
- return value
494
- return value