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,499 @@
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 OutputGoogleCloudStorageType(str, Enum, metaclass=utils.OpenEnumMeta):
15
+ GOOGLE_CLOUD_STORAGE = "google_cloud_storage"
16
+
17
+
18
+ class OutputGoogleCloudStorageSignatureVersion(str, Enum, metaclass=utils.OpenEnumMeta):
19
+ r"""Signature version to use for signing Google Cloud Storage requests"""
20
+
21
+ V2 = "v2"
22
+ V4 = "v4"
23
+
24
+
25
+ class OutputGoogleCloudStorageAuthenticationMethod(
26
+ str, Enum, metaclass=utils.OpenEnumMeta
27
+ ):
28
+ AUTO = "auto"
29
+ MANUAL = "manual"
30
+ SECRET = "secret"
31
+
32
+
33
+ class OutputGoogleCloudStorageObjectACL(str, Enum, metaclass=utils.OpenEnumMeta):
34
+ r"""Object ACL to assign to uploaded objects"""
35
+
36
+ PRIVATE = "private"
37
+ BUCKET_OWNER_READ = "bucket-owner-read"
38
+ BUCKET_OWNER_FULL_CONTROL = "bucket-owner-full-control"
39
+ PROJECT_PRIVATE = "project-private"
40
+ AUTHENTICATED_READ = "authenticated-read"
41
+ PUBLIC_READ = "public-read"
42
+
43
+
44
+ class OutputGoogleCloudStorageStorageClass(str, Enum, metaclass=utils.OpenEnumMeta):
45
+ r"""Storage class to select for uploaded objects"""
46
+
47
+ STANDARD = "STANDARD"
48
+ NEARLINE = "NEARLINE"
49
+ COLDLINE = "COLDLINE"
50
+ ARCHIVE = "ARCHIVE"
51
+
52
+
53
+ class OutputGoogleCloudStorageDataFormat(str, Enum, metaclass=utils.OpenEnumMeta):
54
+ r"""Format of the output data"""
55
+
56
+ JSON = "json"
57
+ RAW = "raw"
58
+ PARQUET = "parquet"
59
+
60
+
61
+ class OutputGoogleCloudStorageBackpressureBehavior(
62
+ str, Enum, metaclass=utils.OpenEnumMeta
63
+ ):
64
+ r"""How to handle events when all receivers are exerting backpressure"""
65
+
66
+ BLOCK = "block"
67
+ DROP = "drop"
68
+
69
+
70
+ class OutputGoogleCloudStorageDiskSpaceProtection(
71
+ str, Enum, metaclass=utils.OpenEnumMeta
72
+ ):
73
+ r"""How to handle events when disk space is below the global 'Min free disk space' limit"""
74
+
75
+ BLOCK = "block"
76
+ DROP = "drop"
77
+
78
+
79
+ class OutputGoogleCloudStorageCompression(str, Enum, metaclass=utils.OpenEnumMeta):
80
+ r"""Data compression format to apply to HTTP content before it is delivered"""
81
+
82
+ NONE = "none"
83
+ GZIP = "gzip"
84
+
85
+
86
+ class OutputGoogleCloudStorageCompressionLevel(str, Enum, metaclass=utils.OpenEnumMeta):
87
+ r"""Compression level to apply before moving files to final destination"""
88
+
89
+ BEST_SPEED = "best_speed"
90
+ NORMAL = "normal"
91
+ BEST_COMPRESSION = "best_compression"
92
+
93
+
94
+ class OutputGoogleCloudStorageParquetVersion(str, Enum, metaclass=utils.OpenEnumMeta):
95
+ r"""Determines which data types are supported and how they are represented"""
96
+
97
+ PARQUET_1_0 = "PARQUET_1_0"
98
+ PARQUET_2_4 = "PARQUET_2_4"
99
+ PARQUET_2_6 = "PARQUET_2_6"
100
+
101
+
102
+ class OutputGoogleCloudStorageDataPageVersion(str, Enum, metaclass=utils.OpenEnumMeta):
103
+ r"""Serialization format of data pages. Note that some reader implementations use Data page V2's attributes to work more efficiently, while others ignore it."""
104
+
105
+ DATA_PAGE_V1 = "DATA_PAGE_V1"
106
+ DATA_PAGE_V2 = "DATA_PAGE_V2"
107
+
108
+
109
+ class OutputGoogleCloudStorageKeyValueMetadatumTypedDict(TypedDict):
110
+ value: str
111
+ key: NotRequired[str]
112
+
113
+
114
+ class OutputGoogleCloudStorageKeyValueMetadatum(BaseModel):
115
+ value: str
116
+
117
+ key: Optional[str] = ""
118
+
119
+
120
+ class OutputGoogleCloudStorageTypedDict(TypedDict):
121
+ bucket: str
122
+ r"""Name of the destination bucket. This value can be a constant or a JavaScript expression that can only be evaluated at init time. Example of referencing a Global Variable: `myBucket-${C.vars.myVar}`."""
123
+ region: str
124
+ r"""Region where the bucket is located"""
125
+ id: NotRequired[str]
126
+ r"""Unique ID for this output"""
127
+ type: NotRequired[OutputGoogleCloudStorageType]
128
+ pipeline: NotRequired[str]
129
+ r"""Pipeline to process data before sending out to this output"""
130
+ system_fields: NotRequired[List[str]]
131
+ r"""Fields to automatically add to events, such as cribl_pipe. Supports wildcards."""
132
+ environment: NotRequired[str]
133
+ r"""Optionally, enable this config only on a specified Git branch. If empty, will be enabled everywhere."""
134
+ streamtags: NotRequired[List[str]]
135
+ r"""Tags for filtering and grouping in @{product}"""
136
+ endpoint: NotRequired[str]
137
+ r"""Google Cloud Storage service endpoint"""
138
+ signature_version: NotRequired[OutputGoogleCloudStorageSignatureVersion]
139
+ r"""Signature version to use for signing Google Cloud Storage requests"""
140
+ aws_authentication_method: NotRequired[OutputGoogleCloudStorageAuthenticationMethod]
141
+ stage_path: NotRequired[str]
142
+ r"""Filesystem location in which to buffer files, before compressing and moving to final destination. Use performant and stable storage."""
143
+ dest_path: NotRequired[str]
144
+ r"""Prefix to append to files before uploading. Must be a JavaScript expression (which can evaluate to a constant value), enclosed in quotes or backticks. Can be evaluated only at init time. Example referencing a Global Variable: `myKeyPrefix-${C.vars.myVar}`"""
145
+ verify_permissions: NotRequired[bool]
146
+ r"""Disable if you can access files within the bucket but not the bucket itself"""
147
+ object_acl: NotRequired[OutputGoogleCloudStorageObjectACL]
148
+ r"""Object ACL to assign to uploaded objects"""
149
+ storage_class: NotRequired[OutputGoogleCloudStorageStorageClass]
150
+ r"""Storage class to select for uploaded objects"""
151
+ reuse_connections: NotRequired[bool]
152
+ r"""Reuse connections between requests, which can improve performance"""
153
+ reject_unauthorized: NotRequired[bool]
154
+ r"""Reject certificates that cannot be verified against a valid CA, such as self-signed certificates"""
155
+ add_id_to_stage_path: NotRequired[bool]
156
+ r"""Add the Output ID value to staging location"""
157
+ remove_empty_dirs: NotRequired[bool]
158
+ r"""Remove empty staging directories after moving files"""
159
+ partition_expr: NotRequired[str]
160
+ r"""JavaScript expression defining how files are partitioned and organized. Default is date-based. If blank, Stream will fall back to the event's __partition field value – if present – otherwise to each location's root directory."""
161
+ format_: NotRequired[OutputGoogleCloudStorageDataFormat]
162
+ r"""Format of the output data"""
163
+ base_file_name: NotRequired[str]
164
+ r"""JavaScript expression to define the output filename prefix (can be constant)"""
165
+ file_name_suffix: NotRequired[str]
166
+ r"""JavaScript expression to define the output filename suffix (can be constant). The `__format` variable refers to the value of the `Data format` field (`json` or `raw`). The `__compression` field refers to the kind of compression being used (`none` or `gzip`)."""
167
+ max_file_size_mb: NotRequired[float]
168
+ r"""Maximum uncompressed output file size. Files of this size will be closed and moved to final output location."""
169
+ max_file_open_time_sec: NotRequired[float]
170
+ r"""Maximum amount of time to write to a file. Files open for longer than this will be closed and moved to final output location."""
171
+ max_file_idle_time_sec: NotRequired[float]
172
+ r"""Maximum amount of time to keep inactive files open. Files open for longer than this will be closed and moved to final output location."""
173
+ max_open_files: NotRequired[float]
174
+ r"""Maximum number of files to keep open concurrently. When exceeded, @{product} will close the oldest open files and move them to the final output location."""
175
+ header_line: NotRequired[str]
176
+ r"""If set, this line will be written to the beginning of each output file"""
177
+ write_high_water_mark: NotRequired[float]
178
+ r"""Buffer size used to write to a file"""
179
+ on_backpressure: NotRequired[OutputGoogleCloudStorageBackpressureBehavior]
180
+ r"""How to handle events when all receivers are exerting backpressure"""
181
+ deadletter_enabled: NotRequired[bool]
182
+ r"""If a file fails to move to its final destination after the maximum number of retries, move it to a designated directory to prevent further errors"""
183
+ on_disk_full_backpressure: NotRequired[OutputGoogleCloudStorageDiskSpaceProtection]
184
+ r"""How to handle events when disk space is below the global 'Min free disk space' limit"""
185
+ description: NotRequired[str]
186
+ compress: NotRequired[OutputGoogleCloudStorageCompression]
187
+ r"""Data compression format to apply to HTTP content before it is delivered"""
188
+ compression_level: NotRequired[OutputGoogleCloudStorageCompressionLevel]
189
+ r"""Compression level to apply before moving files to final destination"""
190
+ automatic_schema: NotRequired[bool]
191
+ r"""Automatically calculate the schema based on the events of each Parquet file generated"""
192
+ parquet_version: NotRequired[OutputGoogleCloudStorageParquetVersion]
193
+ r"""Determines which data types are supported and how they are represented"""
194
+ parquet_data_page_version: NotRequired[OutputGoogleCloudStorageDataPageVersion]
195
+ r"""Serialization format of data pages. Note that some reader implementations use Data page V2's attributes to work more efficiently, while others ignore it."""
196
+ parquet_row_group_length: NotRequired[float]
197
+ r"""The number of rows that every group will contain. The final group can contain a smaller number of rows."""
198
+ parquet_page_size: NotRequired[str]
199
+ r"""Target memory size for page segments, such as 1MB or 128MB. Generally, lower values improve reading speed, while higher values improve compression."""
200
+ should_log_invalid_rows: NotRequired[bool]
201
+ r"""Log up to 3 rows that @{product} skips due to data mismatch"""
202
+ key_value_metadata: NotRequired[
203
+ List[OutputGoogleCloudStorageKeyValueMetadatumTypedDict]
204
+ ]
205
+ r"""The metadata of files the Destination writes will include the properties you add here as key-value pairs. Useful for tagging. Examples: \"key\":\"OCSF Event Class\", \"value\":\"9001\" """
206
+ enable_statistics: NotRequired[bool]
207
+ r"""Statistics profile an entire file in terms of minimum/maximum values within data, numbers of nulls, etc. You can use Parquet tools to view statistics."""
208
+ enable_write_page_index: NotRequired[bool]
209
+ r"""One page index contains statistics for one data page. Parquet readers use statistics to enable page skipping."""
210
+ enable_page_checksum: NotRequired[bool]
211
+ r"""Parquet tools can use the checksum of a Parquet page to verify data integrity"""
212
+ empty_dir_cleanup_sec: NotRequired[float]
213
+ r"""How frequently, in seconds, to clean up empty directories"""
214
+ deadletter_path: NotRequired[str]
215
+ r"""Storage location for files that fail to reach their final destination after maximum retries are exceeded"""
216
+ max_retry_num: NotRequired[float]
217
+ r"""The maximum number of times a file will attempt to move to its final destination before being dead-lettered"""
218
+ aws_api_key: NotRequired[str]
219
+ r"""HMAC access key. This value can be a constant or a JavaScript expression, such as `${C.env.GCS_ACCESS_KEY}`."""
220
+ aws_secret_key: NotRequired[str]
221
+ r"""HMAC secret. This value can be a constant or a JavaScript expression, such as `${C.env.GCS_SECRET}`."""
222
+ aws_secret: NotRequired[str]
223
+ r"""Select or create a stored secret that references your access key and secret key"""
224
+
225
+
226
+ class OutputGoogleCloudStorage(BaseModel):
227
+ bucket: str
228
+ r"""Name of the destination bucket. This value can be a constant or a JavaScript expression that can only be evaluated at init time. Example of referencing a Global Variable: `myBucket-${C.vars.myVar}`."""
229
+
230
+ region: str
231
+ r"""Region where the bucket is located"""
232
+
233
+ id: Optional[str] = None
234
+ r"""Unique ID for this output"""
235
+
236
+ type: Annotated[
237
+ Optional[OutputGoogleCloudStorageType],
238
+ PlainValidator(validate_open_enum(False)),
239
+ ] = None
240
+
241
+ pipeline: Optional[str] = None
242
+ r"""Pipeline to process data before sending out to this output"""
243
+
244
+ system_fields: Annotated[
245
+ Optional[List[str]], pydantic.Field(alias="systemFields")
246
+ ] = None
247
+ r"""Fields to automatically add to events, such as cribl_pipe. Supports wildcards."""
248
+
249
+ environment: Optional[str] = None
250
+ r"""Optionally, enable this config only on a specified Git branch. If empty, will be enabled everywhere."""
251
+
252
+ streamtags: Optional[List[str]] = None
253
+ r"""Tags for filtering and grouping in @{product}"""
254
+
255
+ endpoint: Optional[str] = "https://storage.googleapis.com"
256
+ r"""Google Cloud Storage service endpoint"""
257
+
258
+ signature_version: Annotated[
259
+ Annotated[
260
+ Optional[OutputGoogleCloudStorageSignatureVersion],
261
+ PlainValidator(validate_open_enum(False)),
262
+ ],
263
+ pydantic.Field(alias="signatureVersion"),
264
+ ] = OutputGoogleCloudStorageSignatureVersion.V4
265
+ r"""Signature version to use for signing Google Cloud Storage requests"""
266
+
267
+ aws_authentication_method: Annotated[
268
+ Annotated[
269
+ Optional[OutputGoogleCloudStorageAuthenticationMethod],
270
+ PlainValidator(validate_open_enum(False)),
271
+ ],
272
+ pydantic.Field(alias="awsAuthenticationMethod"),
273
+ ] = OutputGoogleCloudStorageAuthenticationMethod.MANUAL
274
+
275
+ stage_path: Annotated[Optional[str], pydantic.Field(alias="stagePath")] = (
276
+ "$CRIBL_HOME/state/outputs/staging"
277
+ )
278
+ r"""Filesystem location in which to buffer files, before compressing and moving to final destination. Use performant and stable storage."""
279
+
280
+ dest_path: Annotated[Optional[str], pydantic.Field(alias="destPath")] = ""
281
+ r"""Prefix to append to files before uploading. Must be a JavaScript expression (which can evaluate to a constant value), enclosed in quotes or backticks. Can be evaluated only at init time. Example referencing a Global Variable: `myKeyPrefix-${C.vars.myVar}`"""
282
+
283
+ verify_permissions: Annotated[
284
+ Optional[bool], pydantic.Field(alias="verifyPermissions")
285
+ ] = True
286
+ r"""Disable if you can access files within the bucket but not the bucket itself"""
287
+
288
+ object_acl: Annotated[
289
+ Annotated[
290
+ Optional[OutputGoogleCloudStorageObjectACL],
291
+ PlainValidator(validate_open_enum(False)),
292
+ ],
293
+ pydantic.Field(alias="objectACL"),
294
+ ] = OutputGoogleCloudStorageObjectACL.PRIVATE
295
+ r"""Object ACL to assign to uploaded objects"""
296
+
297
+ storage_class: Annotated[
298
+ Annotated[
299
+ Optional[OutputGoogleCloudStorageStorageClass],
300
+ PlainValidator(validate_open_enum(False)),
301
+ ],
302
+ pydantic.Field(alias="storageClass"),
303
+ ] = None
304
+ r"""Storage class to select for uploaded objects"""
305
+
306
+ reuse_connections: Annotated[
307
+ Optional[bool], pydantic.Field(alias="reuseConnections")
308
+ ] = True
309
+ r"""Reuse connections between requests, which can improve performance"""
310
+
311
+ reject_unauthorized: Annotated[
312
+ Optional[bool], pydantic.Field(alias="rejectUnauthorized")
313
+ ] = True
314
+ r"""Reject certificates that cannot be verified against a valid CA, such as self-signed certificates"""
315
+
316
+ add_id_to_stage_path: Annotated[
317
+ Optional[bool], pydantic.Field(alias="addIdToStagePath")
318
+ ] = True
319
+ r"""Add the Output ID value to staging location"""
320
+
321
+ remove_empty_dirs: Annotated[
322
+ Optional[bool], pydantic.Field(alias="removeEmptyDirs")
323
+ ] = True
324
+ r"""Remove empty staging directories after moving files"""
325
+
326
+ partition_expr: Annotated[Optional[str], pydantic.Field(alias="partitionExpr")] = (
327
+ "C.Time.strftime(_time ? _time : Date.now()/1000, '%Y/%m/%d')"
328
+ )
329
+ r"""JavaScript expression defining how files are partitioned and organized. Default is date-based. If blank, Stream will fall back to the event's __partition field value – if present – otherwise to each location's root directory."""
330
+
331
+ format_: Annotated[
332
+ Annotated[
333
+ Optional[OutputGoogleCloudStorageDataFormat],
334
+ PlainValidator(validate_open_enum(False)),
335
+ ],
336
+ pydantic.Field(alias="format"),
337
+ ] = OutputGoogleCloudStorageDataFormat.JSON
338
+ r"""Format of the output data"""
339
+
340
+ base_file_name: Annotated[Optional[str], pydantic.Field(alias="baseFileName")] = (
341
+ "`CriblOut`"
342
+ )
343
+ r"""JavaScript expression to define the output filename prefix (can be constant)"""
344
+
345
+ file_name_suffix: Annotated[
346
+ Optional[str], pydantic.Field(alias="fileNameSuffix")
347
+ ] = '`.${C.env["CRIBL_WORKER_ID"]}.${__format}${__compression === "gzip" ? ".gz" : ""}`'
348
+ r"""JavaScript expression to define the output filename suffix (can be constant). The `__format` variable refers to the value of the `Data format` field (`json` or `raw`). The `__compression` field refers to the kind of compression being used (`none` or `gzip`)."""
349
+
350
+ max_file_size_mb: Annotated[
351
+ Optional[float], pydantic.Field(alias="maxFileSizeMB")
352
+ ] = 32
353
+ r"""Maximum uncompressed output file size. Files of this size will be closed and moved to final output location."""
354
+
355
+ max_file_open_time_sec: Annotated[
356
+ Optional[float], pydantic.Field(alias="maxFileOpenTimeSec")
357
+ ] = 300
358
+ r"""Maximum amount of time to write to a file. Files open for longer than this will be closed and moved to final output location."""
359
+
360
+ max_file_idle_time_sec: Annotated[
361
+ Optional[float], pydantic.Field(alias="maxFileIdleTimeSec")
362
+ ] = 30
363
+ r"""Maximum amount of time to keep inactive files open. Files open for longer than this will be closed and moved to final output location."""
364
+
365
+ max_open_files: Annotated[Optional[float], pydantic.Field(alias="maxOpenFiles")] = (
366
+ 100
367
+ )
368
+ r"""Maximum number of files to keep open concurrently. When exceeded, @{product} will close the oldest open files and move them to the final output location."""
369
+
370
+ header_line: Annotated[Optional[str], pydantic.Field(alias="headerLine")] = ""
371
+ r"""If set, this line will be written to the beginning of each output file"""
372
+
373
+ write_high_water_mark: Annotated[
374
+ Optional[float], pydantic.Field(alias="writeHighWaterMark")
375
+ ] = 64
376
+ r"""Buffer size used to write to a file"""
377
+
378
+ on_backpressure: Annotated[
379
+ Annotated[
380
+ Optional[OutputGoogleCloudStorageBackpressureBehavior],
381
+ PlainValidator(validate_open_enum(False)),
382
+ ],
383
+ pydantic.Field(alias="onBackpressure"),
384
+ ] = OutputGoogleCloudStorageBackpressureBehavior.BLOCK
385
+ r"""How to handle events when all receivers are exerting backpressure"""
386
+
387
+ deadletter_enabled: Annotated[
388
+ Optional[bool], pydantic.Field(alias="deadletterEnabled")
389
+ ] = False
390
+ r"""If a file fails to move to its final destination after the maximum number of retries, move it to a designated directory to prevent further errors"""
391
+
392
+ on_disk_full_backpressure: Annotated[
393
+ Annotated[
394
+ Optional[OutputGoogleCloudStorageDiskSpaceProtection],
395
+ PlainValidator(validate_open_enum(False)),
396
+ ],
397
+ pydantic.Field(alias="onDiskFullBackpressure"),
398
+ ] = OutputGoogleCloudStorageDiskSpaceProtection.BLOCK
399
+ r"""How to handle events when disk space is below the global 'Min free disk space' limit"""
400
+
401
+ description: Optional[str] = None
402
+
403
+ compress: Annotated[
404
+ Optional[OutputGoogleCloudStorageCompression],
405
+ PlainValidator(validate_open_enum(False)),
406
+ ] = OutputGoogleCloudStorageCompression.GZIP
407
+ r"""Data compression format to apply to HTTP content before it is delivered"""
408
+
409
+ compression_level: Annotated[
410
+ Annotated[
411
+ Optional[OutputGoogleCloudStorageCompressionLevel],
412
+ PlainValidator(validate_open_enum(False)),
413
+ ],
414
+ pydantic.Field(alias="compressionLevel"),
415
+ ] = OutputGoogleCloudStorageCompressionLevel.BEST_SPEED
416
+ r"""Compression level to apply before moving files to final destination"""
417
+
418
+ automatic_schema: Annotated[
419
+ Optional[bool], pydantic.Field(alias="automaticSchema")
420
+ ] = False
421
+ r"""Automatically calculate the schema based on the events of each Parquet file generated"""
422
+
423
+ parquet_version: Annotated[
424
+ Annotated[
425
+ Optional[OutputGoogleCloudStorageParquetVersion],
426
+ PlainValidator(validate_open_enum(False)),
427
+ ],
428
+ pydantic.Field(alias="parquetVersion"),
429
+ ] = OutputGoogleCloudStorageParquetVersion.PARQUET_2_6
430
+ r"""Determines which data types are supported and how they are represented"""
431
+
432
+ parquet_data_page_version: Annotated[
433
+ Annotated[
434
+ Optional[OutputGoogleCloudStorageDataPageVersion],
435
+ PlainValidator(validate_open_enum(False)),
436
+ ],
437
+ pydantic.Field(alias="parquetDataPageVersion"),
438
+ ] = OutputGoogleCloudStorageDataPageVersion.DATA_PAGE_V2
439
+ r"""Serialization format of data pages. Note that some reader implementations use Data page V2's attributes to work more efficiently, while others ignore it."""
440
+
441
+ parquet_row_group_length: Annotated[
442
+ Optional[float], pydantic.Field(alias="parquetRowGroupLength")
443
+ ] = 10000
444
+ r"""The number of rows that every group will contain. The final group can contain a smaller number of rows."""
445
+
446
+ parquet_page_size: Annotated[
447
+ Optional[str], pydantic.Field(alias="parquetPageSize")
448
+ ] = "1MB"
449
+ r"""Target memory size for page segments, such as 1MB or 128MB. Generally, lower values improve reading speed, while higher values improve compression."""
450
+
451
+ should_log_invalid_rows: Annotated[
452
+ Optional[bool], pydantic.Field(alias="shouldLogInvalidRows")
453
+ ] = None
454
+ r"""Log up to 3 rows that @{product} skips due to data mismatch"""
455
+
456
+ key_value_metadata: Annotated[
457
+ Optional[List[OutputGoogleCloudStorageKeyValueMetadatum]],
458
+ pydantic.Field(alias="keyValueMetadata"),
459
+ ] = None
460
+ r"""The metadata of files the Destination writes will include the properties you add here as key-value pairs. Useful for tagging. Examples: \"key\":\"OCSF Event Class\", \"value\":\"9001\" """
461
+
462
+ enable_statistics: Annotated[
463
+ Optional[bool], pydantic.Field(alias="enableStatistics")
464
+ ] = True
465
+ r"""Statistics profile an entire file in terms of minimum/maximum values within data, numbers of nulls, etc. You can use Parquet tools to view statistics."""
466
+
467
+ enable_write_page_index: Annotated[
468
+ Optional[bool], pydantic.Field(alias="enableWritePageIndex")
469
+ ] = True
470
+ r"""One page index contains statistics for one data page. Parquet readers use statistics to enable page skipping."""
471
+
472
+ enable_page_checksum: Annotated[
473
+ Optional[bool], pydantic.Field(alias="enablePageChecksum")
474
+ ] = False
475
+ r"""Parquet tools can use the checksum of a Parquet page to verify data integrity"""
476
+
477
+ empty_dir_cleanup_sec: Annotated[
478
+ Optional[float], pydantic.Field(alias="emptyDirCleanupSec")
479
+ ] = 300
480
+ r"""How frequently, in seconds, to clean up empty directories"""
481
+
482
+ deadletter_path: Annotated[
483
+ Optional[str], pydantic.Field(alias="deadletterPath")
484
+ ] = "$CRIBL_HOME/state/outputs/dead-letter"
485
+ r"""Storage location for files that fail to reach their final destination after maximum retries are exceeded"""
486
+
487
+ max_retry_num: Annotated[Optional[float], pydantic.Field(alias="maxRetryNum")] = 20
488
+ r"""The maximum number of times a file will attempt to move to its final destination before being dead-lettered"""
489
+
490
+ aws_api_key: Annotated[Optional[str], pydantic.Field(alias="awsApiKey")] = None
491
+ r"""HMAC access key. This value can be a constant or a JavaScript expression, such as `${C.env.GCS_ACCESS_KEY}`."""
492
+
493
+ aws_secret_key: Annotated[Optional[str], pydantic.Field(alias="awsSecretKey")] = (
494
+ None
495
+ )
496
+ r"""HMAC secret. This value can be a constant or a JavaScript expression, such as `${C.env.GCS_SECRET}`."""
497
+
498
+ aws_secret: Annotated[Optional[str], pydantic.Field(alias="awsSecret")] = None
499
+ r"""Select or create a stored secret that references your access key and secret key"""