cribl-control-plane 0.2.1rc7__py3-none-any.whl → 0.3.0a1__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Potentially problematic release.
This version of cribl-control-plane might be problematic. Click here for more details.
- cribl_control_plane/_version.py +4 -4
- cribl_control_plane/errors/__init__.py +5 -8
- cribl_control_plane/errors/{healthserverstatus_error.py → healthstatus_error.py} +9 -10
- cribl_control_plane/groups_sdk.py +28 -52
- cribl_control_plane/health.py +16 -22
- cribl_control_plane/models/__init__.py +54 -217
- cribl_control_plane/models/appmode.py +14 -0
- cribl_control_plane/models/authtoken.py +1 -5
- cribl_control_plane/models/cacheconnection.py +0 -20
- cribl_control_plane/models/configgroup.py +7 -55
- cribl_control_plane/models/configgroupcloud.py +1 -11
- cribl_control_plane/models/createconfiggroupbyproductop.py +5 -17
- cribl_control_plane/models/createroutesappendbyidop.py +2 -2
- cribl_control_plane/models/createversionundoop.py +3 -3
- cribl_control_plane/models/cribllakedataset.py +1 -11
- cribl_control_plane/models/cribllakedatasetupdate.py +1 -11
- cribl_control_plane/models/datasetmetadata.py +1 -11
- cribl_control_plane/models/deleteconfiggroupbyproductandidop.py +0 -11
- cribl_control_plane/models/deleteoutputpqbyidop.py +2 -2
- cribl_control_plane/models/distributedsummary.py +0 -6
- cribl_control_plane/models/error.py +16 -0
- cribl_control_plane/models/getconfiggroupaclbyproductandidop.py +0 -20
- cribl_control_plane/models/getconfiggroupaclteamsbyproductandidop.py +0 -20
- cribl_control_plane/models/getconfiggroupbyproductandidop.py +0 -11
- cribl_control_plane/models/getconfiggroupconfigversionbyproductandidop.py +0 -11
- cribl_control_plane/models/gethealthinfoop.py +17 -0
- cribl_control_plane/models/getsummaryop.py +0 -11
- cribl_control_plane/models/hbcriblinfo.py +3 -24
- cribl_control_plane/models/{healthserverstatus.py → healthstatus.py} +8 -27
- cribl_control_plane/models/heartbeatmetadata.py +0 -3
- cribl_control_plane/models/input.py +78 -80
- cribl_control_plane/models/inputappscope.py +17 -80
- cribl_control_plane/models/inputazureblob.py +1 -33
- cribl_control_plane/models/inputcollection.py +1 -24
- cribl_control_plane/models/inputconfluentcloud.py +18 -195
- cribl_control_plane/models/inputcribl.py +1 -24
- cribl_control_plane/models/inputcriblhttp.py +17 -62
- cribl_control_plane/models/inputcribllakehttp.py +17 -62
- cribl_control_plane/models/inputcriblmetrics.py +1 -24
- cribl_control_plane/models/inputcribltcp.py +17 -62
- cribl_control_plane/models/inputcrowdstrike.py +1 -54
- cribl_control_plane/models/inputdatadogagent.py +17 -62
- cribl_control_plane/models/inputdatagen.py +1 -24
- cribl_control_plane/models/inputedgeprometheus.py +34 -147
- cribl_control_plane/models/inputelastic.py +27 -119
- cribl_control_plane/models/inputeventhub.py +1 -182
- cribl_control_plane/models/inputexec.py +1 -33
- cribl_control_plane/models/inputfile.py +3 -42
- cribl_control_plane/models/inputfirehose.py +17 -62
- cribl_control_plane/models/inputgooglepubsub.py +1 -36
- cribl_control_plane/models/inputgrafana.py +32 -157
- cribl_control_plane/models/inputhttp.py +17 -62
- cribl_control_plane/models/inputhttpraw.py +17 -62
- cribl_control_plane/models/inputjournalfiles.py +1 -24
- cribl_control_plane/models/inputkafka.py +17 -189
- cribl_control_plane/models/inputkinesis.py +1 -80
- cribl_control_plane/models/inputkubeevents.py +1 -24
- cribl_control_plane/models/inputkubelogs.py +1 -33
- cribl_control_plane/models/inputkubemetrics.py +1 -33
- cribl_control_plane/models/inputloki.py +17 -71
- cribl_control_plane/models/inputmetrics.py +17 -62
- cribl_control_plane/models/inputmodeldriventelemetry.py +17 -62
- cribl_control_plane/models/inputmsk.py +18 -81
- cribl_control_plane/models/inputnetflow.py +1 -24
- cribl_control_plane/models/inputoffice365mgmt.py +1 -67
- cribl_control_plane/models/inputoffice365msgtrace.py +1 -67
- cribl_control_plane/models/inputoffice365service.py +1 -67
- cribl_control_plane/models/inputopentelemetry.py +16 -92
- cribl_control_plane/models/inputprometheus.py +34 -138
- cribl_control_plane/models/inputprometheusrw.py +17 -71
- cribl_control_plane/models/inputrawudp.py +1 -24
- cribl_control_plane/models/inputs3.py +1 -45
- cribl_control_plane/models/inputs3inventory.py +1 -54
- cribl_control_plane/models/inputsecuritylake.py +1 -54
- cribl_control_plane/models/inputsnmp.py +1 -40
- cribl_control_plane/models/inputsplunk.py +17 -85
- cribl_control_plane/models/inputsplunkhec.py +16 -70
- cribl_control_plane/models/inputsplunksearch.py +1 -63
- cribl_control_plane/models/inputsqs.py +1 -56
- cribl_control_plane/models/inputsyslog.py +32 -121
- cribl_control_plane/models/inputsystemmetrics.py +9 -142
- cribl_control_plane/models/inputsystemstate.py +1 -33
- cribl_control_plane/models/inputtcp.py +17 -81
- cribl_control_plane/models/inputtcpjson.py +17 -71
- cribl_control_plane/models/inputwef.py +1 -71
- cribl_control_plane/models/inputwindowsmetrics.py +9 -129
- cribl_control_plane/models/inputwineventlogs.py +1 -60
- cribl_control_plane/models/inputwiz.py +1 -45
- cribl_control_plane/models/inputwizwebhook.py +17 -62
- cribl_control_plane/models/inputzscalerhec.py +16 -70
- cribl_control_plane/models/jobinfo.py +1 -4
- cribl_control_plane/models/jobstatus.py +3 -34
- cribl_control_plane/models/listconfiggroupbyproductop.py +0 -11
- cribl_control_plane/models/logininfo.py +3 -3
- cribl_control_plane/models/masterworkerentry.py +1 -11
- cribl_control_plane/models/nodeprovidedinfo.py +1 -11
- cribl_control_plane/models/nodeupgradestatus.py +0 -38
- cribl_control_plane/models/output.py +88 -93
- cribl_control_plane/models/outputazureblob.py +1 -110
- cribl_control_plane/models/outputazuredataexplorer.py +87 -452
- cribl_control_plane/models/outputazureeventhub.py +19 -281
- cribl_control_plane/models/outputazurelogs.py +19 -115
- cribl_control_plane/models/outputchronicle.py +19 -115
- cribl_control_plane/models/outputclickhouse.py +19 -155
- cribl_control_plane/models/outputcloudwatch.py +19 -106
- cribl_control_plane/models/outputconfluentcloud.py +38 -311
- cribl_control_plane/models/outputcriblhttp.py +19 -135
- cribl_control_plane/models/outputcribllake.py +1 -97
- cribl_control_plane/models/outputcribltcp.py +19 -132
- cribl_control_plane/models/outputcrowdstrikenextgensiem.py +20 -129
- cribl_control_plane/models/outputdatadog.py +19 -159
- cribl_control_plane/models/outputdataset.py +19 -143
- cribl_control_plane/models/outputdiskspool.py +1 -11
- cribl_control_plane/models/outputdls3.py +1 -152
- cribl_control_plane/models/outputdynatracehttp.py +19 -160
- cribl_control_plane/models/outputdynatraceotlp.py +19 -160
- cribl_control_plane/models/outputelastic.py +19 -163
- cribl_control_plane/models/outputelasticcloud.py +19 -140
- cribl_control_plane/models/outputexabeam.py +1 -61
- cribl_control_plane/models/outputfilesystem.py +1 -87
- cribl_control_plane/models/outputgooglechronicle.py +20 -166
- cribl_control_plane/models/outputgooglecloudlogging.py +20 -131
- cribl_control_plane/models/outputgooglecloudstorage.py +1 -136
- cribl_control_plane/models/outputgooglepubsub.py +19 -106
- cribl_control_plane/models/outputgrafanacloud.py +37 -288
- cribl_control_plane/models/outputgraphite.py +19 -105
- cribl_control_plane/models/outputhoneycomb.py +19 -115
- cribl_control_plane/models/outputhumiohec.py +19 -126
- cribl_control_plane/models/outputinfluxdb.py +19 -130
- cribl_control_plane/models/outputkafka.py +34 -302
- cribl_control_plane/models/outputkinesis.py +19 -133
- cribl_control_plane/models/outputloki.py +17 -129
- cribl_control_plane/models/outputminio.py +1 -145
- cribl_control_plane/models/outputmsk.py +34 -193
- cribl_control_plane/models/outputnewrelic.py +19 -136
- cribl_control_plane/models/outputnewrelicevents.py +20 -128
- cribl_control_plane/models/outputopentelemetry.py +19 -178
- cribl_control_plane/models/outputprometheus.py +19 -115
- cribl_control_plane/models/outputring.py +1 -31
- cribl_control_plane/models/outputs3.py +1 -152
- cribl_control_plane/models/outputsecuritylake.py +1 -114
- cribl_control_plane/models/outputsentinel.py +19 -135
- cribl_control_plane/models/outputsentineloneaisiem.py +20 -134
- cribl_control_plane/models/outputservicenow.py +19 -168
- cribl_control_plane/models/outputsignalfx.py +19 -115
- cribl_control_plane/models/outputsns.py +17 -113
- cribl_control_plane/models/outputsplunk.py +19 -153
- cribl_control_plane/models/outputsplunkhec.py +19 -208
- cribl_control_plane/models/outputsplunklb.py +19 -182
- cribl_control_plane/models/outputsqs.py +17 -124
- cribl_control_plane/models/outputstatsd.py +19 -105
- cribl_control_plane/models/outputstatsdext.py +19 -105
- cribl_control_plane/models/outputsumologic.py +19 -117
- cribl_control_plane/models/outputsyslog.py +96 -259
- cribl_control_plane/models/outputtcpjson.py +19 -141
- cribl_control_plane/models/outputwavefront.py +19 -115
- cribl_control_plane/models/outputwebhook.py +19 -161
- cribl_control_plane/models/outputxsiam.py +17 -113
- cribl_control_plane/models/packinfo.py +5 -8
- cribl_control_plane/models/packinstallinfo.py +5 -8
- cribl_control_plane/models/resourcepolicy.py +0 -11
- cribl_control_plane/models/{uploadpackresponse.py → routecloneconf.py} +4 -4
- cribl_control_plane/models/routeconf.py +4 -3
- cribl_control_plane/models/runnablejobcollection.py +9 -72
- cribl_control_plane/models/runnablejobexecutor.py +9 -32
- cribl_control_plane/models/runnablejobscheduledsearch.py +9 -23
- cribl_control_plane/models/updateconfiggroupbyproductandidop.py +0 -11
- cribl_control_plane/models/updateconfiggroupdeploybyproductandidop.py +0 -11
- cribl_control_plane/packs.py +7 -202
- cribl_control_plane/routes_sdk.py +6 -6
- cribl_control_plane/tokens.py +15 -23
- {cribl_control_plane-0.2.1rc7.dist-info → cribl_control_plane-0.3.0a1.dist-info}/METADATA +9 -50
- cribl_control_plane-0.3.0a1.dist-info/RECORD +330 -0
- cribl_control_plane/models/groupcreaterequest.py +0 -171
- cribl_control_plane/models/outpostnodeinfo.py +0 -16
- cribl_control_plane/models/outputdatabricks.py +0 -482
- cribl_control_plane/models/updatepacksop.py +0 -25
- cribl_control_plane-0.2.1rc7.dist-info/RECORD +0 -331
- {cribl_control_plane-0.2.1rc7.dist-info → cribl_control_plane-0.3.0a1.dist-info}/WHEEL +0 -0
|
@@ -1,12 +1,11 @@
|
|
|
1
1
|
"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
|
|
2
2
|
|
|
3
3
|
from __future__ import annotations
|
|
4
|
-
from cribl_control_plane import
|
|
4
|
+
from cribl_control_plane import utils
|
|
5
5
|
from cribl_control_plane.types import BaseModel
|
|
6
6
|
from cribl_control_plane.utils import validate_open_enum
|
|
7
7
|
from enum import Enum
|
|
8
8
|
import pydantic
|
|
9
|
-
from pydantic import field_serializer
|
|
10
9
|
from pydantic.functional_validators import PlainValidator
|
|
11
10
|
from typing import List, Optional
|
|
12
11
|
from typing_extensions import Annotated, NotRequired, TypedDict
|
|
@@ -19,36 +18,28 @@ class OutputServiceNowType(str, Enum):
|
|
|
19
18
|
class OutputServiceNowOTLPVersion(str, Enum, metaclass=utils.OpenEnumMeta):
|
|
20
19
|
r"""The version of OTLP Protobuf definitions to use when structuring data to send"""
|
|
21
20
|
|
|
22
|
-
# 1.3.1
|
|
23
21
|
ONE_DOT_3_DOT_1 = "1.3.1"
|
|
24
22
|
|
|
25
23
|
|
|
26
24
|
class OutputServiceNowProtocol(str, Enum, metaclass=utils.OpenEnumMeta):
|
|
27
25
|
r"""Select a transport option for OpenTelemetry"""
|
|
28
26
|
|
|
29
|
-
# gRPC
|
|
30
27
|
GRPC = "grpc"
|
|
31
|
-
# HTTP
|
|
32
28
|
HTTP = "http"
|
|
33
29
|
|
|
34
30
|
|
|
35
31
|
class OutputServiceNowCompressCompression(str, Enum, metaclass=utils.OpenEnumMeta):
|
|
36
32
|
r"""Type of compression to apply to messages sent to the OpenTelemetry endpoint"""
|
|
37
33
|
|
|
38
|
-
# None
|
|
39
34
|
NONE = "none"
|
|
40
|
-
# Deflate
|
|
41
35
|
DEFLATE = "deflate"
|
|
42
|
-
# Gzip
|
|
43
36
|
GZIP = "gzip"
|
|
44
37
|
|
|
45
38
|
|
|
46
39
|
class OutputServiceNowHTTPCompressCompression(str, Enum, metaclass=utils.OpenEnumMeta):
|
|
47
40
|
r"""Type of compression to apply to messages sent to the OpenTelemetry endpoint"""
|
|
48
41
|
|
|
49
|
-
# None
|
|
50
42
|
NONE = "none"
|
|
51
|
-
# Gzip
|
|
52
43
|
GZIP = "gzip"
|
|
53
44
|
|
|
54
45
|
|
|
@@ -66,22 +57,16 @@ class OutputServiceNowMetadatum(BaseModel):
|
|
|
66
57
|
class OutputServiceNowFailedRequestLoggingMode(str, Enum, metaclass=utils.OpenEnumMeta):
|
|
67
58
|
r"""Data to log when a request fails. All headers are redacted by default, unless listed as safe headers below."""
|
|
68
59
|
|
|
69
|
-
# Payload
|
|
70
60
|
PAYLOAD = "payload"
|
|
71
|
-
# Payload + Headers
|
|
72
61
|
PAYLOAD_AND_HEADERS = "payloadAndHeaders"
|
|
73
|
-
# None
|
|
74
62
|
NONE = "none"
|
|
75
63
|
|
|
76
64
|
|
|
77
65
|
class OutputServiceNowBackpressureBehavior(str, Enum, metaclass=utils.OpenEnumMeta):
|
|
78
66
|
r"""How to handle events when all receivers are exerting backpressure"""
|
|
79
67
|
|
|
80
|
-
# Block
|
|
81
68
|
BLOCK = "block"
|
|
82
|
-
# Drop
|
|
83
69
|
DROP = "drop"
|
|
84
|
-
# Persistent Queue
|
|
85
70
|
QUEUE = "queue"
|
|
86
71
|
|
|
87
72
|
|
|
@@ -227,54 +212,29 @@ class OutputServiceNowTLSSettingsClientSide(BaseModel):
|
|
|
227
212
|
pydantic.Field(alias="maxVersion"),
|
|
228
213
|
] = None
|
|
229
214
|
|
|
230
|
-
@field_serializer("min_version")
|
|
231
|
-
def serialize_min_version(self, value):
|
|
232
|
-
if isinstance(value, str):
|
|
233
|
-
try:
|
|
234
|
-
return models.OutputServiceNowMinimumTLSVersion(value)
|
|
235
|
-
except ValueError:
|
|
236
|
-
return value
|
|
237
|
-
return value
|
|
238
|
-
|
|
239
|
-
@field_serializer("max_version")
|
|
240
|
-
def serialize_max_version(self, value):
|
|
241
|
-
if isinstance(value, str):
|
|
242
|
-
try:
|
|
243
|
-
return models.OutputServiceNowMaximumTLSVersion(value)
|
|
244
|
-
except ValueError:
|
|
245
|
-
return value
|
|
246
|
-
return value
|
|
247
|
-
|
|
248
|
-
|
|
249
|
-
class OutputServiceNowMode(str, Enum, metaclass=utils.OpenEnumMeta):
|
|
250
|
-
r"""In Error mode, PQ writes events to the filesystem if the Destination is unavailable. In Backpressure mode, PQ writes events to the filesystem when it detects backpressure from the Destination. In Always On mode, PQ always writes events to the filesystem."""
|
|
251
|
-
|
|
252
|
-
# Error
|
|
253
|
-
ERROR = "error"
|
|
254
|
-
# Backpressure
|
|
255
|
-
ALWAYS = "always"
|
|
256
|
-
# Always On
|
|
257
|
-
BACKPRESSURE = "backpressure"
|
|
258
|
-
|
|
259
215
|
|
|
260
216
|
class OutputServiceNowPqCompressCompression(str, Enum, metaclass=utils.OpenEnumMeta):
|
|
261
217
|
r"""Codec to use to compress the persisted data"""
|
|
262
218
|
|
|
263
|
-
# None
|
|
264
219
|
NONE = "none"
|
|
265
|
-
# Gzip
|
|
266
220
|
GZIP = "gzip"
|
|
267
221
|
|
|
268
222
|
|
|
269
223
|
class OutputServiceNowQueueFullBehavior(str, Enum, metaclass=utils.OpenEnumMeta):
|
|
270
224
|
r"""How to handle events when the queue is exerting backpressure (full capacity or low disk). 'Block' is the same behavior as non-PQ blocking. 'Drop new data' throws away incoming data, while leaving the contents of the PQ unchanged."""
|
|
271
225
|
|
|
272
|
-
# Block
|
|
273
226
|
BLOCK = "block"
|
|
274
|
-
# Drop new data
|
|
275
227
|
DROP = "drop"
|
|
276
228
|
|
|
277
229
|
|
|
230
|
+
class OutputServiceNowMode(str, Enum, metaclass=utils.OpenEnumMeta):
|
|
231
|
+
r"""In Error mode, PQ writes events to the filesystem if the Destination is unavailable. In Backpressure mode, PQ writes events to the filesystem when it detects backpressure from the Destination. In Always On mode, PQ always writes events to the filesystem."""
|
|
232
|
+
|
|
233
|
+
ERROR = "error"
|
|
234
|
+
BACKPRESSURE = "backpressure"
|
|
235
|
+
ALWAYS = "always"
|
|
236
|
+
|
|
237
|
+
|
|
278
238
|
class OutputServiceNowPqControlsTypedDict(TypedDict):
|
|
279
239
|
pass
|
|
280
240
|
|
|
@@ -354,16 +314,6 @@ class OutputServiceNowTypedDict(TypedDict):
|
|
|
354
314
|
response_honor_retry_after_header: NotRequired[bool]
|
|
355
315
|
r"""Honor any Retry-After header that specifies a delay (in seconds) no longer than 180 seconds after the retry request. @{product} limits the delay to 180 seconds, even if the Retry-After header specifies a longer delay. When enabled, takes precedence over user-configured retry options. When disabled, all Retry-After headers are ignored."""
|
|
356
316
|
tls: NotRequired[OutputServiceNowTLSSettingsClientSideTypedDict]
|
|
357
|
-
pq_strict_ordering: NotRequired[bool]
|
|
358
|
-
r"""Use FIFO (first in, first out) processing. Disable to forward new events to receivers before queue is flushed."""
|
|
359
|
-
pq_rate_per_sec: NotRequired[float]
|
|
360
|
-
r"""Throttling rate (in events per second) to impose while writing to Destinations from PQ. Defaults to 0, which disables throttling."""
|
|
361
|
-
pq_mode: NotRequired[OutputServiceNowMode]
|
|
362
|
-
r"""In Error mode, PQ writes events to the filesystem if the Destination is unavailable. In Backpressure mode, PQ writes events to the filesystem when it detects backpressure from the Destination. In Always On mode, PQ always writes events to the filesystem."""
|
|
363
|
-
pq_max_buffer_size: NotRequired[float]
|
|
364
|
-
r"""The maximum number of events to hold in memory before writing the events to disk"""
|
|
365
|
-
pq_max_backpressure_sec: NotRequired[float]
|
|
366
|
-
r"""How long (in seconds) to wait for backpressure to resolve before engaging the queue"""
|
|
367
317
|
pq_max_file_size: NotRequired[str]
|
|
368
318
|
r"""The maximum size to store in each queue file before closing and optionally compressing (KB, MB, etc.)"""
|
|
369
319
|
pq_max_size: NotRequired[str]
|
|
@@ -374,6 +324,8 @@ class OutputServiceNowTypedDict(TypedDict):
|
|
|
374
324
|
r"""Codec to use to compress the persisted data"""
|
|
375
325
|
pq_on_backpressure: NotRequired[OutputServiceNowQueueFullBehavior]
|
|
376
326
|
r"""How to handle events when the queue is exerting backpressure (full capacity or low disk). 'Block' is the same behavior as non-PQ blocking. 'Drop new data' throws away incoming data, while leaving the contents of the PQ unchanged."""
|
|
327
|
+
pq_mode: NotRequired[OutputServiceNowMode]
|
|
328
|
+
r"""In Error mode, PQ writes events to the filesystem if the Destination is unavailable. In Backpressure mode, PQ writes events to the filesystem when it detects backpressure from the Destination. In Always On mode, PQ always writes events to the filesystem."""
|
|
377
329
|
pq_controls: NotRequired[OutputServiceNowPqControlsTypedDict]
|
|
378
330
|
|
|
379
331
|
|
|
@@ -545,34 +497,6 @@ class OutputServiceNow(BaseModel):
|
|
|
545
497
|
|
|
546
498
|
tls: Optional[OutputServiceNowTLSSettingsClientSide] = None
|
|
547
499
|
|
|
548
|
-
pq_strict_ordering: Annotated[
|
|
549
|
-
Optional[bool], pydantic.Field(alias="pqStrictOrdering")
|
|
550
|
-
] = True
|
|
551
|
-
r"""Use FIFO (first in, first out) processing. Disable to forward new events to receivers before queue is flushed."""
|
|
552
|
-
|
|
553
|
-
pq_rate_per_sec: Annotated[
|
|
554
|
-
Optional[float], pydantic.Field(alias="pqRatePerSec")
|
|
555
|
-
] = 0
|
|
556
|
-
r"""Throttling rate (in events per second) to impose while writing to Destinations from PQ. Defaults to 0, which disables throttling."""
|
|
557
|
-
|
|
558
|
-
pq_mode: Annotated[
|
|
559
|
-
Annotated[
|
|
560
|
-
Optional[OutputServiceNowMode], PlainValidator(validate_open_enum(False))
|
|
561
|
-
],
|
|
562
|
-
pydantic.Field(alias="pqMode"),
|
|
563
|
-
] = OutputServiceNowMode.ERROR
|
|
564
|
-
r"""In Error mode, PQ writes events to the filesystem if the Destination is unavailable. In Backpressure mode, PQ writes events to the filesystem when it detects backpressure from the Destination. In Always On mode, PQ always writes events to the filesystem."""
|
|
565
|
-
|
|
566
|
-
pq_max_buffer_size: Annotated[
|
|
567
|
-
Optional[float], pydantic.Field(alias="pqMaxBufferSize")
|
|
568
|
-
] = 42
|
|
569
|
-
r"""The maximum number of events to hold in memory before writing the events to disk"""
|
|
570
|
-
|
|
571
|
-
pq_max_backpressure_sec: Annotated[
|
|
572
|
-
Optional[float], pydantic.Field(alias="pqMaxBackpressureSec")
|
|
573
|
-
] = 30
|
|
574
|
-
r"""How long (in seconds) to wait for backpressure to resolve before engaging the queue"""
|
|
575
|
-
|
|
576
500
|
pq_max_file_size: Annotated[
|
|
577
501
|
Optional[str], pydantic.Field(alias="pqMaxFileSize")
|
|
578
502
|
] = "1 MB"
|
|
@@ -604,87 +528,14 @@ class OutputServiceNow(BaseModel):
|
|
|
604
528
|
] = OutputServiceNowQueueFullBehavior.BLOCK
|
|
605
529
|
r"""How to handle events when the queue is exerting backpressure (full capacity or low disk). 'Block' is the same behavior as non-PQ blocking. 'Drop new data' throws away incoming data, while leaving the contents of the PQ unchanged."""
|
|
606
530
|
|
|
531
|
+
pq_mode: Annotated[
|
|
532
|
+
Annotated[
|
|
533
|
+
Optional[OutputServiceNowMode], PlainValidator(validate_open_enum(False))
|
|
534
|
+
],
|
|
535
|
+
pydantic.Field(alias="pqMode"),
|
|
536
|
+
] = OutputServiceNowMode.ERROR
|
|
537
|
+
r"""In Error mode, PQ writes events to the filesystem if the Destination is unavailable. In Backpressure mode, PQ writes events to the filesystem when it detects backpressure from the Destination. In Always On mode, PQ always writes events to the filesystem."""
|
|
538
|
+
|
|
607
539
|
pq_controls: Annotated[
|
|
608
540
|
Optional[OutputServiceNowPqControls], pydantic.Field(alias="pqControls")
|
|
609
541
|
] = None
|
|
610
|
-
|
|
611
|
-
@field_serializer("otlp_version")
|
|
612
|
-
def serialize_otlp_version(self, value):
|
|
613
|
-
if isinstance(value, str):
|
|
614
|
-
try:
|
|
615
|
-
return models.OutputServiceNowOTLPVersion(value)
|
|
616
|
-
except ValueError:
|
|
617
|
-
return value
|
|
618
|
-
return value
|
|
619
|
-
|
|
620
|
-
@field_serializer("protocol")
|
|
621
|
-
def serialize_protocol(self, value):
|
|
622
|
-
if isinstance(value, str):
|
|
623
|
-
try:
|
|
624
|
-
return models.OutputServiceNowProtocol(value)
|
|
625
|
-
except ValueError:
|
|
626
|
-
return value
|
|
627
|
-
return value
|
|
628
|
-
|
|
629
|
-
@field_serializer("compress")
|
|
630
|
-
def serialize_compress(self, value):
|
|
631
|
-
if isinstance(value, str):
|
|
632
|
-
try:
|
|
633
|
-
return models.OutputServiceNowCompressCompression(value)
|
|
634
|
-
except ValueError:
|
|
635
|
-
return value
|
|
636
|
-
return value
|
|
637
|
-
|
|
638
|
-
@field_serializer("http_compress")
|
|
639
|
-
def serialize_http_compress(self, value):
|
|
640
|
-
if isinstance(value, str):
|
|
641
|
-
try:
|
|
642
|
-
return models.OutputServiceNowHTTPCompressCompression(value)
|
|
643
|
-
except ValueError:
|
|
644
|
-
return value
|
|
645
|
-
return value
|
|
646
|
-
|
|
647
|
-
@field_serializer("failed_request_logging_mode")
|
|
648
|
-
def serialize_failed_request_logging_mode(self, value):
|
|
649
|
-
if isinstance(value, str):
|
|
650
|
-
try:
|
|
651
|
-
return models.OutputServiceNowFailedRequestLoggingMode(value)
|
|
652
|
-
except ValueError:
|
|
653
|
-
return value
|
|
654
|
-
return value
|
|
655
|
-
|
|
656
|
-
@field_serializer("on_backpressure")
|
|
657
|
-
def serialize_on_backpressure(self, value):
|
|
658
|
-
if isinstance(value, str):
|
|
659
|
-
try:
|
|
660
|
-
return models.OutputServiceNowBackpressureBehavior(value)
|
|
661
|
-
except ValueError:
|
|
662
|
-
return value
|
|
663
|
-
return value
|
|
664
|
-
|
|
665
|
-
@field_serializer("pq_mode")
|
|
666
|
-
def serialize_pq_mode(self, value):
|
|
667
|
-
if isinstance(value, str):
|
|
668
|
-
try:
|
|
669
|
-
return models.OutputServiceNowMode(value)
|
|
670
|
-
except ValueError:
|
|
671
|
-
return value
|
|
672
|
-
return value
|
|
673
|
-
|
|
674
|
-
@field_serializer("pq_compress")
|
|
675
|
-
def serialize_pq_compress(self, value):
|
|
676
|
-
if isinstance(value, str):
|
|
677
|
-
try:
|
|
678
|
-
return models.OutputServiceNowPqCompressCompression(value)
|
|
679
|
-
except ValueError:
|
|
680
|
-
return value
|
|
681
|
-
return value
|
|
682
|
-
|
|
683
|
-
@field_serializer("pq_on_backpressure")
|
|
684
|
-
def serialize_pq_on_backpressure(self, value):
|
|
685
|
-
if isinstance(value, str):
|
|
686
|
-
try:
|
|
687
|
-
return models.OutputServiceNowQueueFullBehavior(value)
|
|
688
|
-
except ValueError:
|
|
689
|
-
return value
|
|
690
|
-
return value
|
|
@@ -1,12 +1,11 @@
|
|
|
1
1
|
"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
|
|
2
2
|
|
|
3
3
|
from __future__ import annotations
|
|
4
|
-
from cribl_control_plane import
|
|
4
|
+
from cribl_control_plane import utils
|
|
5
5
|
from cribl_control_plane.types import BaseModel
|
|
6
6
|
from cribl_control_plane.utils import validate_open_enum
|
|
7
7
|
from enum import Enum
|
|
8
8
|
import pydantic
|
|
9
|
-
from pydantic import field_serializer
|
|
10
9
|
from pydantic.functional_validators import PlainValidator
|
|
11
10
|
from typing import List, Optional
|
|
12
11
|
from typing_extensions import Annotated, NotRequired, TypedDict
|
|
@@ -37,11 +36,8 @@ class OutputSignalfxExtraHTTPHeader(BaseModel):
|
|
|
37
36
|
class OutputSignalfxFailedRequestLoggingMode(str, Enum, metaclass=utils.OpenEnumMeta):
|
|
38
37
|
r"""Data to log when a request fails. All headers are redacted by default, unless listed as safe headers below."""
|
|
39
38
|
|
|
40
|
-
# Payload
|
|
41
39
|
PAYLOAD = "payload"
|
|
42
|
-
# Payload + Headers
|
|
43
40
|
PAYLOAD_AND_HEADERS = "payloadAndHeaders"
|
|
44
|
-
# None
|
|
45
41
|
NONE = "none"
|
|
46
42
|
|
|
47
43
|
|
|
@@ -102,43 +98,33 @@ class OutputSignalfxTimeoutRetrySettings(BaseModel):
|
|
|
102
98
|
class OutputSignalfxBackpressureBehavior(str, Enum, metaclass=utils.OpenEnumMeta):
|
|
103
99
|
r"""How to handle events when all receivers are exerting backpressure"""
|
|
104
100
|
|
|
105
|
-
# Block
|
|
106
101
|
BLOCK = "block"
|
|
107
|
-
# Drop
|
|
108
102
|
DROP = "drop"
|
|
109
|
-
# Persistent Queue
|
|
110
103
|
QUEUE = "queue"
|
|
111
104
|
|
|
112
105
|
|
|
113
|
-
class OutputSignalfxMode(str, Enum, metaclass=utils.OpenEnumMeta):
|
|
114
|
-
r"""In Error mode, PQ writes events to the filesystem if the Destination is unavailable. In Backpressure mode, PQ writes events to the filesystem when it detects backpressure from the Destination. In Always On mode, PQ always writes events to the filesystem."""
|
|
115
|
-
|
|
116
|
-
# Error
|
|
117
|
-
ERROR = "error"
|
|
118
|
-
# Backpressure
|
|
119
|
-
ALWAYS = "always"
|
|
120
|
-
# Always On
|
|
121
|
-
BACKPRESSURE = "backpressure"
|
|
122
|
-
|
|
123
|
-
|
|
124
106
|
class OutputSignalfxCompression(str, Enum, metaclass=utils.OpenEnumMeta):
|
|
125
107
|
r"""Codec to use to compress the persisted data"""
|
|
126
108
|
|
|
127
|
-
# None
|
|
128
109
|
NONE = "none"
|
|
129
|
-
# Gzip
|
|
130
110
|
GZIP = "gzip"
|
|
131
111
|
|
|
132
112
|
|
|
133
113
|
class OutputSignalfxQueueFullBehavior(str, Enum, metaclass=utils.OpenEnumMeta):
|
|
134
114
|
r"""How to handle events when the queue is exerting backpressure (full capacity or low disk). 'Block' is the same behavior as non-PQ blocking. 'Drop new data' throws away incoming data, while leaving the contents of the PQ unchanged."""
|
|
135
115
|
|
|
136
|
-
# Block
|
|
137
116
|
BLOCK = "block"
|
|
138
|
-
# Drop new data
|
|
139
117
|
DROP = "drop"
|
|
140
118
|
|
|
141
119
|
|
|
120
|
+
class OutputSignalfxMode(str, Enum, metaclass=utils.OpenEnumMeta):
|
|
121
|
+
r"""In Error mode, PQ writes events to the filesystem if the Destination is unavailable. In Backpressure mode, PQ writes events to the filesystem when it detects backpressure from the Destination. In Always On mode, PQ always writes events to the filesystem."""
|
|
122
|
+
|
|
123
|
+
ERROR = "error"
|
|
124
|
+
BACKPRESSURE = "backpressure"
|
|
125
|
+
ALWAYS = "always"
|
|
126
|
+
|
|
127
|
+
|
|
142
128
|
class OutputSignalfxPqControlsTypedDict(TypedDict):
|
|
143
129
|
pass
|
|
144
130
|
|
|
@@ -202,16 +188,6 @@ class OutputSignalfxTypedDict(TypedDict):
|
|
|
202
188
|
r"""SignalFx API access token (see [here](https://docs.signalfx.com/en/latest/admin-guide/tokens.html#working-with-access-tokens))"""
|
|
203
189
|
text_secret: NotRequired[str]
|
|
204
190
|
r"""Select or create a stored text secret"""
|
|
205
|
-
pq_strict_ordering: NotRequired[bool]
|
|
206
|
-
r"""Use FIFO (first in, first out) processing. Disable to forward new events to receivers before queue is flushed."""
|
|
207
|
-
pq_rate_per_sec: NotRequired[float]
|
|
208
|
-
r"""Throttling rate (in events per second) to impose while writing to Destinations from PQ. Defaults to 0, which disables throttling."""
|
|
209
|
-
pq_mode: NotRequired[OutputSignalfxMode]
|
|
210
|
-
r"""In Error mode, PQ writes events to the filesystem if the Destination is unavailable. In Backpressure mode, PQ writes events to the filesystem when it detects backpressure from the Destination. In Always On mode, PQ always writes events to the filesystem."""
|
|
211
|
-
pq_max_buffer_size: NotRequired[float]
|
|
212
|
-
r"""The maximum number of events to hold in memory before writing the events to disk"""
|
|
213
|
-
pq_max_backpressure_sec: NotRequired[float]
|
|
214
|
-
r"""How long (in seconds) to wait for backpressure to resolve before engaging the queue"""
|
|
215
191
|
pq_max_file_size: NotRequired[str]
|
|
216
192
|
r"""The maximum size to store in each queue file before closing and optionally compressing (KB, MB, etc.)"""
|
|
217
193
|
pq_max_size: NotRequired[str]
|
|
@@ -222,6 +198,8 @@ class OutputSignalfxTypedDict(TypedDict):
|
|
|
222
198
|
r"""Codec to use to compress the persisted data"""
|
|
223
199
|
pq_on_backpressure: NotRequired[OutputSignalfxQueueFullBehavior]
|
|
224
200
|
r"""How to handle events when the queue is exerting backpressure (full capacity or low disk). 'Block' is the same behavior as non-PQ blocking. 'Drop new data' throws away incoming data, while leaving the contents of the PQ unchanged."""
|
|
201
|
+
pq_mode: NotRequired[OutputSignalfxMode]
|
|
202
|
+
r"""In Error mode, PQ writes events to the filesystem if the Destination is unavailable. In Backpressure mode, PQ writes events to the filesystem when it detects backpressure from the Destination. In Always On mode, PQ always writes events to the filesystem."""
|
|
225
203
|
pq_controls: NotRequired[OutputSignalfxPqControlsTypedDict]
|
|
226
204
|
|
|
227
205
|
|
|
@@ -347,34 +325,6 @@ class OutputSignalfx(BaseModel):
|
|
|
347
325
|
text_secret: Annotated[Optional[str], pydantic.Field(alias="textSecret")] = None
|
|
348
326
|
r"""Select or create a stored text secret"""
|
|
349
327
|
|
|
350
|
-
pq_strict_ordering: Annotated[
|
|
351
|
-
Optional[bool], pydantic.Field(alias="pqStrictOrdering")
|
|
352
|
-
] = True
|
|
353
|
-
r"""Use FIFO (first in, first out) processing. Disable to forward new events to receivers before queue is flushed."""
|
|
354
|
-
|
|
355
|
-
pq_rate_per_sec: Annotated[
|
|
356
|
-
Optional[float], pydantic.Field(alias="pqRatePerSec")
|
|
357
|
-
] = 0
|
|
358
|
-
r"""Throttling rate (in events per second) to impose while writing to Destinations from PQ. Defaults to 0, which disables throttling."""
|
|
359
|
-
|
|
360
|
-
pq_mode: Annotated[
|
|
361
|
-
Annotated[
|
|
362
|
-
Optional[OutputSignalfxMode], PlainValidator(validate_open_enum(False))
|
|
363
|
-
],
|
|
364
|
-
pydantic.Field(alias="pqMode"),
|
|
365
|
-
] = OutputSignalfxMode.ERROR
|
|
366
|
-
r"""In Error mode, PQ writes events to the filesystem if the Destination is unavailable. In Backpressure mode, PQ writes events to the filesystem when it detects backpressure from the Destination. In Always On mode, PQ always writes events to the filesystem."""
|
|
367
|
-
|
|
368
|
-
pq_max_buffer_size: Annotated[
|
|
369
|
-
Optional[float], pydantic.Field(alias="pqMaxBufferSize")
|
|
370
|
-
] = 42
|
|
371
|
-
r"""The maximum number of events to hold in memory before writing the events to disk"""
|
|
372
|
-
|
|
373
|
-
pq_max_backpressure_sec: Annotated[
|
|
374
|
-
Optional[float], pydantic.Field(alias="pqMaxBackpressureSec")
|
|
375
|
-
] = 30
|
|
376
|
-
r"""How long (in seconds) to wait for backpressure to resolve before engaging the queue"""
|
|
377
|
-
|
|
378
328
|
pq_max_file_size: Annotated[
|
|
379
329
|
Optional[str], pydantic.Field(alias="pqMaxFileSize")
|
|
380
330
|
] = "1 MB"
|
|
@@ -406,60 +356,14 @@ class OutputSignalfx(BaseModel):
|
|
|
406
356
|
] = OutputSignalfxQueueFullBehavior.BLOCK
|
|
407
357
|
r"""How to handle events when the queue is exerting backpressure (full capacity or low disk). 'Block' is the same behavior as non-PQ blocking. 'Drop new data' throws away incoming data, while leaving the contents of the PQ unchanged."""
|
|
408
358
|
|
|
359
|
+
pq_mode: Annotated[
|
|
360
|
+
Annotated[
|
|
361
|
+
Optional[OutputSignalfxMode], PlainValidator(validate_open_enum(False))
|
|
362
|
+
],
|
|
363
|
+
pydantic.Field(alias="pqMode"),
|
|
364
|
+
] = OutputSignalfxMode.ERROR
|
|
365
|
+
r"""In Error mode, PQ writes events to the filesystem if the Destination is unavailable. In Backpressure mode, PQ writes events to the filesystem when it detects backpressure from the Destination. In Always On mode, PQ always writes events to the filesystem."""
|
|
366
|
+
|
|
409
367
|
pq_controls: Annotated[
|
|
410
368
|
Optional[OutputSignalfxPqControls], pydantic.Field(alias="pqControls")
|
|
411
369
|
] = None
|
|
412
|
-
|
|
413
|
-
@field_serializer("auth_type")
|
|
414
|
-
def serialize_auth_type(self, value):
|
|
415
|
-
if isinstance(value, str):
|
|
416
|
-
try:
|
|
417
|
-
return models.OutputSignalfxAuthenticationMethod(value)
|
|
418
|
-
except ValueError:
|
|
419
|
-
return value
|
|
420
|
-
return value
|
|
421
|
-
|
|
422
|
-
@field_serializer("failed_request_logging_mode")
|
|
423
|
-
def serialize_failed_request_logging_mode(self, value):
|
|
424
|
-
if isinstance(value, str):
|
|
425
|
-
try:
|
|
426
|
-
return models.OutputSignalfxFailedRequestLoggingMode(value)
|
|
427
|
-
except ValueError:
|
|
428
|
-
return value
|
|
429
|
-
return value
|
|
430
|
-
|
|
431
|
-
@field_serializer("on_backpressure")
|
|
432
|
-
def serialize_on_backpressure(self, value):
|
|
433
|
-
if isinstance(value, str):
|
|
434
|
-
try:
|
|
435
|
-
return models.OutputSignalfxBackpressureBehavior(value)
|
|
436
|
-
except ValueError:
|
|
437
|
-
return value
|
|
438
|
-
return value
|
|
439
|
-
|
|
440
|
-
@field_serializer("pq_mode")
|
|
441
|
-
def serialize_pq_mode(self, value):
|
|
442
|
-
if isinstance(value, str):
|
|
443
|
-
try:
|
|
444
|
-
return models.OutputSignalfxMode(value)
|
|
445
|
-
except ValueError:
|
|
446
|
-
return value
|
|
447
|
-
return value
|
|
448
|
-
|
|
449
|
-
@field_serializer("pq_compress")
|
|
450
|
-
def serialize_pq_compress(self, value):
|
|
451
|
-
if isinstance(value, str):
|
|
452
|
-
try:
|
|
453
|
-
return models.OutputSignalfxCompression(value)
|
|
454
|
-
except ValueError:
|
|
455
|
-
return value
|
|
456
|
-
return value
|
|
457
|
-
|
|
458
|
-
@field_serializer("pq_on_backpressure")
|
|
459
|
-
def serialize_pq_on_backpressure(self, value):
|
|
460
|
-
if isinstance(value, str):
|
|
461
|
-
try:
|
|
462
|
-
return models.OutputSignalfxQueueFullBehavior(value)
|
|
463
|
-
except ValueError:
|
|
464
|
-
return value
|
|
465
|
-
return value
|