cribl-control-plane 0.4.0b23__py3-none-any.whl → 0.5.0b3__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.
Files changed (229) hide show
  1. cribl_control_plane/_version.py +3 -3
  2. cribl_control_plane/collectors_sdk.py +993 -0
  3. cribl_control_plane/models/__init__.py +2161 -734
  4. cribl_control_plane/models/configgroup.py +3 -0
  5. cribl_control_plane/models/countedsavedjob.py +20 -0
  6. cribl_control_plane/models/createsavedjobop.py +30 -0
  7. cribl_control_plane/models/deletesavedjobbyidop.py +42 -0
  8. cribl_control_plane/models/functionaggregatemetrics.py +7 -144
  9. cribl_control_plane/models/functionaggregation.py +7 -110
  10. cribl_control_plane/models/functionautotimestamp.py +7 -111
  11. cribl_control_plane/models/functioncef.py +6 -51
  12. cribl_control_plane/models/functionchain.py +6 -12
  13. cribl_control_plane/models/functionclone.py +7 -13
  14. cribl_control_plane/models/functioncode.py +8 -35
  15. cribl_control_plane/models/functioncomment.py +6 -12
  16. cribl_control_plane/models/functionconfschemaaggregatemetrics.py +153 -0
  17. cribl_control_plane/models/functionconfschemaaggregation.py +114 -0
  18. cribl_control_plane/models/functionconfschemaautotimestamp.py +116 -0
  19. cribl_control_plane/models/functionconfschemacef.py +83 -0
  20. cribl_control_plane/models/functionconfschemachain.py +16 -0
  21. cribl_control_plane/models/functionconfschemaclone.py +16 -0
  22. cribl_control_plane/models/functionconfschemacode.py +38 -0
  23. cribl_control_plane/models/functionconfschemacomment.py +16 -0
  24. cribl_control_plane/models/functionconfschemadistinct.py +41 -0
  25. cribl_control_plane/models/functionconfschemadnslookup.py +193 -0
  26. cribl_control_plane/models/functionconfschemadrop.py +13 -0
  27. cribl_control_plane/models/functionconfschemadropdimensions.py +31 -0
  28. cribl_control_plane/models/functionconfschemadynamicsampling.py +67 -0
  29. cribl_control_plane/models/functionconfschemaeval.py +44 -0
  30. cribl_control_plane/models/functionconfschemaeventbreaker.py +51 -0
  31. cribl_control_plane/models/functionconfschemaeventstats.py +34 -0
  32. cribl_control_plane/models/functionconfschemaexternaldata.py +13 -0
  33. cribl_control_plane/models/functionconfschemaflatten.py +31 -0
  34. cribl_control_plane/models/functionconfschemafoldkeys.py +31 -0
  35. cribl_control_plane/models/functionconfschemagenstats.py +14 -0
  36. cribl_control_plane/models/functionconfschemageoip.py +66 -0
  37. cribl_control_plane/models/functionconfschemagrok.py +38 -0
  38. cribl_control_plane/models/functionconfschemahandlebar.py +56 -0
  39. cribl_control_plane/models/functionconfschemajoin.py +55 -0
  40. cribl_control_plane/models/functionconfschemajsonunroll.py +21 -0
  41. cribl_control_plane/models/functionconfschemalakeexport.py +44 -0
  42. cribl_control_plane/models/functionconfschemalimit.py +16 -0
  43. cribl_control_plane/models/functionconfschemalocalsearchdatatypeparser.py +17 -0
  44. cribl_control_plane/models/functionconfschemalocalsearchrulesetrunner.py +40 -0
  45. cribl_control_plane/models/functionconfschemalookup.py +92 -0
  46. cribl_control_plane/models/functionconfschemamask.py +63 -0
  47. cribl_control_plane/models/functionconfschemamvexpand.py +76 -0
  48. cribl_control_plane/models/functionconfschemamvpull.py +45 -0
  49. cribl_control_plane/models/functionconfschemanotificationpolicies.py +129 -0
  50. cribl_control_plane/models/functionconfschemanotifications.py +26 -0
  51. cribl_control_plane/models/functionconfschemanotify.py +149 -0
  52. cribl_control_plane/models/functionconfschemanumerify.py +63 -0
  53. cribl_control_plane/models/functionconfschemaotlplogs.py +24 -0
  54. cribl_control_plane/models/functionconfschemaotlpmetrics.py +61 -0
  55. cribl_control_plane/models/functionconfschemaotlptraces.py +54 -0
  56. cribl_control_plane/models/functionconfschemapack.py +24 -0
  57. cribl_control_plane/models/functionconfschemapivot.py +31 -0
  58. cribl_control_plane/models/functionconfschemapublishmetrics.py +98 -0
  59. cribl_control_plane/models/functionconfschemaredis.py +121 -0
  60. cribl_control_plane/models/functionconfschemaregexextract.py +55 -0
  61. cribl_control_plane/models/functionconfschemaregexfilter.py +38 -0
  62. cribl_control_plane/models/functionconfschemarename.py +49 -0
  63. cribl_control_plane/models/functionconfschemarollupmetrics.py +57 -0
  64. cribl_control_plane/models/functionconfschemasampling.py +32 -0
  65. cribl_control_plane/models/functionconfschemasend.py +84 -0
  66. cribl_control_plane/models/functionconfschemasensitivedatascanner.py +75 -0
  67. cribl_control_plane/models/functionconfschemaserde.py +105 -0
  68. cribl_control_plane/models/functionconfschemaserialize.py +78 -0
  69. cribl_control_plane/models/functionconfschemasidlookup.py +34 -0
  70. cribl_control_plane/models/functionconfschemasnmptrapserialize.py +92 -0
  71. cribl_control_plane/models/functionconfschemasort.py +41 -0
  72. cribl_control_plane/models/functionconfschemastore.py +75 -0
  73. cribl_control_plane/models/functionconfschemasuppress.py +57 -0
  74. cribl_control_plane/models/functionconfschematee.py +32 -0
  75. cribl_control_plane/models/functionconfschematrimtimestamp.py +16 -0
  76. cribl_control_plane/models/functionconfschemaunion.py +22 -0
  77. cribl_control_plane/models/functionconfschemaunroll.py +22 -0
  78. cribl_control_plane/models/functionconfschemawindow.py +40 -0
  79. cribl_control_plane/models/functionconfschemaxmlunroll.py +34 -0
  80. cribl_control_plane/models/functiondistinct.py +7 -37
  81. cribl_control_plane/models/functiondnslookup.py +7 -188
  82. cribl_control_plane/models/functiondrop.py +8 -12
  83. cribl_control_plane/models/functiondropdimensions.py +7 -25
  84. cribl_control_plane/models/functiondynamicsampling.py +6 -58
  85. cribl_control_plane/models/functioneval.py +9 -43
  86. cribl_control_plane/models/functioneventbreaker.py +6 -40
  87. cribl_control_plane/models/functioneventstats.py +7 -30
  88. cribl_control_plane/models/functionexternaldata.py +6 -10
  89. cribl_control_plane/models/functionflatten.py +7 -28
  90. cribl_control_plane/models/functionfoldkeys.py +6 -26
  91. cribl_control_plane/models/functiongenstats.py +7 -11
  92. cribl_control_plane/models/functiongeoip.py +7 -58
  93. cribl_control_plane/models/functiongrok.py +9 -35
  94. cribl_control_plane/models/functionhandlebar.py +6 -49
  95. cribl_control_plane/models/functionjoin.py +9 -52
  96. cribl_control_plane/models/functionjsonunroll.py +6 -17
  97. cribl_control_plane/models/functionlakeexport.py +6 -39
  98. cribl_control_plane/models/functionlimit.py +6 -12
  99. cribl_control_plane/models/functionlocalsearchdatatypeparser.py +6 -12
  100. cribl_control_plane/models/functionlocalsearchrulesetrunner.py +7 -34
  101. cribl_control_plane/models/functionlookup.py +7 -86
  102. cribl_control_plane/models/functionmask.py +9 -61
  103. cribl_control_plane/models/functionmvexpand.py +7 -66
  104. cribl_control_plane/models/functionmvpull.py +6 -36
  105. cribl_control_plane/models/functionnotificationpolicies.py +8 -125
  106. cribl_control_plane/models/functionnotifications.py +6 -22
  107. cribl_control_plane/models/functionnotify.py +6 -133
  108. cribl_control_plane/models/functionnumerify.py +7 -57
  109. cribl_control_plane/models/functionotlplogs.py +6 -19
  110. cribl_control_plane/models/functionotlpmetrics.py +7 -56
  111. cribl_control_plane/models/functionotlptraces.py +6 -48
  112. cribl_control_plane/models/functionpack.py +9 -20
  113. cribl_control_plane/models/functionpivot.py +7 -23
  114. cribl_control_plane/models/functionpublishmetrics.py +7 -91
  115. cribl_control_plane/models/functionredis.py +7 -111
  116. cribl_control_plane/models/functionregexextract.py +7 -50
  117. cribl_control_plane/models/functionregexfilter.py +7 -33
  118. cribl_control_plane/models/functionrename.py +7 -45
  119. cribl_control_plane/models/functionrollupmetrics.py +7 -52
  120. cribl_control_plane/models/functionsampling.py +7 -28
  121. cribl_control_plane/models/functionsend.py +8 -80
  122. cribl_control_plane/models/functionsensitivedatascanner.py +7 -66
  123. cribl_control_plane/models/functionserde.py +6 -98
  124. cribl_control_plane/models/functionserialize.py +7 -72
  125. cribl_control_plane/models/functionsidlookup.py +7 -31
  126. cribl_control_plane/models/functionsnmptrapserialize.py +6 -81
  127. cribl_control_plane/models/functionsort.py +8 -36
  128. cribl_control_plane/models/functionstore.py +6 -69
  129. cribl_control_plane/models/functionsuppress.py +6 -52
  130. cribl_control_plane/models/functiontee.py +6 -30
  131. cribl_control_plane/models/functiontrimtimestamp.py +6 -12
  132. cribl_control_plane/models/functionunion.py +9 -20
  133. cribl_control_plane/models/functionunroll.py +6 -17
  134. cribl_control_plane/models/functionwindow.py +7 -34
  135. cribl_control_plane/models/functionxmlunroll.py +6 -29
  136. cribl_control_plane/models/getsavedjobbyidop.py +33 -0
  137. cribl_control_plane/models/getsavedjobop.py +40 -0
  138. cribl_control_plane/models/groupcreaterequest.py +3 -0
  139. cribl_control_plane/models/heartbeatmetadata.py +42 -0
  140. cribl_control_plane/models/input.py +1 -1
  141. cribl_control_plane/models/inputedgeprometheus.py +11 -11
  142. cribl_control_plane/models/inputprometheus.py +23 -18
  143. cribl_control_plane/models/nodeprovidedinfo.py +42 -0
  144. cribl_control_plane/models/output.py +15 -9
  145. cribl_control_plane/models/outputclickhouse.py +31 -0
  146. cribl_control_plane/models/outputcriblhttp.py +7 -0
  147. cribl_control_plane/models/outputcriblsearchengine.py +655 -0
  148. cribl_control_plane/models/outputnetflow.py +16 -2
  149. cribl_control_plane/models/pipeline.py +52 -4
  150. cribl_control_plane/models/pipelinefunctionaggregatemetrics.py +195 -0
  151. cribl_control_plane/models/pipelinefunctionaggregation.py +159 -0
  152. cribl_control_plane/models/pipelinefunctionautotimestamp.py +56 -0
  153. cribl_control_plane/models/pipelinefunctioncef.py +96 -0
  154. cribl_control_plane/models/pipelinefunctionchain.py +62 -0
  155. cribl_control_plane/models/pipelinefunctionclone.py +56 -0
  156. cribl_control_plane/models/pipelinefunctioncode.py +56 -0
  157. cribl_control_plane/models/pipelinefunctioncomment.py +56 -0
  158. cribl_control_plane/models/pipelinefunctionconf.py +343 -46
  159. cribl_control_plane/models/pipelinefunctionconf_input.py +353 -0
  160. cribl_control_plane/models/pipelinefunctiondistinct.py +86 -0
  161. cribl_control_plane/models/pipelinefunctiondnslookup.py +56 -0
  162. cribl_control_plane/models/pipelinefunctiondrop.py +56 -0
  163. cribl_control_plane/models/pipelinefunctiondropdimensions.py +74 -0
  164. cribl_control_plane/models/pipelinefunctiondynamicsampling.py +111 -0
  165. cribl_control_plane/models/pipelinefunctioneval.py +56 -0
  166. cribl_control_plane/models/pipelinefunctioneventbreaker.py +95 -0
  167. cribl_control_plane/models/pipelinefunctioneventstats.py +79 -0
  168. cribl_control_plane/models/pipelinefunctionexternaldata.py +56 -0
  169. cribl_control_plane/models/pipelinefunctionflatten.py +56 -0
  170. cribl_control_plane/models/pipelinefunctionfoldkeys.py +56 -0
  171. cribl_control_plane/models/pipelinefunctiongenstats.py +56 -0
  172. cribl_control_plane/models/pipelinefunctiongeoip.py +109 -0
  173. cribl_control_plane/models/pipelinefunctiongrok.py +83 -0
  174. cribl_control_plane/models/pipelinefunctionhandlebar.py +99 -0
  175. cribl_control_plane/models/pipelinefunctionjoin.py +100 -0
  176. cribl_control_plane/models/pipelinefunctionjsonunroll.py +67 -0
  177. cribl_control_plane/models/pipelinefunctionlakeexport.py +89 -0
  178. cribl_control_plane/models/pipelinefunctionlimit.py +56 -0
  179. cribl_control_plane/models/pipelinefunctionlocalsearchdatatypeparser.py +62 -0
  180. cribl_control_plane/models/pipelinefunctionlocalsearchrulesetrunner.py +56 -0
  181. cribl_control_plane/models/pipelinefunctionlookup.py +136 -0
  182. cribl_control_plane/models/pipelinefunctionmask.py +108 -0
  183. cribl_control_plane/models/pipelinefunctionmvexpand.py +116 -0
  184. cribl_control_plane/models/pipelinefunctionmvpull.py +86 -0
  185. cribl_control_plane/models/pipelinefunctionnotificationpolicies.py +56 -0
  186. cribl_control_plane/models/pipelinefunctionnotifications.py +72 -0
  187. cribl_control_plane/models/pipelinefunctionnotify.py +189 -0
  188. cribl_control_plane/models/pipelinefunctionnumerify.py +56 -0
  189. cribl_control_plane/models/pipelinefunctionotlplogs.py +56 -0
  190. cribl_control_plane/models/pipelinefunctionotlpmetrics.py +56 -0
  191. cribl_control_plane/models/pipelinefunctionotlptraces.py +56 -0
  192. cribl_control_plane/models/pipelinefunctionpack.py +67 -0
  193. cribl_control_plane/models/pipelinefunctionpivot.py +72 -0
  194. cribl_control_plane/models/pipelinefunctionpublishmetrics.py +56 -0
  195. cribl_control_plane/models/pipelinefunctionredis.py +165 -0
  196. cribl_control_plane/models/pipelinefunctionregexextract.py +100 -0
  197. cribl_control_plane/models/pipelinefunctionregexfilter.py +56 -0
  198. cribl_control_plane/models/pipelinefunctionrename.py +56 -0
  199. cribl_control_plane/models/pipelinefunctionrollupmetrics.py +56 -0
  200. cribl_control_plane/models/pipelinefunctionsampling.py +56 -0
  201. cribl_control_plane/models/pipelinefunctionsend.py +128 -0
  202. cribl_control_plane/models/pipelinefunctionsensitivedatascanner.py +120 -0
  203. cribl_control_plane/models/pipelinefunctionserde.py +149 -0
  204. cribl_control_plane/models/pipelinefunctionserialize.py +122 -0
  205. cribl_control_plane/models/pipelinefunctionsidlookup.py +56 -0
  206. cribl_control_plane/models/pipelinefunctionsnmptrapserialize.py +56 -0
  207. cribl_control_plane/models/pipelinefunctionsort.py +84 -0
  208. cribl_control_plane/models/pipelinefunctionstore.py +120 -0
  209. cribl_control_plane/models/pipelinefunctionsuppress.py +102 -0
  210. cribl_control_plane/models/pipelinefunctiontee.py +77 -0
  211. cribl_control_plane/models/pipelinefunctiontrimtimestamp.py +56 -0
  212. cribl_control_plane/models/pipelinefunctionunion.py +67 -0
  213. cribl_control_plane/models/pipelinefunctionunroll.py +67 -0
  214. cribl_control_plane/models/pipelinefunctionwindow.py +83 -0
  215. cribl_control_plane/models/pipelinefunctionxmlunroll.py +79 -0
  216. cribl_control_plane/models/runnablejobcollection.py +11 -10
  217. cribl_control_plane/models/runnablejobexecutor.py +8 -8
  218. cribl_control_plane/models/savedjob.py +26 -0
  219. cribl_control_plane/models/savedjobcollection.py +411 -0
  220. cribl_control_plane/models/savedjobexecutor.py +301 -0
  221. cribl_control_plane/models/savedjobscheduledsearch.py +278 -0
  222. cribl_control_plane/models/updatepipelinebyidop.py +4 -3
  223. cribl_control_plane/models/updatesavedjobbyidop.py +42 -0
  224. cribl_control_plane/pipelines.py +16 -16
  225. cribl_control_plane/sdk.py +4 -0
  226. {cribl_control_plane-0.4.0b23.dist-info → cribl_control_plane-0.5.0b3.dist-info}/METADATA +10 -2
  227. {cribl_control_plane-0.4.0b23.dist-info → cribl_control_plane-0.5.0b3.dist-info}/RECORD +229 -88
  228. {cribl_control_plane-0.4.0b23.dist-info → cribl_control_plane-0.5.0b3.dist-info}/WHEEL +0 -0
  229. {cribl_control_plane-0.4.0b23.dist-info → cribl_control_plane-0.5.0b3.dist-info}/licenses/LICENSE +0 -0
