cribl-control-plane 0.0.13__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 (197) hide show
  1. cribl_control_plane/__init__.py +17 -0
  2. cribl_control_plane/_hooks/__init__.py +5 -0
  3. cribl_control_plane/_hooks/clientcredentials.py +211 -0
  4. cribl_control_plane/_hooks/registration.py +13 -0
  5. cribl_control_plane/_hooks/sdkhooks.py +81 -0
  6. cribl_control_plane/_hooks/types.py +112 -0
  7. cribl_control_plane/_version.py +15 -0
  8. cribl_control_plane/auth_sdk.py +184 -0
  9. cribl_control_plane/basesdk.py +358 -0
  10. cribl_control_plane/errors/__init__.py +60 -0
  11. cribl_control_plane/errors/apierror.py +38 -0
  12. cribl_control_plane/errors/criblcontrolplaneerror.py +26 -0
  13. cribl_control_plane/errors/error.py +24 -0
  14. cribl_control_plane/errors/healthstatus_error.py +38 -0
  15. cribl_control_plane/errors/no_response_error.py +13 -0
  16. cribl_control_plane/errors/responsevalidationerror.py +25 -0
  17. cribl_control_plane/health.py +166 -0
  18. cribl_control_plane/httpclient.py +126 -0
  19. cribl_control_plane/models/__init__.py +7305 -0
  20. cribl_control_plane/models/addhectokenrequest.py +34 -0
  21. cribl_control_plane/models/authtoken.py +13 -0
  22. cribl_control_plane/models/createinputhectokenbyidop.py +45 -0
  23. cribl_control_plane/models/createinputop.py +24 -0
  24. cribl_control_plane/models/createoutputop.py +24 -0
  25. cribl_control_plane/models/createoutputtestbyidop.py +46 -0
  26. cribl_control_plane/models/criblevent.py +14 -0
  27. cribl_control_plane/models/deleteinputbyidop.py +37 -0
  28. cribl_control_plane/models/deleteoutputbyidop.py +37 -0
  29. cribl_control_plane/models/deleteoutputpqbyidop.py +36 -0
  30. cribl_control_plane/models/getinputbyidop.py +37 -0
  31. cribl_control_plane/models/getoutputbyidop.py +37 -0
  32. cribl_control_plane/models/getoutputpqbyidop.py +36 -0
  33. cribl_control_plane/models/getoutputsamplesbyidop.py +37 -0
  34. cribl_control_plane/models/healthstatus.py +36 -0
  35. cribl_control_plane/models/input.py +199 -0
  36. cribl_control_plane/models/inputappscope.py +448 -0
  37. cribl_control_plane/models/inputazureblob.py +308 -0
  38. cribl_control_plane/models/inputcollection.py +208 -0
  39. cribl_control_plane/models/inputconfluentcloud.py +585 -0
  40. cribl_control_plane/models/inputcribl.py +165 -0
  41. cribl_control_plane/models/inputcriblhttp.py +341 -0
  42. cribl_control_plane/models/inputcribllakehttp.py +342 -0
  43. cribl_control_plane/models/inputcriblmetrics.py +175 -0
  44. cribl_control_plane/models/inputcribltcp.py +299 -0
  45. cribl_control_plane/models/inputcrowdstrike.py +410 -0
  46. cribl_control_plane/models/inputdatadogagent.py +364 -0
  47. cribl_control_plane/models/inputdatagen.py +180 -0
  48. cribl_control_plane/models/inputedgeprometheus.py +551 -0
  49. cribl_control_plane/models/inputelastic.py +494 -0
  50. cribl_control_plane/models/inputeventhub.py +360 -0
  51. cribl_control_plane/models/inputexec.py +213 -0
  52. cribl_control_plane/models/inputfile.py +259 -0
  53. cribl_control_plane/models/inputfirehose.py +341 -0
  54. cribl_control_plane/models/inputgooglepubsub.py +247 -0
  55. cribl_control_plane/models/inputgrafana_union.py +1247 -0
  56. cribl_control_plane/models/inputhttp.py +403 -0
  57. cribl_control_plane/models/inputhttpraw.py +407 -0
  58. cribl_control_plane/models/inputjournalfiles.py +208 -0
  59. cribl_control_plane/models/inputkafka.py +581 -0
  60. cribl_control_plane/models/inputkinesis.py +363 -0
  61. cribl_control_plane/models/inputkubeevents.py +182 -0
  62. cribl_control_plane/models/inputkubelogs.py +256 -0
  63. cribl_control_plane/models/inputkubemetrics.py +233 -0
  64. cribl_control_plane/models/inputloki.py +468 -0
  65. cribl_control_plane/models/inputmetrics.py +290 -0
  66. cribl_control_plane/models/inputmodeldriventelemetry.py +274 -0
  67. cribl_control_plane/models/inputmsk.py +654 -0
  68. cribl_control_plane/models/inputnetflow.py +224 -0
  69. cribl_control_plane/models/inputoffice365mgmt.py +384 -0
  70. cribl_control_plane/models/inputoffice365msgtrace.py +449 -0
  71. cribl_control_plane/models/inputoffice365service.py +377 -0
  72. cribl_control_plane/models/inputopentelemetry.py +516 -0
  73. cribl_control_plane/models/inputprometheus.py +464 -0
  74. cribl_control_plane/models/inputprometheusrw.py +470 -0
  75. cribl_control_plane/models/inputrawudp.py +207 -0
  76. cribl_control_plane/models/inputs3.py +416 -0
  77. cribl_control_plane/models/inputs3inventory.py +440 -0
  78. cribl_control_plane/models/inputsecuritylake.py +425 -0
  79. cribl_control_plane/models/inputsnmp.py +274 -0
  80. cribl_control_plane/models/inputsplunk.py +387 -0
  81. cribl_control_plane/models/inputsplunkhec.py +478 -0
  82. cribl_control_plane/models/inputsplunksearch.py +537 -0
  83. cribl_control_plane/models/inputsqs.py +320 -0
  84. cribl_control_plane/models/inputsyslog_union.py +759 -0
  85. cribl_control_plane/models/inputsystemmetrics.py +533 -0
  86. cribl_control_plane/models/inputsystemstate.py +417 -0
  87. cribl_control_plane/models/inputtcp.py +359 -0
  88. cribl_control_plane/models/inputtcpjson.py +334 -0
  89. cribl_control_plane/models/inputwef.py +498 -0
  90. cribl_control_plane/models/inputwindowsmetrics.py +457 -0
  91. cribl_control_plane/models/inputwineventlogs.py +222 -0
  92. cribl_control_plane/models/inputwiz.py +334 -0
  93. cribl_control_plane/models/inputzscalerhec.py +439 -0
  94. cribl_control_plane/models/listinputop.py +24 -0
  95. cribl_control_plane/models/listoutputop.py +24 -0
  96. cribl_control_plane/models/logininfo.py +16 -0
  97. cribl_control_plane/models/output.py +229 -0
  98. cribl_control_plane/models/outputazureblob.py +471 -0
  99. cribl_control_plane/models/outputazuredataexplorer.py +660 -0
  100. cribl_control_plane/models/outputazureeventhub.py +321 -0
  101. cribl_control_plane/models/outputazurelogs.py +386 -0
  102. cribl_control_plane/models/outputclickhouse.py +650 -0
  103. cribl_control_plane/models/outputcloudwatch.py +273 -0
  104. cribl_control_plane/models/outputconfluentcloud.py +591 -0
  105. cribl_control_plane/models/outputcriblhttp.py +494 -0
  106. cribl_control_plane/models/outputcribllake.py +396 -0
  107. cribl_control_plane/models/outputcribltcp.py +387 -0
  108. cribl_control_plane/models/outputcrowdstrikenextgensiem.py +410 -0
  109. cribl_control_plane/models/outputdatadog.py +472 -0
  110. cribl_control_plane/models/outputdataset.py +437 -0
  111. cribl_control_plane/models/outputdefault.py +55 -0
  112. cribl_control_plane/models/outputdevnull.py +50 -0
  113. cribl_control_plane/models/outputdiskspool.py +89 -0
  114. cribl_control_plane/models/outputdls3.py +560 -0
  115. cribl_control_plane/models/outputdynatracehttp.py +454 -0
  116. cribl_control_plane/models/outputdynatraceotlp.py +486 -0
  117. cribl_control_plane/models/outputelastic.py +494 -0
  118. cribl_control_plane/models/outputelasticcloud.py +407 -0
  119. cribl_control_plane/models/outputexabeam.py +297 -0
  120. cribl_control_plane/models/outputfilesystem.py +357 -0
  121. cribl_control_plane/models/outputgooglechronicle.py +486 -0
  122. cribl_control_plane/models/outputgooglecloudlogging.py +557 -0
  123. cribl_control_plane/models/outputgooglecloudstorage.py +499 -0
  124. cribl_control_plane/models/outputgooglepubsub.py +274 -0
  125. cribl_control_plane/models/outputgrafanacloud_union.py +1024 -0
  126. cribl_control_plane/models/outputgraphite.py +225 -0
  127. cribl_control_plane/models/outputhoneycomb.py +369 -0
  128. cribl_control_plane/models/outputhumiohec.py +389 -0
  129. cribl_control_plane/models/outputinfluxdb.py +523 -0
  130. cribl_control_plane/models/outputkafka.py +581 -0
  131. cribl_control_plane/models/outputkinesis.py +312 -0
  132. cribl_control_plane/models/outputloki.py +425 -0
  133. cribl_control_plane/models/outputminio.py +512 -0
  134. cribl_control_plane/models/outputmsk.py +654 -0
  135. cribl_control_plane/models/outputnetflow.py +80 -0
  136. cribl_control_plane/models/outputnewrelic.py +424 -0
  137. cribl_control_plane/models/outputnewrelicevents.py +401 -0
  138. cribl_control_plane/models/outputopentelemetry.py +669 -0
  139. cribl_control_plane/models/outputprometheus.py +485 -0
  140. cribl_control_plane/models/outputring.py +121 -0
  141. cribl_control_plane/models/outputrouter.py +83 -0
  142. cribl_control_plane/models/outputs3.py +556 -0
  143. cribl_control_plane/models/outputsamplesresponse.py +14 -0
  144. cribl_control_plane/models/outputsecuritylake.py +505 -0
  145. cribl_control_plane/models/outputsentinel.py +488 -0
  146. cribl_control_plane/models/outputsentineloneaisiem.py +505 -0
  147. cribl_control_plane/models/outputservicenow.py +543 -0
  148. cribl_control_plane/models/outputsignalfx.py +369 -0
  149. cribl_control_plane/models/outputsnmp.py +80 -0
  150. cribl_control_plane/models/outputsns.py +274 -0
  151. cribl_control_plane/models/outputsplunk.py +383 -0
  152. cribl_control_plane/models/outputsplunkhec.py +434 -0
  153. cribl_control_plane/models/outputsplunklb.py +558 -0
  154. cribl_control_plane/models/outputsqs.py +328 -0
  155. cribl_control_plane/models/outputstatsd.py +224 -0
  156. cribl_control_plane/models/outputstatsdext.py +225 -0
  157. cribl_control_plane/models/outputsumologic.py +378 -0
  158. cribl_control_plane/models/outputsyslog.py +415 -0
  159. cribl_control_plane/models/outputtcpjson.py +413 -0
  160. cribl_control_plane/models/outputtestrequest.py +15 -0
  161. cribl_control_plane/models/outputtestresponse.py +29 -0
  162. cribl_control_plane/models/outputwavefront.py +369 -0
  163. cribl_control_plane/models/outputwebhook.py +689 -0
  164. cribl_control_plane/models/outputxsiam.py +415 -0
  165. cribl_control_plane/models/schemeclientoauth.py +24 -0
  166. cribl_control_plane/models/security.py +36 -0
  167. cribl_control_plane/models/updatehectokenrequest.py +31 -0
  168. cribl_control_plane/models/updateinputbyidop.py +44 -0
  169. cribl_control_plane/models/updateinputhectokenbyidandtokenop.py +52 -0
  170. cribl_control_plane/models/updateoutputbyidop.py +44 -0
  171. cribl_control_plane/outputs.py +1615 -0
  172. cribl_control_plane/py.typed +1 -0
  173. cribl_control_plane/sdk.py +164 -0
  174. cribl_control_plane/sdkconfiguration.py +36 -0
  175. cribl_control_plane/sources.py +1355 -0
  176. cribl_control_plane/types/__init__.py +21 -0
  177. cribl_control_plane/types/basemodel.py +39 -0
  178. cribl_control_plane/utils/__init__.py +187 -0
  179. cribl_control_plane/utils/annotations.py +55 -0
  180. cribl_control_plane/utils/datetimes.py +23 -0
  181. cribl_control_plane/utils/enums.py +74 -0
  182. cribl_control_plane/utils/eventstreaming.py +238 -0
  183. cribl_control_plane/utils/forms.py +223 -0
  184. cribl_control_plane/utils/headers.py +136 -0
  185. cribl_control_plane/utils/logger.py +27 -0
  186. cribl_control_plane/utils/metadata.py +118 -0
  187. cribl_control_plane/utils/queryparams.py +205 -0
  188. cribl_control_plane/utils/requestbodies.py +66 -0
  189. cribl_control_plane/utils/retries.py +217 -0
  190. cribl_control_plane/utils/security.py +207 -0
  191. cribl_control_plane/utils/serializers.py +249 -0
  192. cribl_control_plane/utils/unmarshal_json_response.py +24 -0
  193. cribl_control_plane/utils/url.py +155 -0
  194. cribl_control_plane/utils/values.py +137 -0
  195. cribl_control_plane-0.0.13.dist-info/METADATA +489 -0
  196. cribl_control_plane-0.0.13.dist-info/RECORD +197 -0
  197. cribl_control_plane-0.0.13.dist-info/WHEEL +4 -0