@@ -1,6 +1,10 @@
1
1
  """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
2
2
 
3
3
  from __future__ import annotations
4
+ from .functionconfschemasort import (
5
+ FunctionConfSchemaSort,
6
+ FunctionConfSchemaSortTypedDict,
7
+ )
4
8
  from cribl_control_plane.types import BaseModel
5
9
  from enum import Enum
6
10
  import pydantic
@@ -12,38 +16,6 @@ class FunctionSortID(str, Enum):
12
16
  SORT = "sort"
13
17
 
14
18
 
15
- class SortConfigurationTypedDict(TypedDict):
16
- comparison_expression: str
17
- r"""The expression can access the events via the 'left' and 'right' properties."""
18
- sort_id: NotRequired[str]
19
- r"""Has to be unique if there are multiple sorts on the pipeline."""
20
- top_n: NotRequired[float]
21
- r"""Limits the output to N (highest/lowest) events"""
22
- max_events: NotRequired[float]
23
- r"""Specifies the number of events that can flow into this function"""
24
- suppress_previews: NotRequired[bool]
25
- r"""Toggle this on to suppress generating previews of intermediate results"""
26
-
27
-
28
- class SortConfiguration(BaseModel):
29
- comparison_expression: Annotated[str, pydantic.Field(alias="comparisonExpression")]
30
- r"""The expression can access the events via the 'left' and 'right' properties."""
31
-
32
- sort_id: Annotated[Optional[str], pydantic.Field(alias="sortId")] = None
33
- r"""Has to be unique if there are multiple sorts on the pipeline."""
34
-
35
- top_n: Annotated[Optional[float], pydantic.Field(alias="topN")] = None
36
- r"""Limits the output to N (highest/lowest) events"""
37
-
38
- max_events: Annotated[Optional[float], pydantic.Field(alias="maxEvents")] = None
39
- r"""Specifies the number of events that can flow into this function"""
40
-
41
- suppress_previews: Annotated[
42
- Optional[bool], pydantic.Field(alias="suppressPreviews")
43
- ] = None
44
- r"""Toggle this on to suppress generating previews of intermediate results"""
45
-
46
-
47
19
  class FunctionSortTypedDict(TypedDict):
48
20
  filename: str
49
21
  group: str
@@ -58,7 +30,7 @@ class FunctionSortTypedDict(TypedDict):
58
30
  disabled: NotRequired[bool]
59
31
  handle_signals: NotRequired[bool]
60
32
  sync: NotRequired[bool]
61
- schema_: NotRequired[SortConfigurationTypedDict]
33
+ schema_: NotRequired[FunctionConfSchemaSortTypedDict]
62
34
 
63
35
 
64
36
  class FunctionSort(BaseModel):
@@ -92,6 +64,6 @@ class FunctionSort(BaseModel):
92
64
 
93
65
  sync: Optional[bool] = None
94
66
 
95
- schema_: Annotated[Optional[SortConfiguration], pydantic.Field(alias="schema")] = (
96
- None
97
- )
67
+ schema_: Annotated[
68
+ Optional[FunctionConfSchemaSort], pydantic.Field(alias="schema")
69
+ ] = None
@@ -1,6 +1,10 @@
1
1
  """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
2
2
 
3
3
  from __future__ import annotations
4
+ from .functionconfschemastore import (
5
+ FunctionConfSchemaStore,
6
+ FunctionConfSchemaStoreTypedDict,
7
+ )
4
8
  from cribl_control_plane.types import BaseModel
5
9
  from enum import Enum
6
10
  import pydantic
@@ -12,73 +16,6 @@ class FunctionStoreID(str, Enum):
12
16
  STORE = "store"
13
17
 
14
18
 
15
- class MappingOfFieldNamesTypedDict(TypedDict):
16
- r"""Mapping event property names to output field names"""
17
-
18
-
19
- class MappingOfFieldNames(BaseModel):
20
- r"""Mapping event property names to output field names"""
21
-
22
-
23
- class StoreFunctionConfigurationTypedDict(TypedDict):
24
- type: NotRequired[str]
25
- r"""The type of knowledge object, generated by the function (i.e., 'lookup')"""
26
- destination: NotRequired[str]
27
- r"""Configures where and how the data should be stored"""
28
- description: NotRequired[str]
29
- r"""The knowledge object's description"""
30
- field_mapping: NotRequired[MappingOfFieldNamesTypedDict]
31
- r"""Mapping event property names to output field names"""
32
- separator: NotRequired[str]
33
- r"""Character to be used as value delimiter in output"""
34
- overwrite: NotRequired[bool]
35
- r"""For existing files, an error is thrown if overwrite is false or the file is replaced if overwrite is true"""
36
- compress: NotRequired[str]
37
- r"""True will compress output, false leaves it as it is and auto decides based on size"""
38
- tee: NotRequired[bool]
39
- r"""Tee results to the next operator"""
40
- max_events: NotRequired[float]
41
- r"""Limits how many events can be stored"""
42
- suppress_previews: NotRequired[bool]
43
- r"""Suppresses the timer-based export stats generating"""
44
-
45
-
46
- class StoreFunctionConfiguration(BaseModel):
47
- type: Optional[str] = "lookup"
48
- r"""The type of knowledge object, generated by the function (i.e., 'lookup')"""
49
-
50
- destination: Optional[str] = None
51
- r"""Configures where and how the data should be stored"""
52
-
53
- description: Optional[str] = None
54
- r"""The knowledge object's description"""
55
-
56
- field_mapping: Annotated[
57
- Optional[MappingOfFieldNames], pydantic.Field(alias="fieldMapping")
58
- ] = None
59
- r"""Mapping event property names to output field names"""
60
-
61
- separator: Optional[str] = ","
62
- r"""Character to be used as value delimiter in output"""
63
-
64
- overwrite: Optional[bool] = False
65
- r"""For existing files, an error is thrown if overwrite is false or the file is replaced if overwrite is true"""
66
-
67
- compress: Optional[str] = "auto"
68
- r"""True will compress output, false leaves it as it is and auto decides based on size"""
69
-
70
- tee: Optional[bool] = False
71
- r"""Tee results to the next operator"""
72
-
73
- max_events: Annotated[Optional[float], pydantic.Field(alias="maxEvents")] = 10000
74
- r"""Limits how many events can be stored"""
75
-
76
- suppress_previews: Annotated[
77
- Optional[bool], pydantic.Field(alias="suppressPreviews")
78
- ] = False
79
- r"""Suppresses the timer-based export stats generating"""
80
-
81
-
82
19
  class FunctionStoreTypedDict(TypedDict):