@@ -0,0 +1,224 @@
1
+ """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
2
+
3
+ from __future__ import annotations
4
+ from cribl_control_plane import utils
5
+ from cribl_control_plane.types import BaseModel
6
+ from cribl_control_plane.utils import validate_open_enum
7
+ from enum import Enum
8
+ import pydantic
9
+ from pydantic.functional_validators import PlainValidator
10
+ from typing import List, Optional
11
+ from typing_extensions import Annotated, NotRequired, TypedDict
12
+
13
+
14
+ class InputNetflowType(str, Enum, metaclass=utils.OpenEnumMeta):
15
+ NETFLOW = "netflow"
16
+
17
+
18
+ class InputNetflowConnectionTypedDict(TypedDict):
19
+ output: str
20
+ pipeline: NotRequired[str]
21
+
22
+
23
+ class InputNetflowConnection(BaseModel):
24
+ output: str
25
+
26
+ pipeline: Optional[str] = None
27
+
28
+
29
+ class InputNetflowMode(str, Enum, metaclass=utils.OpenEnumMeta):
30
+ r"""With Smart mode, PQ will write events to the filesystem only when it detects backpressure from the processing engine. With Always On mode, PQ will always write events directly to the queue before forwarding them to the processing engine."""
31
+
32
+ SMART = "smart"
33
+ ALWAYS = "always"
34
+
35
+
36
+ class InputNetflowCompression(str, Enum, metaclass=utils.OpenEnumMeta):
37
+ r"""Codec to use to compress the persisted data"""
38
+
39
+ NONE = "none"
40
+ GZIP = "gzip"
41
+
42
+
43
+ class InputNetflowPqTypedDict(TypedDict):
44
+ mode: NotRequired[InputNetflowMode]
45
+ r"""With Smart mode, PQ will write events to the filesystem only when it detects backpressure from the processing engine. With Always On mode, PQ will always write events directly to the queue before forwarding them to the processing engine."""
46
+ max_buffer_size: NotRequired[float]
47
+ r"""The maximum number of events to hold in memory before writing the events to disk"""
48
+ commit_frequency: NotRequired[float]
49
+ r"""The number of events to send downstream before committing that Stream has read them"""
50
+ max_file_size: NotRequired[str]
51
+ r"""The maximum size to store in each queue file before closing and optionally compressing. Enter a numeral with units of KB, MB, etc."""
52
+ max_size: NotRequired[str]
53
+ r"""The maximum disk space that the queue can consume (as an average per Worker Process) before queueing stops. Enter a numeral with units of KB, MB, etc."""
54
+ path: NotRequired[str]
55
+ r"""The location for the persistent queue files. To this field's value, the system will append: /<worker-id>/inputs/<input-id>"""
56
+ compress: NotRequired[InputNetflowCompression]
57
+ r"""Codec to use to compress the persisted data"""
58
+
59
+
60
+ class InputNetflowPq(BaseModel):
61
+ mode: Annotated[
62
+ Optional[InputNetflowMode], PlainValidator(validate_open_enum(False))
63
+ ] = InputNetflowMode.ALWAYS
64
+ r"""With Smart mode, PQ will write events to the filesystem only when it detects backpressure from the processing engine. With Always On mode, PQ will always write events directly to the queue before forwarding them to the processing engine."""
65
+
66
+ max_buffer_size: Annotated[
67
+ Optional[float], pydantic.Field(alias="maxBufferSize")
68
+ ] = 1000
69
+ r"""The maximum number of events to hold in memory before writing the events to disk"""
70
+
71
+ commit_frequency: Annotated[
72
+ Optional[float], pydantic.Field(alias="commitFrequency")
73
+ ] = 42
74
+ r"""The number of events to send downstream before committing that Stream has read them"""
75
+
76
+ max_file_size: Annotated[Optional[str], pydantic.Field(alias="maxFileSize")] = (
77
+ "1 MB"
78
+ )
79
+ r"""The maximum size to store in each queue file before closing and optionally compressing. Enter a numeral with units of KB, MB, etc."""
80
+
81
+ max_size: Annotated[Optional[str], pydantic.Field(alias="maxSize")] = "5GB"
82
+ r"""The maximum disk space that the queue can consume (as an average per Worker Process) before queueing stops. Enter a numeral with units of KB, MB, etc."""
83
+
84
+ path: Optional[str] = "$CRIBL_HOME/state/queues"
85
+ r"""The location for the persistent queue files. To this field's value, the system will append: /<worker-id>/inputs/<input-id>"""
86
+
87
+ compress: Annotated[
88
+ Optional[InputNetflowCompression], PlainValidator(validate_open_enum(False))
89
+ ] = InputNetflowCompression.NONE
90
+ r"""Codec to use to compress the persisted data"""
91
+
92
+
93
+ class InputNetflowMetadatumTypedDict(TypedDict):
94
+ name: str
95
+ value: str
96
+ r"""JavaScript expression to compute field's value, enclosed in quotes or backticks. (Can evaluate to a constant.)"""
97
+
98
+
99
+ class InputNetflowMetadatum(BaseModel):
100
+ name: str
101
+
102
+ value: str
103
+ r"""JavaScript expression to compute field's value, enclosed in quotes or backticks. (Can evaluate to a constant.)"""
104
+
105
+
106
+ class InputNetflowTypedDict(TypedDict):
107
+ type: InputNetflowType
108
+ id: NotRequired[str]
109
+ r"""Unique ID for this input"""
110
+ disabled: NotRequired[bool]
111
+ pipeline: NotRequired[str]
112
+ r"""Pipeline to process data from this Source before sending it through the Routes"""
113
+ send_to_routes: NotRequired[bool]
114
+ r"""Select whether to send data to Routes, or directly to Destinations."""
115
+ environment: NotRequired[str]
116
+ r"""Optionally, enable this config only on a specified Git branch. If empty, will be enabled everywhere."""
117
+ pq_enabled: NotRequired[bool]
118
+ r"""Use a disk queue to minimize data loss when connected services block. See [Cribl Docs](https://docs.cribl.io/stream/persistent-queues) for PQ defaults (Cribl-managed Cloud Workers) and configuration options (on-prem and hybrid Workers)."""
119
+ streamtags: NotRequired[List[str]]
120
+ r"""Tags for filtering and grouping in @{product}"""
121
+ connections: NotRequired[List[InputNetflowConnectionTypedDict]]
122
+ r"""Direct connections to Destinations, and optionally via a Pipeline or a Pack"""
123
+ pq: NotRequired[InputNetflowPqTypedDict]
124
+ host: NotRequired[str]
125
+ r"""Address to bind on. For IPv4 (all addresses), use the default '0.0.0.0'. For IPv6, enter '::' (all addresses) or specify an IP address."""
126
+ port: NotRequired[float]
127
+ r"""Port to listen on"""
128
+ enable_pass_through: NotRequired[bool]
129
+ r"""Allow forwarding of events to a NetFlow destination. Enabling this feature will generate an extra event containing __netflowRaw which can be routed to a NetFlow destination. Note that these events will not count against ingest quota."""
130
+ ip_allowlist_regex: NotRequired[str]
131
+ r"""Messages from matched IP addresses will be processed, unless also matched by the denylist."""
132
+ ip_denylist_regex: NotRequired[str]
133
+ r"""Messages from matched IP addresses will be ignored. This takes precedence over the allowlist."""
134
+ udp_socket_rx_buf_size: NotRequired[float]
135
+ r"""Optionally, set the SO_RCVBUF socket option for the UDP socket. This value tells the operating system how many bytes can be buffered in the kernel before events are dropped. Leave blank to use the OS default. Caution: Increasing this value will affect OS memory utilization."""
136
+ template_cache_minutes: NotRequired[float]
137
+ r"""Specifies how many minutes NetFlow v9 templates are cached before being discarded if not refreshed. Adjust based on your network's template update frequency to optimize performance and memory usage."""
138
+ v5_enabled: NotRequired[bool]
139
+ r"""Accept messages in Netflow V5 format."""
140
+ v9_enabled: NotRequired[bool]
141
+ r"""Accept messages in Netflow V9 format."""
142
+ ipfix_enabled: NotRequired[bool]
143
+ r"""Accept messages in IPFIX format."""
144
+ metadata: NotRequired[List[InputNetflowMetadatumTypedDict]]
145
+ r"""Fields to add to events from this input"""
146
+ description: NotRequired[str]
147
+
148
+
149
+ class InputNetflow(BaseModel):
150
+ type: Annotated[InputNetflowType, PlainValidator(validate_open_enum(False))]
151
+
152
+ id: Optional[str] = None
153
+ r"""Unique ID for this input"""
154
+
155
+ disabled: Optional[bool] = False
156
+
157
+ pipeline: Optional[str] = None
158
+ r"""Pipeline to process data from this Source before sending it through the Routes"""
159
+
160
+ send_to_routes: Annotated[Optional[bool], pydantic.Field(alias="sendToRoutes")] = (
161
+ True
162
+ )
163
+ r"""Select whether to send data to Routes, or directly to Destinations."""
164
+
165
+ environment: Optional[str] = None
166
+ r"""Optionally, enable this config only on a specified Git branch. If empty, will be enabled everywhere."""
167
+
168
+ pq_enabled: Annotated[Optional[bool], pydantic.Field(alias="pqEnabled")] = False
169
+ r"""Use a disk queue to minimize data loss when connected services block. See [Cribl Docs](https://docs.cribl.io/stream/persistent-queues) for PQ defaults (Cribl-managed Cloud Workers) and configuration options (on-prem and hybrid Workers)."""
170
+
171
+ streamtags: Optional[List[str]] = None
172
+ r"""Tags for filtering and grouping in @{product}"""
173
+
174
+ connections: Optional[List[InputNetflowConnection]] = None
175
+ r"""Direct connections to Destinations, and optionally via a Pipeline or a Pack"""
176
+
177
+ pq: Optional[InputNetflowPq] = None
178
+
179
+ host: Optional[str] = "0.0.0.0"
180
+ r"""Address to bind on. For IPv4 (all addresses), use the default '0.0.0.0'. For IPv6, enter '::' (all addresses) or specify an IP address."""
181
+
182
+ port: Optional[float] = 2055
183
+ r"""Port to listen on"""
184
+
185
+ enable_pass_through: Annotated[
186
+ Optional[bool], pydantic.Field(alias="enablePassThrough")
187
+ ] = False
188
+ r"""Allow forwarding of events to a NetFlow destination. Enabling this feature will generate an extra event containing __netflowRaw which can be routed to a NetFlow destination. Note that these events will not count against ingest quota."""
189
+
190
+ ip_allowlist_regex: Annotated[
191
+ Optional[str], pydantic.Field(alias="ipAllowlistRegex")
192
+ ] = "/.*/"
193
+ r"""Messages from matched IP addresses will be processed, unless also matched by the denylist."""
194
+
195
+ ip_denylist_regex: Annotated[
196
+ Optional[str], pydantic.Field(alias="ipDenylistRegex")
197
+ ] = "/^$/"
198
+ r"""Messages from matched IP addresses will be ignored. This takes precedence over the allowlist."""
199
+
200
+ udp_socket_rx_buf_size: Annotated[
201
+ Optional[float], pydantic.Field(alias="udpSocketRxBufSize")
202
+ ] = None
203
+ r"""Optionally, set the SO_RCVBUF socket option for the UDP socket. This value tells the operating system how many bytes can be buffered in the kernel before events are dropped. Leave blank to use the OS default. Caution: Increasing this value will affect OS memory utilization."""
204
+
205
+ template_cache_minutes: Annotated[
206
+ Optional[float], pydantic.Field(alias="templateCacheMinutes")
207
+ ] = 30
208
+ r"""Specifies how many minutes NetFlow v9 templates are cached before being discarded if not refreshed. Adjust based on your network's template update frequency to optimize performance and memory usage."""
209
+
210
+ v5_enabled: Annotated[Optional[bool], pydantic.Field(alias="v5Enabled")] = True
211
+ r"""Accept messages in Netflow V5 format."""
212
+
213
+ v9_enabled: Annotated[Optional[bool], pydantic.Field(alias="v9Enabled")] = True
214
+ r"""Accept messages in Netflow V9 format."""
215
+
216
+ ipfix_enabled: Annotated[Optional[bool], pydantic.Field(alias="ipfixEnabled")] = (
217
+ False
218
+ )
219
+ r"""Accept messages in IPFIX format."""
220
+
221
+ metadata: Optional[List[InputNetflowMetadatum]] = None
222
+ r"""Fields to add to events from this input"""
223
+
224
+ description: Optional[str] = None
@@ -0,0 +1,384 @@
1
+ """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
2
+
3
+ from __future__ import annotations
4
+ from cribl_control_plane import utils
5
+ from cribl_control_plane.types import BaseModel
6
+ from cribl_control_plane.utils import validate_open_enum
7
+ from enum import Enum
8
+ import pydantic
9
+ from pydantic.functional_validators import PlainValidator
10
+ from typing import List, Optional
11
+ from typing_extensions import Annotated, NotRequired, TypedDict
12
+
13
+
14
+ class InputOffice365MgmtType(str, Enum, metaclass=utils.OpenEnumMeta):
15
+ OFFICE365_MGMT = "office365_mgmt"
16
+
17
+
18
+ class InputOffice365MgmtConnectionTypedDict(TypedDict):
19
+ output: str
20
+ pipeline: NotRequired[str]
21
+
22
+
23
+ class InputOffice365MgmtConnection(BaseModel):
24
+ output: str
25
+
26
+ pipeline: Optional[str] = None
27
+
28
+
29
+ class InputOffice365MgmtMode(str, Enum, metaclass=utils.OpenEnumMeta):
30
+ r"""With Smart mode, PQ will write events to the filesystem only when it detects backpressure from the processing engine. With Always On mode, PQ will always write events directly to the queue before forwarding them to the processing engine."""
31
+
32
+ SMART = "smart"
33
+ ALWAYS = "always"
34
+
35
+
36
+ class InputOffice365MgmtCompression(str, Enum, metaclass=utils.OpenEnumMeta):
37
+ r"""Codec to use to compress the persisted data"""
38
+
39
+ NONE = "none"
40
+ GZIP = "gzip"
41
+
42
+
43
+ class InputOffice365MgmtPqTypedDict(TypedDict):
44
+ mode: NotRequired[InputOffice365MgmtMode]
45
+ r"""With Smart mode, PQ will write events to the filesystem only when it detects backpressure from the processing engine. With Always On mode, PQ will always write events directly to the queue before forwarding them to the processing engine."""
46
+ max_buffer_size: NotRequired[float]
47
+ r"""The maximum number of events to hold in memory before writing the events to disk"""
48
+ commit_frequency: NotRequired[float]
49
+ r"""The number of events to send downstream before committing that Stream has read them"""
50
+ max_file_size: NotRequired[str]
51
+ r"""The maximum size to store in each queue file before closing and optionally compressing. Enter a numeral with units of KB, MB, etc."""
52
+ max_size: NotRequired[str]
53
+ r"""The maximum disk space that the queue can consume (as an average per Worker Process) before queueing stops. Enter a numeral with units of KB, MB, etc."""
54
+ path: NotRequired[str]
55
+ r"""The location for the persistent queue files. To this field's value, the system will append: /<worker-id>/inputs/<input-id>"""
56
+ compress: NotRequired[InputOffice365MgmtCompression]
57
+ r"""Codec to use to compress the persisted data"""
58
+
59
+
60
+ class InputOffice365MgmtPq(BaseModel):
61
+ mode: Annotated[
62
+ Optional[InputOffice365MgmtMode], PlainValidator(validate_open_enum(False))
63
+ ] = InputOffice365MgmtMode.ALWAYS
64
+ r"""With Smart mode, PQ will write events to the filesystem only when it detects backpressure from the processing engine. With Always On mode, PQ will always write events directly to the queue before forwarding them to the processing engine."""
65
+
66
+ max_buffer_size: Annotated[
67
+ Optional[float], pydantic.Field(alias="maxBufferSize")
68
+ ] = 1000
69
+ r"""The maximum number of events to hold in memory before writing the events to disk"""
70
+
71
+ commit_frequency: Annotated[
72
+ Optional[float], pydantic.Field(alias="commitFrequency")
73
+ ] = 42
74
+ r"""The number of events to send downstream before committing that Stream has read them"""
75
+
76
+ max_file_size: Annotated[Optional[str], pydantic.Field(alias="maxFileSize")] = (
77
+ "1 MB"
78
+ )
79
+ r"""The maximum size to store in each queue file before closing and optionally compressing. Enter a numeral with units of KB, MB, etc."""
80
+
81
+ max_size: Annotated[Optional[str], pydantic.Field(alias="maxSize")] = "5GB"
82
+ r"""The maximum disk space that the queue can consume (as an average per Worker Process) before queueing stops. Enter a numeral with units of KB, MB, etc."""
83
+
84
+ path: Optional[str] = "$CRIBL_HOME/state/queues"
85
+ r"""The location for the persistent queue files. To this field's value, the system will append: /<worker-id>/inputs/<input-id>"""
86
+
87
+ compress: Annotated[
88
+ Optional[InputOffice365MgmtCompression],
89
+ PlainValidator(validate_open_enum(False)),
90
+ ] = InputOffice365MgmtCompression.NONE
91
+ r"""Codec to use to compress the persisted data"""
92
+
93
+
94
+ class InputOffice365MgmtSubscriptionPlan(str, Enum, metaclass=utils.OpenEnumMeta):
95
+ r"""Office 365 subscription plan for your organization, typically Office 365 Enterprise"""
96
+
97
+ ENTERPRISE_GCC = "enterprise_gcc"
98
+ GCC = "gcc"
99
+ GCC_HIGH = "gcc_high"
100
+ DOD = "dod"
101
+
102
+
103
+ class InputOffice365MgmtMetadatumTypedDict(TypedDict):
104
+ name: str
105
+ value: str
106
+ r"""JavaScript expression to compute field's value, enclosed in quotes or backticks. (Can evaluate to a constant.)"""
107
+
108
+
109
+ class InputOffice365MgmtMetadatum(BaseModel):
110
+ name: str
111
+
112
+ value: str
113
+ r"""JavaScript expression to compute field's value, enclosed in quotes or backticks. (Can evaluate to a constant.)"""
114
+
115
+
116
+ class InputOffice365MgmtLogLevel(str, Enum, metaclass=utils.OpenEnumMeta):
117
+ r"""Collector runtime Log Level"""
118
+
119
+ ERROR = "error"
120
+ WARN = "warn"
121
+ INFO = "info"
122
+ DEBUG = "debug"
123
+
124
+
125
+ class InputOffice365MgmtContentConfigTypedDict(TypedDict):
126
+ content_type: NotRequired[str]
127
+ r"""Office 365 Management Activity API Content Type"""
128
+ description: NotRequired[str]
129
+ r"""If interval type is minutes the value entered must evenly divisible by 60 or save will fail"""
130
+ interval: NotRequired[float]
131
+ log_level: NotRequired[InputOffice365MgmtLogLevel]
132
+ r"""Collector runtime Log Level"""
133
+ enabled: NotRequired[bool]
134
+
135
+
136
+ class InputOffice365MgmtContentConfig(BaseModel):
137
+ content_type: Annotated[Optional[str], pydantic.Field(alias="contentType")] = None
138
+ r"""Office 365 Management Activity API Content Type"""
139
+
140
+ description: Optional[str] = None
141
+ r"""If interval type is minutes the value entered must evenly divisible by 60 or save will fail"""
142
+
143
+ interval: Optional[float] = None
144
+
145
+ log_level: Annotated[
146
+ Annotated[
147
+ Optional[InputOffice365MgmtLogLevel],
148
+ PlainValidator(validate_open_enum(False)),
149
+ ],
150
+ pydantic.Field(alias="logLevel"),
151
+ ] = None
152
+ r"""Collector runtime Log Level"""
153
+
154
+ enabled: Optional[bool] = None
155
+
156
+
157
+ class InputOffice365MgmtRetryType(str, Enum, metaclass=utils.OpenEnumMeta):
158
+ r"""The algorithm to use when performing HTTP retries"""
159
+
160
+ NONE = "none"
161
+ BACKOFF = "backoff"
162
+ STATIC = "static"
163
+
164
+
165
+ class InputOffice365MgmtRetryRulesTypedDict(TypedDict):
166
+ type: NotRequired[InputOffice365MgmtRetryType]
167
+ r"""The algorithm to use when performing HTTP retries"""
168
+ interval: NotRequired[float]
169
+ r"""Time interval between failed request and first retry (kickoff). Maximum allowed value is 20,000 ms (1/3 minute)."""
170
+ limit: NotRequired[float]
171
+ r"""The maximum number of times to retry a failed HTTP request"""
172
+ multiplier: NotRequired[float]
173
+ r"""Base for exponential backoff, e.g., base 2 means that retries will occur after 2, then 4, then 8 seconds, and so on"""
174
+ codes: NotRequired[List[float]]
175
+ r"""List of http codes that trigger a retry. Leave empty to use the default list of 429, 500, and 503."""
176
+ enable_header: NotRequired[bool]
177
+ r"""Honor any Retry-After header that specifies a delay (in seconds) or a timestamp after which to retry the request. The delay is limited to 20 seconds, even if the Retry-After header specifies a longer delay. When disabled, all Retry-After headers are ignored."""
178
+ retry_connect_timeout: NotRequired[bool]
179
+ r"""Make a single retry attempt when a connection timeout (ETIMEDOUT) error occurs"""
180
+ retry_connect_reset: NotRequired[bool]
181
+ r"""Retry request when a connection reset (ECONNRESET) error occurs"""
182
+
183
+
184
+ class InputOffice365MgmtRetryRules(BaseModel):
185
+ type: Annotated[
186
+ Optional[InputOffice365MgmtRetryType], PlainValidator(validate_open_enum(False))
187
+ ] = InputOffice365MgmtRetryType.BACKOFF
188
+ r"""The algorithm to use when performing HTTP retries"""
189
+
190
+ interval: Optional[float] = 1000
191
+ r"""Time interval between failed request and first retry (kickoff). Maximum allowed value is 20,000 ms (1/3 minute)."""
192
+
193
+ limit: Optional[float] = 5
194
+ r"""The maximum number of times to retry a failed HTTP request"""
195
+
196
+ multiplier: Optional[float] = 2
197
+ r"""Base for exponential backoff, e.g., base 2 means that retries will occur after 2, then 4, then 8 seconds, and so on"""
198
+
199
+ codes: Optional[List[float]] = None
200
+ r"""List of http codes that trigger a retry. Leave empty to use the default list of 429, 500, and 503."""
201
+
202
+ enable_header: Annotated[Optional[bool], pydantic.Field(alias="enableHeader")] = (
203
+ True
204
+ )
205
+ r"""Honor any Retry-After header that specifies a delay (in seconds) or a timestamp after which to retry the request. The delay is limited to 20 seconds, even if the Retry-After header specifies a longer delay. When disabled, all Retry-After headers are ignored."""
206
+
207
+ retry_connect_timeout: Annotated[
208
+ Optional[bool], pydantic.Field(alias="retryConnectTimeout")
209
+ ] = False
210
+ r"""Make a single retry attempt when a connection timeout (ETIMEDOUT) error occurs"""
211
+
212
+ retry_connect_reset: Annotated[
213
+ Optional[bool], pydantic.Field(alias="retryConnectReset")
214
+ ] = False
215
+ r"""Retry request when a connection reset (ECONNRESET) error occurs"""
216
+
217
+
218
+ class InputOffice365MgmtAuthenticationMethod(str, Enum, metaclass=utils.OpenEnumMeta):
219
+ r"""Enter client secret directly, or select a stored secret"""
220
+
221
+ MANUAL = "manual"
222
+ SECRET = "secret"
223
+
224
+
225
+ class InputOffice365MgmtTypedDict(TypedDict):
226
+ type: InputOffice365MgmtType
227
+ tenant_id: str
228
+ r"""Office 365 Azure Tenant ID"""
229
+ app_id: str
230
+ r"""Office 365 Azure Application ID"""
231
+ id: NotRequired[str]
232
+ r"""Unique ID for this input"""
233
+ disabled: NotRequired[bool]
234
+ pipeline: NotRequired[str]
235
+ r"""Pipeline to process data from this Source before sending it through the Routes"""
236
+ send_to_routes: NotRequired[bool]
237
+ r"""Select whether to send data to Routes, or directly to Destinations."""
238
+ environment: NotRequired[str]
239
+ r"""Optionally, enable this config only on a specified Git branch. If empty, will be enabled everywhere."""
240
+ pq_enabled: NotRequired[bool]
241
+ r"""Use a disk queue to minimize data loss when connected services block. See [Cribl Docs](https://docs.cribl.io/stream/persistent-queues) for PQ defaults (Cribl-managed Cloud Workers) and configuration options (on-prem and hybrid Workers)."""
242
+ streamtags: NotRequired[List[str]]
243
+ r"""Tags for filtering and grouping in @{product}"""
244
+ connections: NotRequired[List[InputOffice365MgmtConnectionTypedDict]]
245
+ r"""Direct connections to Destinations, and optionally via a Pipeline or a Pack"""
246
+ pq: NotRequired[InputOffice365MgmtPqTypedDict]
247
+ plan_type: NotRequired[InputOffice365MgmtSubscriptionPlan]
248
+ r"""Office 365 subscription plan for your organization, typically Office 365 Enterprise"""
249
+ timeout: NotRequired[float]
250
+ r"""HTTP request inactivity timeout, use 0 to disable"""
251
+ keep_alive_time: NotRequired[float]
252
+ r"""How often workers should check in with the scheduler to keep job subscription alive"""
253
+ job_timeout: NotRequired[str]
254
+ r"""Maximum time the job is allowed to run (e.g., 30, 45s or 15m). Units are seconds, if not specified. Enter 0 for unlimited time."""
255
+ max_missed_keep_alives: NotRequired[float]
256
+ r"""The number of Keep Alive Time periods before an inactive worker will have its job subscription revoked."""
257
+ ttl: NotRequired[str]
258
+ r"""Time to keep the job's artifacts on disk after job completion. This also affects how long a job is listed in the Job Inspector."""
259
+ ignore_group_jobs_limit: NotRequired[bool]
260
+ r"""When enabled, this job's artifacts are not counted toward the Worker Group's finished job artifacts limit. Artifacts will be removed only after the Collector's configured time to live."""
261
+ metadata: NotRequired[List[InputOffice365MgmtMetadatumTypedDict]]
262
+ r"""Fields to add to events from this input"""
263
+ publisher_identifier: NotRequired[str]
264
+ r"""Optional Publisher Identifier to use in API requests, defaults to tenant id if not defined. For more information see [here](https://docs.microsoft.com/en-us/office/office-365-management-api/office-365-management-activity-api-reference#start-a-subscription)"""
265
+ content_config: NotRequired[List[InputOffice365MgmtContentConfigTypedDict]]
266
+ r"""Enable Office 365 Management Activity API content types and polling intervals. Polling intervals are used to set up search date range and cron schedule, e.g.: */${interval} * * * *. Because of this, intervals entered must be evenly divisible by 60 to give a predictable schedule."""
267
+ ingestion_lag: NotRequired[float]
268
+ r"""Use this setting to account for ingestion lag. This is necessary because there can be a lag of 60 - 90 minutes (or longer) before Office 365 events are available for retrieval."""
269
+ retry_rules: NotRequired[InputOffice365MgmtRetryRulesTypedDict]
270
+ auth_type: NotRequired[InputOffice365MgmtAuthenticationMethod]
271
+ r"""Enter client secret directly, or select a stored secret"""
272
+ description: NotRequired[str]
273
+ client_secret: NotRequired[str]
274
+ r"""Office 365 Azure client secret"""
275
+ text_secret: NotRequired[str]
276
+ r"""Select or create a stored text secret"""
277
+
278
+
279
+ class InputOffice365Mgmt(BaseModel):
280
+ type: Annotated[InputOffice365MgmtType, PlainValidator(validate_open_enum(False))]
281
+
282
+ tenant_id: Annotated[str, pydantic.Field(alias="tenantId")]
283
+ r"""Office 365 Azure Tenant ID"""
284
+
285
+ app_id: Annotated[str, pydantic.Field(alias="appId")]
286
+ r"""Office 365 Azure Application ID"""
287
+
288
+ id: Optional[str] = None
289
+ r"""Unique ID for this input"""
290
+
291
+ disabled: Optional[bool] = False
292
+
293
+ pipeline: Optional[str] = None
294
+ r"""Pipeline to process data from this Source before sending it through the Routes"""
295
+
296
+ send_to_routes: Annotated[Optional[bool], pydantic.Field(alias="sendToRoutes")] = (
297
+ True
298
+ )
299
+ r"""Select whether to send data to Routes, or directly to Destinations."""
300
+
301
+ environment: Optional[str] = None
302
+ r"""Optionally, enable this config only on a specified Git branch. If empty, will be enabled everywhere."""
303
+
304
+ pq_enabled: Annotated[Optional[bool], pydantic.Field(alias="pqEnabled")] = False
305
+ r"""Use a disk queue to minimize data loss when connected services block. See [Cribl Docs](https://docs.cribl.io/stream/persistent-queues) for PQ defaults (Cribl-managed Cloud Workers) and configuration options (on-prem and hybrid Workers)."""
306
+
307
+ streamtags: Optional[List[str]] = None
308
+ r"""Tags for filtering and grouping in @{product}"""
309
+
310
+ connections: Optional[List[InputOffice365MgmtConnection]] = None
311
+ r"""Direct connections to Destinations, and optionally via a Pipeline or a Pack"""
312
+
313
+ pq: Optional[InputOffice365MgmtPq] = None
314
+
315
+ plan_type: Annotated[
316
+ Annotated[
317
+ Optional[InputOffice365MgmtSubscriptionPlan],
318
+ PlainValidator(validate_open_enum(False)),
319
+ ],
320
+ pydantic.Field(alias="planType"),
321
+ ] = InputOffice365MgmtSubscriptionPlan.ENTERPRISE_GCC
322
+ r"""Office 365 subscription plan for your organization, typically Office 365 Enterprise"""
323
+
324
+ timeout: Optional[float] = 300
325
+ r"""HTTP request inactivity timeout, use 0 to disable"""
326
+
327
+ keep_alive_time: Annotated[
328
+ Optional[float], pydantic.Field(alias="keepAliveTime")
329
+ ] = 30
330
+ r"""How often workers should check in with the scheduler to keep job subscription alive"""
331
+
332
+ job_timeout: Annotated[Optional[str], pydantic.Field(alias="jobTimeout")] = "0"
333
+ r"""Maximum time the job is allowed to run (e.g., 30, 45s or 15m). Units are seconds, if not specified. Enter 0 for unlimited time."""
334
+
335
+ max_missed_keep_alives: Annotated[
336
+ Optional[float], pydantic.Field(alias="maxMissedKeepAlives")
337
+ ] = 3
338
+ r"""The number of Keep Alive Time periods before an inactive worker will have its job subscription revoked."""
339
+
340
+ ttl: Optional[str] = "4h"
341
+ r"""Time to keep the job's artifacts on disk after job completion. This also affects how long a job is listed in the Job Inspector."""
342
+
343
+ ignore_group_jobs_limit: Annotated[
344
+ Optional[bool], pydantic.Field(alias="ignoreGroupJobsLimit")
345
+ ] = False
346
+ r"""When enabled, this job's artifacts are not counted toward the Worker Group's finished job artifacts limit. Artifacts will be removed only after the Collector's configured time to live."""
347
+
348
+ metadata: Optional[List[InputOffice365MgmtMetadatum]] = None
349
+ r"""Fields to add to events from this input"""
350
+
351
+ publisher_identifier: Annotated[
352
+ Optional[str], pydantic.Field(alias="publisherIdentifier")
353
+ ] = None
354
+ r"""Optional Publisher Identifier to use in API requests, defaults to tenant id if not defined. For more information see [here](https://docs.microsoft.com/en-us/office/office-365-management-api/office-365-management-activity-api-reference#start-a-subscription)"""
355
+
356
+ content_config: Annotated[
357
+ Optional[List[InputOffice365MgmtContentConfig]],
358
+ pydantic.Field(alias="contentConfig"),
359
+ ] = None
360
+ r"""Enable Office 365 Management Activity API content types and polling intervals. Polling intervals are used to set up search date range and cron schedule, e.g.: */${interval} * * * *. Because of this, intervals entered must be evenly divisible by 60 to give a predictable schedule."""
361
+
362
+ ingestion_lag: Annotated[Optional[float], pydantic.Field(alias="ingestionLag")] = 0
363
+ r"""Use this setting to account for ingestion lag. This is necessary because there can be a lag of 60 - 90 minutes (or longer) before Office 365 events are available for retrieval."""
364
+
365
+ retry_rules: Annotated[
366
+ Optional[InputOffice365MgmtRetryRules], pydantic.Field(alias="retryRules")
367
+ ] = None
368
+
369
+ auth_type: Annotated[
370
+ Annotated[
371
+ Optional[InputOffice365MgmtAuthenticationMethod],
372
+ PlainValidator(validate_open_enum(False)),
373
+ ],
374
+ pydantic.Field(alias="authType"),
375
+ ] = InputOffice365MgmtAuthenticationMethod.MANUAL
376
+ r"""Enter client secret directly, or select a stored secret"""
377
+
378
+ description: Optional[str] = None
379
+
380
+ client_secret: Annotated[Optional[str], pydantic.Field(alias="clientSecret")] = None
381
+ r"""Office 365 Azure client secret"""
382
+
383
+ text_secret: Annotated[Optional[str], pydantic.Field(alias="textSecret")] = None
384
+ r"""Select or create a stored text secret"""