83
20
  filename: str
84
21
  group: str
@@ -93,7 +30,7 @@ class FunctionStoreTypedDict(TypedDict):
93
30
  disabled: NotRequired[bool]
94
31
  handle_signals: NotRequired[bool]
95
32
  sync: NotRequired[bool]
96
- schema_: NotRequired[StoreFunctionConfigurationTypedDict]
33
+ schema_: NotRequired[FunctionConfSchemaStoreTypedDict]
97
34
 
98
35
 
99
36
  class FunctionStore(BaseModel):
@@ -128,5 +65,5 @@ class FunctionStore(BaseModel):
128
65
  sync: Optional[bool] = None
129
66
 
130
67
  schema_: Annotated[
131
- Optional[StoreFunctionConfiguration], pydantic.Field(alias="schema")
68
+ Optional[FunctionConfSchemaStore], pydantic.Field(alias="schema")
132
69
  ] = None
@@ -1,6 +1,10 @@
1
1
  """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
2
2
 
3
3
  from __future__ import annotations
4
+ from .functionconfschemasuppress import (
5
+ FunctionConfSchemaSuppress,
6
+ FunctionConfSchemaSuppressTypedDict,
7
+ )
4
8
  from cribl_control_plane.types import BaseModel
5
9
  from enum import Enum
6
10
  import pydantic
@@ -12,56 +16,6 @@ class FunctionSuppressID(str, Enum):
12
16
  SUPPRESS = "suppress"
13
17
 
14
18
 
15
- class FunctionSuppressSchemaTypedDict(TypedDict):
16
- key_expr: str
17
- r"""Suppression key expression used to uniquely identify events to suppress. For example, `${ip}:${port}` will use fields ip and port from each event to generate the key."""
18
- allow: NotRequired[float]
19
- r"""The number of events to allow per time period"""
20
- suppress_period_sec: NotRequired[float]
21
- r"""The number of seconds to suppress events after 'Number to allow' events are received"""
22
- drop_events_mode: NotRequired[bool]
23
- r"""If disabled, suppressed events will be tagged with suppress=1 but not dropped"""
24
- max_cache_size: NotRequired[float]
25
- r"""The maximum number of keys that can be cached before idle entries are removed. Leave at default unless you understand the implications of changing."""
26
- cache_idle_timeout_periods: NotRequired[float]
27
- r"""The number of suppression periods 'Suppression Period' of inactivity before a cache entry is considered idle. Leave at default unless you understand the implications of changing."""
28
- num_events_idle_timeout_trigger: NotRequired[float]
29
- r"""Check cache for idle sessions every N events when cache size is > 'Maximum Cache Size'. Leave at default unless you understand the implications of changing."""
30
-
31
-
32
- class FunctionSuppressSchema(BaseModel):
33
- key_expr: Annotated[str, pydantic.Field(alias="keyExpr")]
34
- r"""Suppression key expression used to uniquely identify events to suppress. For example, `${ip}:${port}` will use fields ip and port from each event to generate the key."""
35
-
36
- allow: Optional[float] = 1
37
- r"""The number of events to allow per time period"""
38
-
39
- suppress_period_sec: Annotated[
40
- Optional[float], pydantic.Field(alias="suppressPeriodSec")
41
- ] = 30
42
- r"""The number of seconds to suppress events after 'Number to allow' events are received"""
43
-
44
- drop_events_mode: Annotated[
45
- Optional[bool], pydantic.Field(alias="dropEventsMode")
46
- ] = True
47
- r"""If disabled, suppressed events will be tagged with suppress=1 but not dropped"""
48
-
49
- max_cache_size: Annotated[Optional[float], pydantic.Field(alias="maxCacheSize")] = (
50
- 50000
51
- )
52
- r"""The maximum number of keys that can be cached before idle entries are removed. Leave at default unless you understand the implications of changing."""
53
-
54
- cache_idle_timeout_periods: Annotated[
55
- Optional[float], pydantic.Field(alias="cacheIdleTimeoutPeriods")
56
- ] = 2
57
- r"""The number of suppression periods 'Suppression Period' of inactivity before a cache entry is considered idle. Leave at default unless you understand the implications of changing."""
58
-
59
- num_events_idle_timeout_trigger: Annotated[
60
- Optional[float], pydantic.Field(alias="numEventsIdleTimeoutTrigger")
61
- ] = 10000
62
- r"""Check cache for idle sessions every N events when cache size is > 'Maximum Cache Size'. Leave at default unless you understand the implications of changing."""
63
-
64
-
65
19
  class FunctionSuppressTypedDict(TypedDict):
66
20
  filename: str
67
21
  group: str
@@ -76,7 +30,7 @@ class FunctionSuppressTypedDict(TypedDict):
76
30
  disabled: NotRequired[bool]
77
31
  handle_signals: NotRequired[bool]
78
32
  sync: NotRequired[bool]
79
- schema_: NotRequired[FunctionSuppressSchemaTypedDict]
33
+ schema_: NotRequired[FunctionConfSchemaSuppressTypedDict]
80
34
 
81
35
 
82
36
  class FunctionSuppress(BaseModel):
@@ -111,5 +65,5 @@ class FunctionSuppress(BaseModel):
111
65
  sync: Optional[bool] = None
112
66
 
113
67
  schema_: Annotated[
114
- Optional[FunctionSuppressSchema], pydantic.Field(alias="schema")
68
+ Optional[FunctionConfSchemaSuppress], pydantic.Field(alias="schema")
115
69
  ] = None
@@ -1,10 +1,11 @@
1
1
  """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
2
2
 
3
3
  from __future__ import annotations
4
+ from .functionconfschematee import FunctionConfSchemaTee, FunctionConfSchemaTeeTypedDict
4
5
  from cribl_control_plane.types import BaseModel
5
6
  from enum import Enum
6
7
  import pydantic
7
- from typing import Any, Dict, List, Optional
8
+ from typing import Any, Dict, Optional
8
9
  from typing_extensions import Annotated, NotRequired, TypedDict
9
10
 
10
11
 
@@ -12,31 +13,6 @@ class FunctionTeeID(str, Enum):
12
13
  TEE = "tee"
13
14
 
14
15
 
15
- class FunctionTeeSchemaTypedDict(TypedDict):
16
- command: str
17
- r"""Command to execute and feed events to, via stdin. One JSON-formatted event per line."""
18
- args: NotRequired[List[str]]
19
- restart_on_exit: NotRequired[bool]
20
- r"""Restart the process if it exits and/or we fail to write to it"""
21
- env: NotRequired[Dict[str, str]]
22
- r"""Environment variables to overwrite or set"""
23
-
24
-
25
- class FunctionTeeSchema(BaseModel):
26
- command: str
27
- r"""Command to execute and feed events to, via stdin. One JSON-formatted event per line."""
28
-
29
- args: Optional[List[str]] = None
30
-
31
- restart_on_exit: Annotated[
32
- Optional[bool], pydantic.Field(alias="restartOnExit")
33
- ] = True
34
- r"""Restart the process if it exits and/or we fail to write to it"""
35
-
36
- env: Optional[Dict[str, str]] = None
37
- r"""Environment variables to overwrite or set"""
38
-
39
-
40
16
  class FunctionTeeTypedDict(TypedDict):
41
17
  filename: str
42
18
  group: str
@@ -51,7 +27,7 @@ class FunctionTeeTypedDict(TypedDict):
51
27
  disabled: NotRequired[bool]
52
28
  handle_signals: NotRequired[bool]
53
29
  sync: NotRequired[bool]
54
- schema_: NotRequired[FunctionTeeSchemaTypedDict]
30
+ schema_: NotRequired[FunctionConfSchemaTeeTypedDict]
55
31
 
56
32
 
57
33
  class FunctionTee(BaseModel):
@@ -85,6 +61,6 @@ class FunctionTee(BaseModel):
85
61
 
86
62
  sync: Optional[bool] = None
87
63
 
88
- schema_: Annotated[Optional[FunctionTeeSchema], pydantic.Field(alias="schema")] = (
89
- None
90
- )
64
+ schema_: Annotated[
65
+ Optional[FunctionConfSchemaTee], pydantic.Field(alias="schema")
66
+ ] = None
@@ -1,6 +1,10 @@
1
1
  """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
2
2
 
3
3
  from __future__ import annotations
4
+ from .functionconfschematrimtimestamp import (
5
+ FunctionConfSchemaTrimTimestamp,
6
+ FunctionConfSchemaTrimTimestampTypedDict,
7
+ )
4
8
  from cribl_control_plane.types import BaseModel
5
9
  from enum import Enum
6
10
  import pydantic
@@ -12,16 +16,6 @@ class FunctionTrimTimestampID(str, Enum):
12
16
  TRIM_TIMESTAMP = "trim_timestamp"
13
17
 
14
18
 
15
- class FunctionTrimTimestampSchemaTypedDict(TypedDict):
16
- field: NotRequired[str]
17
- r"""Name of field in which to save the timestamp. (If empty, timestamp will not be saved to a field.)"""
18
-
19
-
20
- class FunctionTrimTimestampSchema(BaseModel):
21
- field: Optional[str] = None
22
- r"""Name of field in which to save the timestamp. (If empty, timestamp will not be saved to a field.)"""
23
-
24
-
25
19
  class FunctionTrimTimestampTypedDict(TypedDict):
26
20
  filename: str
27
21
  group: str
@@ -36,7 +30,7 @@ class FunctionTrimTimestampTypedDict(TypedDict):
36
30
  disabled: NotRequired[bool]
37
31
  handle_signals: NotRequired[bool]
38
32
  sync: NotRequired[bool]
39
- schema_: NotRequired[FunctionTrimTimestampSchemaTypedDict]
33
+ schema_: NotRequired[FunctionConfSchemaTrimTimestampTypedDict]
40
34
 
41
35
 
42
36
  class FunctionTrimTimestamp(BaseModel):
@@ -71,5 +65,5 @@ class FunctionTrimTimestamp(BaseModel):
71
65
  sync: Optional[bool] = None
72
66
 
73
67
  schema_: Annotated[
74
- Optional[FunctionTrimTimestampSchema], pydantic.Field(alias="schema")
68
+ Optional[FunctionConfSchemaTrimTimestamp], pydantic.Field(alias="schema")
75
69
  ] = None
@@ -1,10 +1,14 @@
1
1
  """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
2
2
 
3
3
  from __future__ import annotations
4
+ from .functionconfschemaunion import (
5
+ FunctionConfSchemaUnion,
6
+ FunctionConfSchemaUnionTypedDict,
7
+ )
4
8
  from cribl_control_plane.types import BaseModel
5
9
  from enum import Enum
6
10
  import pydantic
7
- from typing import Any, Dict, List, Optional
11
+ from typing import Any, Dict, Optional
8
12
  from typing_extensions import Annotated, NotRequired, TypedDict
9
13
 
10
14
 
@@ -12,21 +16,6 @@ class FunctionUnionID(str, Enum):
12
16
  UNION = "union"
13
17
 
14
18
 
15
- class UnionConfigurationTypedDict(TypedDict):
16
- search_job_id: str
17
- r"""The id for this search job."""
18
- stage_ids: List[str]
19
- r"""The stages we are unioning with."""
20
-
21
-
22
- class UnionConfiguration(BaseModel):
23
- search_job_id: Annotated[str, pydantic.Field(alias="searchJobId")]
24
- r"""The id for this search job."""
25
-
26
- stage_ids: Annotated[List[str], pydantic.Field(alias="stageIds")]
27
- r"""The stages we are unioning with."""
28
-
29
-
30
19
  class FunctionUnionTypedDict(TypedDict):
31
20
  filename: str
32
21
  group: str
@@ -41,7 +30,7 @@ class FunctionUnionTypedDict(TypedDict):
41
30
  disabled: NotRequired[bool]
42
31
  handle_signals: NotRequired[bool]
43
32
  sync: NotRequired[bool]
44
- schema_: NotRequired[UnionConfigurationTypedDict]
33
+ schema_: NotRequired[FunctionConfSchemaUnionTypedDict]
45
34
 
46
35
 
47
36
  class FunctionUnion(BaseModel):
@@ -75,6 +64,6 @@ class FunctionUnion(BaseModel):
75
64
 
76
65
  sync: Optional[bool] = None
77
66
 
78
- schema_: Annotated[Optional[UnionConfiguration], pydantic.Field(alias="schema")] = (
79
- None
80
- )
67
+ schema_: Annotated[
68
+ Optional[FunctionConfSchemaUnion], pydantic.Field(alias="schema")
69
+ ] = None
@@ -1,6 +1,10 @@
1
1
  """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
2
2
 
3
3
  from __future__ import annotations
4
+ from .functionconfschemaunroll import (
5
+ FunctionConfSchemaUnroll,
6
+ FunctionConfSchemaUnrollTypedDict,
7
+ )
4
8
  from cribl_control_plane.types import BaseModel
5
9
  from enum import Enum
6
10
  import pydantic
@@ -12,21 +16,6 @@ class FunctionUnrollID(str, Enum):
12
16
  UNROLL = "unroll"
13
17
 
14
18
 
15
- class FunctionUnrollSchemaTypedDict(TypedDict):
16
- src_expr: NotRequired[str]
17
- r"""Field in which to find/calculate the array to unroll. Example: _raw, _raw.split(/\n/)"""
18
- dst_field: NotRequired[str]
19
- r"""Field in destination event in which to place the unrolled value"""
20
-
21
-
22
- class FunctionUnrollSchema(BaseModel):
23
- src_expr: Annotated[Optional[str], pydantic.Field(alias="srcExpr")] = "_raw"
24
- r"""Field in which to find/calculate the array to unroll. Example: _raw, _raw.split(/\n/)"""
25
-
26
- dst_field: Annotated[Optional[str], pydantic.Field(alias="dstField")] = "_raw"
27
- r"""Field in destination event in which to place the unrolled value"""
28
-
29
-
30
19
  class FunctionUnrollTypedDict(TypedDict):
31
20
  filename: str
32
21
  group: str
@@ -41,7 +30,7 @@ class FunctionUnrollTypedDict(TypedDict):
41
30
  disabled: NotRequired[bool]
42
31
  handle_signals: NotRequired[bool]
43
32
  sync: NotRequired[bool]
44
- schema_: NotRequired[FunctionUnrollSchemaTypedDict]
33
+ schema_: NotRequired[FunctionConfSchemaUnrollTypedDict]
45
34
 
46
35
 
47
36
  class FunctionUnroll(BaseModel):
@@ -76,5 +65,5 @@ class FunctionUnroll(BaseModel):
76
65
  sync: Optional[bool] = None
77
66
 
78
67
  schema_: Annotated[
79
- Optional[FunctionUnrollSchema], pydantic.Field(alias="schema")
68
+ Optional[FunctionConfSchemaUnroll], pydantic.Field(alias="schema")
80
69
  ] = None
@@ -1,10 +1,14 @@
1
1
  """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
2
2
 
3
3
  from __future__ import annotations
4
+ from .functionconfschemawindow import (
5
+ FunctionConfSchemaWindow,
6
+ FunctionConfSchemaWindowTypedDict,
7
+ )
4
8
  from cribl_control_plane.types import BaseModel
5
9
  from enum import Enum
6
10
  import pydantic
7
- from typing import Any, Dict, List, Optional
11
+ from typing import Any, Dict, Optional
8
12
  from typing_extensions import Annotated, NotRequired, TypedDict
9
13
 
10
14
 
@@ -12,37 +16,6 @@ class FunctionWindowID(str, Enum):
12
16
  WINDOW = "window"
13
17
 
14
18
 
15
- class FunctionWindowSchemaTypedDict(TypedDict):
16
- event_window_id: float
17
- r"""Identifies the unique ID, used for a event window"""
18
- registered_functions: List[str]
19
- r"""All window functions, tracked by this event window"""
20
- tail_event_count: NotRequired[float]
21
- r"""Number of events to keep before the current event in the window"""
22
- head_event_count: NotRequired[float]
23
- r"""Number of events to keep after the current event in the window"""
24
-
25
-
26
- class FunctionWindowSchema(BaseModel):
27
- event_window_id: Annotated[float, pydantic.Field(alias="eventWindowId")]
28
- r"""Identifies the unique ID, used for a event window"""
29
-
30
- registered_functions: Annotated[
31
- List[str], pydantic.Field(alias="registeredFunctions")
32
- ]
33
- r"""All window functions, tracked by this event window"""
34
-
35
- tail_event_count: Annotated[
36
- Optional[float], pydantic.Field(alias="tailEventCount")
37
- ] = 0
38
- r"""Number of events to keep before the current event in the window"""
39
-
40
- head_event_count: Annotated[
41
- Optional[float], pydantic.Field(alias="headEventCount")
42
- ] = 0
43
- r"""Number of events to keep after the current event in the window"""
44
-
45
-
46
19
  class FunctionWindowTypedDict(TypedDict):
47
20
  filename: str
48
21
  group: str
@@ -57,7 +30,7 @@ class FunctionWindowTypedDict(TypedDict):
57
30
  disabled: NotRequired[bool]
58
31
  handle_signals: NotRequired[bool]
59
32
  sync: NotRequired[bool]
60
- schema_: NotRequired[FunctionWindowSchemaTypedDict]
33
+ schema_: NotRequired[FunctionConfSchemaWindowTypedDict]
61
34
 
62
35
 
63
36
  class FunctionWindow(BaseModel):
@@ -92,5 +65,5 @@ class FunctionWindow(BaseModel):
92
65
  sync: Optional[bool] = None
93
66
 
94
67
  schema_: Annotated[
95
- Optional[FunctionWindowSchema], pydantic.Field(alias="schema")
68
+ Optional[FunctionConfSchemaWindow], pydantic.Field(alias="schema")
96
69
  ] = None
@@ -1,6 +1,10 @@
1
1
  """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
2
2
 
3
3
  from __future__ import annotations
4
+ from .functionconfschemaxmlunroll import (
5
+ FunctionConfSchemaXMLUnroll,
6
+ FunctionConfSchemaXMLUnrollTypedDict,
7
+ )
4
8
  from cribl_control_plane.types import BaseModel
5
9
  from enum import Enum
6
10
  import pydantic
@@ -12,33 +16,6 @@ class FunctionXMLUnrollID(str, Enum):
12
16
  XML_UNROLL = "xml_unroll"
13
17
 
14
18
 
15
- class FunctionXMLUnrollSchemaTypedDict(TypedDict):
16
- unroll: str
17
- r"""Path to array to unroll. Example: ^root\.child\.ElementToUnroll$"""
18
- inherit: NotRequired[str]
19
- r"""Regex matching elements to copy into each unrolled event. Example: ^root\.(childA|childB|childC)$"""
20
- unroll_idx_field: NotRequired[str]
21
- r"""Add a field with this name, containing the index at which the item was located, starting from 0"""
22
- pretty: NotRequired[bool]
23
- r"""Pretty print the output XML"""
24
-
25
-
26
- class FunctionXMLUnrollSchema(BaseModel):
27
- unroll: str
28
- r"""Path to array to unroll. Example: ^root\.child\.ElementToUnroll$"""
29
-
30
- inherit: Optional[str] = None
31
- r"""Regex matching elements to copy into each unrolled event. Example: ^root\.(childA|childB|childC)$"""
32
-
33
- unroll_idx_field: Annotated[
34
- Optional[str], pydantic.Field(alias="unrollIdxField")
35
- ] = "unroll_idx"
36
- r"""Add a field with this name, containing the index at which the item was located, starting from 0"""
37
-
38
- pretty: Optional[bool] = False
39
- r"""Pretty print the output XML"""
40
-
41
-
42
19
  class FunctionXMLUnrollTypedDict(TypedDict):
43
20
  filename: str
44
21
  group: str
@@ -53,7 +30,7 @@ class FunctionXMLUnrollTypedDict(TypedDict):
53
30
  disabled: NotRequired[bool]
54
31
  handle_signals: NotRequired[bool]
55
32
  sync: NotRequired[bool]
56
- schema_: NotRequired[FunctionXMLUnrollSchemaTypedDict]
33
+ schema_: NotRequired[FunctionConfSchemaXMLUnrollTypedDict]
57
34
 
58
35
 
59
36
  class FunctionXMLUnroll(BaseModel):
@@ -88,5 +65,5 @@ class FunctionXMLUnroll(BaseModel):
88
65
  sync: Optional[bool] = None
89
66
 
90
67
  schema_: Annotated[
91
- Optional[FunctionXMLUnrollSchema], pydantic.Field(alias="schema")
68
+ Optional[FunctionConfSchemaXMLUnroll], pydantic.Field(alias="schema")
92
69
  ] = None
@@ -0,0 +1,33 @@
1
+ """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
2
+
3
+ from __future__ import annotations
4
+ from cribl_control_plane.types import BaseModel
5
+ from cribl_control_plane.utils import (
6
+ FieldMetadata,
7
+ PathParamMetadata,
8
+ QueryParamMetadata,
9
+ )
10
+ import pydantic
11
+ from typing import Optional
12
+ from typing_extensions import Annotated, NotRequired, TypedDict
13
+
14
+
15
+ class GetSavedJobByIDRequestTypedDict(TypedDict):
16
+ id: str
17
+ r"""The <code>id</code> of the Collector to get."""
18
+ cribl_pack: NotRequired[str]
19
+ r"""The <code>id</code> of the Pack that includes the Collector to get."""
20
+
21
+
22
+ class GetSavedJobByIDRequest(BaseModel):
23
+ id: Annotated[
24
+ str, FieldMetadata(path=PathParamMetadata(style="simple", explode=False))
25
+ ]
26
+ r"""The <code>id</code> of the Collector to get."""
27
+
28
+ cribl_pack: Annotated[
29
+ Optional[str],
30
+ pydantic.Field(alias="criblPack"),
31
+ FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
32
+ ] = None
33
+ r"""The <code>id</code> of the Pack that includes the Collector to get."""
@@ -0,0 +1,40 @@
1
+ """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
2
+
3
+ from __future__ import annotations
4
+ from cribl_control_plane.types import BaseModel
5
+ from cribl_control_plane.utils import FieldMetadata, QueryParamMetadata
6
+ import pydantic
7
+ from typing import Optional
8
+ from typing_extensions import Annotated, NotRequired, TypedDict
9
+
10
+
11
+ class GetSavedJobRequestTypedDict(TypedDict):
12
+ collector_type: NotRequired[str]
13
+ r"""Filter by collector type"""
14
+ cribl_pack: NotRequired[str]
15
+ r"""Pack ID"""
16
+ group_id: NotRequired[str]
17
+ r"""Worker group ID"""
18
+
19
+
20
+ class GetSavedJobRequest(BaseModel):
21
+ collector_type: Annotated[
22
+ Optional[str],
23
+ pydantic.Field(alias="collectorType"),
24
+ FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
25
+ ] = None
26
+ r"""Filter by collector type"""
27
+
28
+ cribl_pack: Annotated[
29
+ Optional[str],
30
+ pydantic.Field(alias="criblPack"),
31
+ FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
32
+ ] = None
33
+ r"""Pack ID"""
34
+
35
+ group_id: Annotated[
36
+ Optional[str],
37
+ pydantic.Field(alias="groupId"),
38
+ FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
39
+ ] = None
40
+ r"""Worker group ID"""
@@ -55,6 +55,9 @@ class GroupCreateRequestGit(BaseModel):
55
55
 
56
56
 
57
57
  class GroupCreateRequestType(str, Enum, metaclass=utils.OpenEnumMeta):
58
+ EDGE = "edge"
59
+ STREAM = "stream"
60
+ SEARCH = "search"
58
61
  LAKE_ACCESS = "lake_access"
59
62
  LOCAL_SEARCH = "local_search"
60
63