cribl-control-plane 0.0.39__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.
- cribl_control_plane/_hooks/clientcredentials.py +92 -42
- cribl_control_plane/_version.py +4 -4
- cribl_control_plane/acl.py +21 -9
- cribl_control_plane/auth_sdk.py +6 -3
- cribl_control_plane/basesdk.py +17 -1
- cribl_control_plane/branches.py +28 -8
- cribl_control_plane/collectors_sdk.py +993 -0
- cribl_control_plane/commits.py +119 -47
- cribl_control_plane/commits_files.py +44 -24
- cribl_control_plane/configs_versions.py +16 -10
- cribl_control_plane/cribl.py +495 -0
- cribl_control_plane/destinations.py +86 -34
- cribl_control_plane/destinations_pq.py +34 -14
- cribl_control_plane/errors/__init__.py +23 -8
- cribl_control_plane/errors/apierror.py +2 -0
- cribl_control_plane/errors/criblcontrolplaneerror.py +11 -7
- cribl_control_plane/errors/error.py +4 -2
- cribl_control_plane/errors/healthserverstatus_error.py +41 -0
- cribl_control_plane/errors/no_response_error.py +5 -1
- cribl_control_plane/errors/responsevalidationerror.py +2 -0
- cribl_control_plane/functions.py +367 -0
- cribl_control_plane/groups_configs.py +8 -3
- cribl_control_plane/groups_sdk.py +156 -94
- cribl_control_plane/health.py +34 -14
- cribl_control_plane/hectokens.py +44 -20
- cribl_control_plane/httpclient.py +0 -1
- cribl_control_plane/lakedatasets.py +156 -62
- cribl_control_plane/models/__init__.py +4736 -490
- cribl_control_plane/models/addhectokenrequest.py +7 -1
- cribl_control_plane/models/authtoken.py +5 -1
- cribl_control_plane/models/backupssettings_union.py +37 -0
- cribl_control_plane/models/{routecloneconf.py → branchinfo.py} +4 -4
- cribl_control_plane/models/cacheconnection.py +30 -2
- cribl_control_plane/models/cacheconnectionbackfillstatus.py +2 -1
- cribl_control_plane/models/cloudprovider.py +2 -1
- cribl_control_plane/models/collectorazureblob.py +130 -0
- cribl_control_plane/models/collectorconf.py +56 -0
- cribl_control_plane/models/collectorcribllake.py +27 -0
- cribl_control_plane/models/collectordatabase.py +92 -0
- cribl_control_plane/models/collectorfilesystem.py +66 -0
- cribl_control_plane/models/collectorgooglecloudstorage.py +131 -0
- cribl_control_plane/models/collectorhealthcheck.py +269 -0
- cribl_control_plane/models/collectorrest.py +340 -0
- cribl_control_plane/models/collectors3.py +239 -0
- cribl_control_plane/models/collectorscript.py +59 -0
- cribl_control_plane/models/collectorsplunk.py +253 -0
- cribl_control_plane/models/configgroup.py +65 -8
- cribl_control_plane/models/configgroupcloud.py +17 -3
- cribl_control_plane/models/countedbranchinfo.py +20 -0
- cribl_control_plane/models/countedconfiggroup.py +20 -0
- cribl_control_plane/models/countedcribllakedataset.py +20 -0
- cribl_control_plane/models/counteddistributedsummary.py +20 -0
- cribl_control_plane/models/countedfunctionresponse.py +20 -0
- cribl_control_plane/models/countedgitcommitsummary.py +20 -0
- cribl_control_plane/models/countedgitcountresult.py +20 -0
- cribl_control_plane/models/{createinputop.py → countedgitdiffresult.py} +5 -9
- cribl_control_plane/models/countedgitfilesresponse.py +20 -0
- cribl_control_plane/models/{getversioninfoop.py → countedgitinfo.py} +2 -6
- cribl_control_plane/models/countedgitlogresult.py +20 -0
- cribl_control_plane/models/countedgitrevertresult.py +20 -0
- cribl_control_plane/models/countedgitshowresult.py +20 -0
- cribl_control_plane/models/countedgitstatusresult.py +20 -0
- cribl_control_plane/models/{listinputop.py → countedinput.py} +2 -6
- cribl_control_plane/models/countedinputsplunkhec.py +20 -0
- cribl_control_plane/models/countedjobinfo.py +20 -0
- cribl_control_plane/models/countedmasterworkerentry.py +20 -0
- cribl_control_plane/models/countednumber.py +19 -0
- cribl_control_plane/models/{getversionbranchop.py → countedobject.py} +2 -6
- cribl_control_plane/models/{listoutputop.py → countedoutput.py} +2 -6
- cribl_control_plane/models/{createoutputop.py → countedoutputsamplesresponse.py} +5 -9
- cribl_control_plane/models/countedoutputtestresponse.py +20 -0
- cribl_control_plane/models/countedpackinfo.py +20 -0
- cribl_control_plane/models/{createpacksop.py → countedpackinstallinfo.py} +2 -6
- cribl_control_plane/models/{listpipelineop.py → countedpipeline.py} +2 -6
- cribl_control_plane/models/{listroutesop.py → countedroutes.py} +2 -6
- cribl_control_plane/models/countedsavedjob.py +20 -0
- cribl_control_plane/models/countedstring.py +19 -0
- cribl_control_plane/models/countedsystemsettingsconf.py +20 -0
- cribl_control_plane/models/countedteamaccesscontrollist.py +20 -0
- cribl_control_plane/models/counteduseraccesscontrollist.py +20 -0
- cribl_control_plane/models/createauthloginop.py +18 -0
- cribl_control_plane/models/createconfiggroupbyproductop.py +26 -27
- cribl_control_plane/models/createcribllakedatasetbylakeidop.py +1 -19
- cribl_control_plane/models/createinputhectokenbyidop.py +1 -19
- cribl_control_plane/models/createoutputtestbyidop.py +1 -20
- cribl_control_plane/models/createroutesappendbyidop.py +4 -22
- cribl_control_plane/models/createsavedjobop.py +30 -0
- cribl_control_plane/models/createversioncommitop.py +1 -19
- cribl_control_plane/models/createversionrevertop.py +3 -21
- cribl_control_plane/models/createversionundoop.py +1 -18
- cribl_control_plane/models/criblevent.py +15 -0
- cribl_control_plane/models/cribllakedataset.py +23 -3
- cribl_control_plane/models/cribllakedatasetupdate.py +95 -0
- cribl_control_plane/models/datasetmetadata.py +18 -2
- cribl_control_plane/models/deleteconfiggroupbyproductandidop.py +18 -21
- cribl_control_plane/models/deletecribllakedatasetbylakeidandidop.py +1 -20
- cribl_control_plane/models/deleteinputbyidop.py +1 -20
- cribl_control_plane/models/deleteoutputbyidop.py +1 -20
- cribl_control_plane/models/deleteoutputpqbyidop.py +1 -19
- cribl_control_plane/models/deletepacksbyidop.py +1 -20
- cribl_control_plane/models/deletepipelinebyidop.py +3 -22
- cribl_control_plane/models/deletesavedjobbyidop.py +42 -0
- cribl_control_plane/models/difffiles.py +130 -0
- cribl_control_plane/models/diffline.py +26 -0
- cribl_control_plane/models/difflinecontext.py +28 -0
- cribl_control_plane/models/difflinedelete.py +25 -0
- cribl_control_plane/models/difflineinsert.py +25 -0
- cribl_control_plane/models/distributedsummary.py +6 -0
- cribl_control_plane/models/functionaggregatemetrics.py +69 -0
- cribl_control_plane/models/functionaggregation.py +69 -0
- cribl_control_plane/models/functionautotimestamp.py +69 -0
- cribl_control_plane/models/functioncef.py +66 -0
- cribl_control_plane/models/functionchain.py +69 -0
- cribl_control_plane/models/functionclone.py +69 -0
- cribl_control_plane/models/functioncode.py +69 -0
- cribl_control_plane/models/functioncomment.py +69 -0
- cribl_control_plane/models/functionconfschemaaggregatemetrics.py +153 -0
- cribl_control_plane/models/functionconfschemaaggregation.py +114 -0
- cribl_control_plane/models/functionconfschemaautotimestamp.py +116 -0
- cribl_control_plane/models/functionconfschemacef.py +83 -0
- cribl_control_plane/models/functionconfschemachain.py +16 -0
- cribl_control_plane/models/functionconfschemaclone.py +16 -0
- cribl_control_plane/models/functionconfschemacode.py +38 -0
- cribl_control_plane/models/functionconfschemacomment.py +16 -0
- cribl_control_plane/models/functionconfschemadistinct.py +41 -0
- cribl_control_plane/models/functionconfschemadnslookup.py +193 -0
- cribl_control_plane/models/{lookupversions.py → functionconfschemadrop.py} +2 -2
- cribl_control_plane/models/functionconfschemadropdimensions.py +31 -0
- cribl_control_plane/models/functionconfschemadynamicsampling.py +67 -0
- cribl_control_plane/models/functionconfschemaeval.py +44 -0
- cribl_control_plane/models/functionconfschemaeventbreaker.py +51 -0
- cribl_control_plane/models/functionconfschemaeventstats.py +34 -0
- cribl_control_plane/models/functionconfschemaexternaldata.py +13 -0
- cribl_control_plane/models/functionconfschemaflatten.py +31 -0
- cribl_control_plane/models/functionconfschemafoldkeys.py +31 -0
- cribl_control_plane/models/functionconfschemagenstats.py +14 -0
- cribl_control_plane/models/functionconfschemageoip.py +66 -0
- cribl_control_plane/models/functionconfschemagrok.py +38 -0
- cribl_control_plane/models/functionconfschemahandlebar.py +56 -0
- cribl_control_plane/models/functionconfschemajoin.py +55 -0
- cribl_control_plane/models/functionconfschemajsonunroll.py +21 -0
- cribl_control_plane/models/functionconfschemalakeexport.py +44 -0
- cribl_control_plane/models/functionconfschemalimit.py +16 -0
- cribl_control_plane/models/functionconfschemalocalsearchdatatypeparser.py +17 -0
- cribl_control_plane/models/functionconfschemalocalsearchrulesetrunner.py +40 -0
- cribl_control_plane/models/functionconfschemalookup.py +92 -0
- cribl_control_plane/models/functionconfschemamask.py +63 -0
- cribl_control_plane/models/functionconfschemamvexpand.py +76 -0
- cribl_control_plane/models/functionconfschemamvpull.py +45 -0
- cribl_control_plane/models/functionconfschemanotificationpolicies.py +129 -0
- cribl_control_plane/models/functionconfschemanotifications.py +26 -0
- cribl_control_plane/models/functionconfschemanotify.py +149 -0
- cribl_control_plane/models/functionconfschemanumerify.py +63 -0
- cribl_control_plane/models/functionconfschemaotlplogs.py +24 -0
- cribl_control_plane/models/functionconfschemaotlpmetrics.py +61 -0
- cribl_control_plane/models/functionconfschemaotlptraces.py +54 -0
- cribl_control_plane/models/functionconfschemapack.py +24 -0
- cribl_control_plane/models/functionconfschemapivot.py +31 -0
- cribl_control_plane/models/functionconfschemapublishmetrics.py +98 -0
- cribl_control_plane/models/functionconfschemaredis.py +121 -0
- cribl_control_plane/models/functionconfschemaregexextract.py +55 -0
- cribl_control_plane/models/functionconfschemaregexfilter.py +38 -0
- cribl_control_plane/models/functionconfschemarename.py +49 -0
- cribl_control_plane/models/functionconfschemarollupmetrics.py +57 -0
- cribl_control_plane/models/functionconfschemasampling.py +32 -0
- cribl_control_plane/models/functionconfschemasend.py +84 -0
- cribl_control_plane/models/functionconfschemasensitivedatascanner.py +75 -0
- cribl_control_plane/models/functionconfschemaserde.py +105 -0
- cribl_control_plane/models/functionconfschemaserialize.py +78 -0
- cribl_control_plane/models/functionconfschemasidlookup.py +34 -0
- cribl_control_plane/models/functionconfschemasnmptrapserialize.py +92 -0
- cribl_control_plane/models/functionconfschemasort.py +41 -0
- cribl_control_plane/models/functionconfschemastore.py +75 -0
- cribl_control_plane/models/functionconfschemasuppress.py +57 -0
- cribl_control_plane/models/functionconfschematee.py +32 -0
- cribl_control_plane/models/functionconfschematrimtimestamp.py +16 -0
- cribl_control_plane/models/functionconfschemaunion.py +22 -0
- cribl_control_plane/models/functionconfschemaunroll.py +22 -0
- cribl_control_plane/models/functionconfschemawindow.py +40 -0
- cribl_control_plane/models/functionconfschemaxmlunroll.py +34 -0
- cribl_control_plane/models/functiondistinct.py +69 -0
- cribl_control_plane/models/functiondnslookup.py +69 -0
- cribl_control_plane/models/functiondrop.py +69 -0
- cribl_control_plane/models/functiondropdimensions.py +69 -0
- cribl_control_plane/models/functiondynamicsampling.py +69 -0
- cribl_control_plane/models/functioneval.py +69 -0
- cribl_control_plane/models/functioneventbreaker.py +69 -0
- cribl_control_plane/models/functioneventstats.py +69 -0
- cribl_control_plane/models/functionexternaldata.py +69 -0
- cribl_control_plane/models/functionflatten.py +69 -0
- cribl_control_plane/models/functionfoldkeys.py +69 -0
- cribl_control_plane/models/functiongenstats.py +69 -0
- cribl_control_plane/models/functiongeoip.py +69 -0
- cribl_control_plane/models/functiongrok.py +69 -0
- cribl_control_plane/models/functionhandlebar.py +69 -0
- cribl_control_plane/models/functionjoin.py +69 -0
- cribl_control_plane/models/functionjsonunroll.py +69 -0
- cribl_control_plane/models/functionlakeexport.py +69 -0
- cribl_control_plane/models/functionlimit.py +69 -0
- cribl_control_plane/models/functionlocalsearchdatatypeparser.py +70 -0
- cribl_control_plane/models/functionlocalsearchrulesetrunner.py +70 -0
- cribl_control_plane/models/functionlookup.py +69 -0
- cribl_control_plane/models/functionmask.py +69 -0
- cribl_control_plane/models/functionmvexpand.py +69 -0
- cribl_control_plane/models/functionmvpull.py +69 -0
- cribl_control_plane/models/functionnotificationpolicies.py +69 -0
- cribl_control_plane/models/functionnotifications.py +69 -0
- cribl_control_plane/models/functionnotify.py +69 -0
- cribl_control_plane/models/functionnumerify.py +69 -0
- cribl_control_plane/models/functionotlplogs.py +69 -0
- cribl_control_plane/models/functionotlpmetrics.py +69 -0
- cribl_control_plane/models/functionotlptraces.py +69 -0
- cribl_control_plane/models/functionpack.py +69 -0
- cribl_control_plane/models/functionpivot.py +69 -0
- cribl_control_plane/models/functionpublishmetrics.py +69 -0
- cribl_control_plane/models/functionredis.py +69 -0
- cribl_control_plane/models/functionregexextract.py +69 -0
- cribl_control_plane/models/functionregexfilter.py +69 -0
- cribl_control_plane/models/functionrename.py +69 -0
- cribl_control_plane/models/functionresponse.py +242 -0
- cribl_control_plane/models/functionrollupmetrics.py +69 -0
- cribl_control_plane/models/functionsampling.py +69 -0
- cribl_control_plane/models/functionsend.py +69 -0
- cribl_control_plane/models/functionsensitivedatascanner.py +69 -0
- cribl_control_plane/models/functionserde.py +69 -0
- cribl_control_plane/models/functionserialize.py +69 -0
- cribl_control_plane/models/functionsidlookup.py +69 -0
- cribl_control_plane/models/functionsnmptrapserialize.py +69 -0
- cribl_control_plane/models/functionsort.py +69 -0
- cribl_control_plane/models/functionstore.py +69 -0
- cribl_control_plane/models/functionsuppress.py +69 -0
- cribl_control_plane/models/functiontee.py +66 -0
- cribl_control_plane/models/functiontrimtimestamp.py +69 -0
- cribl_control_plane/models/functionunion.py +69 -0
- cribl_control_plane/models/functionunroll.py +69 -0
- cribl_control_plane/models/functionwindow.py +69 -0
- cribl_control_plane/models/functionxmlunroll.py +69 -0
- cribl_control_plane/models/getconfiggroupaclbyproductandidop.py +24 -20
- cribl_control_plane/models/getconfiggroupaclteamsbyproductandidop.py +24 -20
- cribl_control_plane/models/getconfiggroupbyproductandidop.py +14 -19
- cribl_control_plane/models/getconfiggroupconfigversionbyproductandidop.py +18 -20
- cribl_control_plane/models/getcribllakedatasetbylakeidandidop.py +1 -20
- cribl_control_plane/models/getcribllakedatasetbylakeidop.py +54 -14
- cribl_control_plane/models/getfunctionsbyidop.py +18 -0
- cribl_control_plane/models/getinputbyidop.py +1 -20
- cribl_control_plane/models/getmasterworkerentryop.py +1 -18
- cribl_control_plane/models/getoutputbyidop.py +1 -20
- cribl_control_plane/models/getoutputpqbyidop.py +1 -19
- cribl_control_plane/models/getoutputsamplesbyidop.py +1 -20
- cribl_control_plane/models/getpacksbyidop.py +1 -20
- cribl_control_plane/models/getpacksop.py +1 -19
- cribl_control_plane/models/getpipelinebyidop.py +3 -22
- cribl_control_plane/models/getroutesbyidop.py +3 -22
- cribl_control_plane/models/getsavedjobbyidop.py +33 -0
- cribl_control_plane/models/getsavedjobop.py +40 -0
- cribl_control_plane/models/getsummaryop.py +18 -20
- cribl_control_plane/models/getversioncountop.py +3 -21
- cribl_control_plane/models/getversiondiffop.py +1 -18
- cribl_control_plane/models/getversionfilesop.py +3 -22
- cribl_control_plane/models/getversionop.py +1 -19
- cribl_control_plane/models/getversionshowop.py +1 -18
- cribl_control_plane/models/getversionstatusop.py +1 -19
- cribl_control_plane/models/gitcountresult.py +13 -0
- cribl_control_plane/models/gitdiffresult.py +16 -0
- cribl_control_plane/models/gitinfo.py +14 -3
- cribl_control_plane/models/gitshowresult.py +19 -0
- cribl_control_plane/models/groupcreaterequest.py +175 -0
- cribl_control_plane/models/hbcriblinfo.py +42 -7
- cribl_control_plane/models/healthserverstatus.py +55 -0
- cribl_control_plane/models/heartbeatmetadata.py +48 -11
- cribl_control_plane/models/input.py +83 -78
- cribl_control_plane/models/inputappscope.py +126 -30
- cribl_control_plane/models/inputazureblob.py +62 -6
- cribl_control_plane/models/inputcloudflarehec.py +518 -0
- cribl_control_plane/models/inputcollection.py +47 -4
- cribl_control_plane/models/inputconfluentcloud.py +258 -32
- cribl_control_plane/models/inputcribl.py +47 -4
- cribl_control_plane/models/inputcriblhttp.py +121 -30
- cribl_control_plane/models/inputcribllakehttp.py +136 -30
- cribl_control_plane/models/inputcriblmetrics.py +48 -4
- cribl_control_plane/models/inputcribltcp.py +122 -24
- cribl_control_plane/models/inputcrowdstrike.py +92 -10
- cribl_control_plane/models/inputdatadogagent.py +98 -24
- cribl_control_plane/models/inputdatagen.py +47 -4
- cribl_control_plane/models/inputedgeprometheus.py +218 -58
- cribl_control_plane/models/inputelastic.py +167 -36
- cribl_control_plane/models/inputeventhub.py +209 -6
- cribl_control_plane/models/inputexec.py +59 -6
- cribl_control_plane/models/inputfile.py +78 -10
- cribl_control_plane/models/inputfirehose.py +97 -24
- cribl_control_plane/models/inputgooglepubsub.py +67 -6
- cribl_control_plane/models/inputgrafana.py +251 -71
- cribl_control_plane/models/inputhttp.py +97 -24
- cribl_control_plane/models/inputhttpraw.py +97 -24
- cribl_control_plane/models/inputjournalfiles.py +48 -4
- cribl_control_plane/models/inputkafka.py +252 -28
- cribl_control_plane/models/inputkinesis.py +130 -14
- cribl_control_plane/models/inputkubeevents.py +47 -4
- cribl_control_plane/models/inputkubelogs.py +61 -8
- cribl_control_plane/models/inputkubemetrics.py +61 -8
- cribl_control_plane/models/inputloki.py +113 -34
- cribl_control_plane/models/inputmetrics.py +97 -24
- cribl_control_plane/models/inputmodeldriventelemetry.py +107 -26
- cribl_control_plane/models/inputmsk.py +145 -32
- cribl_control_plane/models/inputnetflow.py +47 -4
- cribl_control_plane/models/inputoffice365mgmt.py +112 -14
- cribl_control_plane/models/inputoffice365msgtrace.py +114 -16
- cribl_control_plane/models/inputoffice365service.py +114 -16
- cribl_control_plane/models/inputopentelemetry.py +143 -32
- cribl_control_plane/models/inputprometheus.py +211 -57
- cribl_control_plane/models/inputprometheusrw.py +114 -27
- cribl_control_plane/models/inputrawudp.py +47 -4
- cribl_control_plane/models/inputs3.py +78 -8
- cribl_control_plane/models/inputs3inventory.py +92 -10
- cribl_control_plane/models/inputsecuritylake.py +93 -10
- cribl_control_plane/models/inputsnmp.py +112 -21
- cribl_control_plane/models/inputsplunk.py +130 -28
- cribl_control_plane/models/inputsplunkhec.py +119 -29
- cribl_control_plane/models/inputsplunksearch.py +112 -15
- cribl_control_plane/models/inputsqs.py +99 -16
- cribl_control_plane/models/inputsyslog.py +189 -47
- cribl_control_plane/models/inputsystemmetrics.py +202 -32
- cribl_control_plane/models/inputsystemstate.py +61 -8
- cribl_control_plane/models/inputtcp.py +122 -26
- cribl_control_plane/models/inputtcpjson.py +112 -26
- cribl_control_plane/models/inputwef.py +144 -15
- cribl_control_plane/models/inputwindowsmetrics.py +186 -33
- cribl_control_plane/models/inputwineventlogs.py +93 -11
- cribl_control_plane/models/inputwiz.py +173 -8
- cribl_control_plane/models/inputwizwebhook.py +97 -24
- cribl_control_plane/models/inputzscalerhec.py +119 -29
- cribl_control_plane/models/jobinfo.py +34 -0
- cribl_control_plane/models/jobstatus.py +48 -0
- cribl_control_plane/models/lakedatasetmetrics.py +17 -0
- cribl_control_plane/models/lakehouseconnectiontype.py +2 -1
- cribl_control_plane/models/listconfiggroupbyproductop.py +14 -19
- cribl_control_plane/models/listmasterworkerentryop.py +1 -19
- cribl_control_plane/models/logininfo.py +3 -3
- cribl_control_plane/models/masterworkerentry.py +20 -13
- cribl_control_plane/models/nodeactiveupgradestatus.py +2 -1
- cribl_control_plane/models/nodefailedupgradestatus.py +2 -1
- cribl_control_plane/models/nodeprovidedinfo.py +55 -11
- cribl_control_plane/models/nodeskippedupgradestatus.py +2 -1
- cribl_control_plane/models/nodeupgradestate.py +2 -1
- cribl_control_plane/models/nodeupgradestatus.py +51 -5
- cribl_control_plane/models/outpostnodeinfo.py +16 -0
- cribl_control_plane/models/output.py +111 -91
- cribl_control_plane/models/outputazureblob.py +171 -18
- cribl_control_plane/models/outputazuredataexplorer.py +514 -90
- cribl_control_plane/models/outputazureeventhub.py +315 -31
- cribl_control_plane/models/outputazurelogs.py +145 -26
- cribl_control_plane/models/outputchronicle.py +532 -0
- cribl_control_plane/models/outputclickhouse.py +236 -34
- cribl_control_plane/models/outputcloudflarer2.py +632 -0
- cribl_control_plane/models/outputcloudwatch.py +129 -23
- cribl_control_plane/models/outputconfluentcloud.py +384 -57
- cribl_control_plane/models/outputcriblhttp.py +205 -31
- cribl_control_plane/models/outputcribllake.py +156 -16
- cribl_control_plane/models/outputcriblsearchengine.py +655 -0
- cribl_control_plane/models/outputcribltcp.py +194 -29
- cribl_control_plane/models/outputcrowdstrikenextgensiem.py +172 -28
- cribl_control_plane/models/outputdatabricks.py +501 -0
- cribl_control_plane/models/outputdatadog.py +199 -31
- cribl_control_plane/models/outputdataset.py +181 -29
- cribl_control_plane/models/outputdiskspool.py +17 -2
- cribl_control_plane/models/outputdls3.py +233 -24
- cribl_control_plane/models/outputdynatracehttp.py +208 -34
- cribl_control_plane/models/outputdynatraceotlp.py +210 -36
- cribl_control_plane/models/outputelastic.py +199 -30
- cribl_control_plane/models/outputelasticcloud.py +171 -26
- cribl_control_plane/models/outputexabeam.py +96 -10
- cribl_control_plane/models/outputfilesystem.py +139 -14
- cribl_control_plane/models/outputgooglechronicle.py +216 -35
- cribl_control_plane/models/outputgooglecloudlogging.py +174 -31
- cribl_control_plane/models/outputgooglecloudstorage.py +215 -24
- cribl_control_plane/models/outputgooglepubsub.py +131 -23
- cribl_control_plane/models/outputgrafanacloud.py +376 -74
- cribl_control_plane/models/outputgraphite.py +128 -25
- cribl_control_plane/models/outputhoneycomb.py +145 -26
- cribl_control_plane/models/outputhumiohec.py +162 -28
- cribl_control_plane/models/outputinfluxdb.py +165 -28
- cribl_control_plane/models/outputkafka.py +375 -52
- cribl_control_plane/models/outputkinesis.py +165 -27
- cribl_control_plane/models/outputloki.py +164 -34
- cribl_control_plane/models/outputmicrosoftfabric.py +540 -0
- cribl_control_plane/models/outputminio.py +225 -25
- cribl_control_plane/models/outputmsk.py +267 -54
- cribl_control_plane/models/outputnetflow.py +16 -2
- cribl_control_plane/models/outputnewrelic.py +171 -29
- cribl_control_plane/models/outputnewrelicevents.py +163 -28
- cribl_control_plane/models/outputopentelemetry.py +240 -40
- cribl_control_plane/models/outputprometheus.py +145 -26
- cribl_control_plane/models/outputring.py +49 -8
- cribl_control_plane/models/outputs3.py +233 -26
- cribl_control_plane/models/outputsecuritylake.py +179 -18
- cribl_control_plane/models/outputsentinel.py +172 -29
- cribl_control_plane/models/outputsentineloneaisiem.py +178 -32
- cribl_control_plane/models/outputservicenow.py +223 -38
- cribl_control_plane/models/outputsignalfx.py +145 -26
- cribl_control_plane/models/outputsns.py +143 -25
- cribl_control_plane/models/outputsplunk.py +206 -36
- cribl_control_plane/models/outputsplunkhec.py +238 -26
- cribl_control_plane/models/outputsplunklb.py +262 -42
- cribl_control_plane/models/outputsqs.py +163 -33
- cribl_control_plane/models/outputstatsd.py +127 -25
- cribl_control_plane/models/outputstatsdext.py +128 -25
- cribl_control_plane/models/outputsumologic.py +146 -25
- cribl_control_plane/models/outputsyslog.py +318 -46
- cribl_control_plane/models/outputtcpjson.py +186 -32
- cribl_control_plane/models/outputwavefront.py +145 -26
- cribl_control_plane/models/outputwebhook.py +211 -33
- cribl_control_plane/models/outputxsiam.py +143 -26
- cribl_control_plane/models/packinfo.py +8 -5
- cribl_control_plane/models/packinstallinfo.py +11 -8
- cribl_control_plane/models/piisettings_union.py +31 -0
- cribl_control_plane/models/pipeline.py +52 -4
- cribl_control_plane/models/pipelinefunctionaggregatemetrics.py +195 -0
- cribl_control_plane/models/pipelinefunctionaggregation.py +159 -0
- cribl_control_plane/models/pipelinefunctionautotimestamp.py +56 -0
- cribl_control_plane/models/pipelinefunctioncef.py +96 -0
- cribl_control_plane/models/pipelinefunctionchain.py +62 -0
- cribl_control_plane/models/pipelinefunctionclone.py +56 -0
- cribl_control_plane/models/pipelinefunctioncode.py +56 -0
- cribl_control_plane/models/pipelinefunctioncomment.py +56 -0
- cribl_control_plane/models/pipelinefunctionconf.py +343 -46
- cribl_control_plane/models/pipelinefunctionconf_input.py +353 -0
- cribl_control_plane/models/pipelinefunctiondistinct.py +86 -0
- cribl_control_plane/models/pipelinefunctiondnslookup.py +56 -0
- cribl_control_plane/models/pipelinefunctiondrop.py +56 -0
- cribl_control_plane/models/pipelinefunctiondropdimensions.py +74 -0
- cribl_control_plane/models/pipelinefunctiondynamicsampling.py +111 -0
- cribl_control_plane/models/pipelinefunctioneval.py +56 -0
- cribl_control_plane/models/pipelinefunctioneventbreaker.py +95 -0
- cribl_control_plane/models/pipelinefunctioneventstats.py +79 -0
- cribl_control_plane/models/pipelinefunctionexternaldata.py +56 -0
- cribl_control_plane/models/pipelinefunctionflatten.py +56 -0
- cribl_control_plane/models/pipelinefunctionfoldkeys.py +56 -0
- cribl_control_plane/models/pipelinefunctiongenstats.py +56 -0
- cribl_control_plane/models/pipelinefunctiongeoip.py +109 -0
- cribl_control_plane/models/pipelinefunctiongrok.py +83 -0
- cribl_control_plane/models/pipelinefunctionhandlebar.py +99 -0
- cribl_control_plane/models/pipelinefunctionjoin.py +100 -0
- cribl_control_plane/models/pipelinefunctionjsonunroll.py +67 -0
- cribl_control_plane/models/pipelinefunctionlakeexport.py +89 -0
- cribl_control_plane/models/pipelinefunctionlimit.py +56 -0
- cribl_control_plane/models/pipelinefunctionlocalsearchdatatypeparser.py +62 -0
- cribl_control_plane/models/pipelinefunctionlocalsearchrulesetrunner.py +56 -0
- cribl_control_plane/models/pipelinefunctionlookup.py +136 -0
- cribl_control_plane/models/pipelinefunctionmask.py +108 -0
- cribl_control_plane/models/pipelinefunctionmvexpand.py +116 -0
- cribl_control_plane/models/pipelinefunctionmvpull.py +86 -0
- cribl_control_plane/models/pipelinefunctionnotificationpolicies.py +56 -0
- cribl_control_plane/models/pipelinefunctionnotifications.py +72 -0
- cribl_control_plane/models/pipelinefunctionnotify.py +189 -0
- cribl_control_plane/models/pipelinefunctionnumerify.py +56 -0
- cribl_control_plane/models/pipelinefunctionotlplogs.py +56 -0
- cribl_control_plane/models/pipelinefunctionotlpmetrics.py +56 -0
- cribl_control_plane/models/pipelinefunctionotlptraces.py +56 -0
- cribl_control_plane/models/pipelinefunctionpack.py +67 -0
- cribl_control_plane/models/pipelinefunctionpivot.py +72 -0
- cribl_control_plane/models/pipelinefunctionpublishmetrics.py +56 -0
- cribl_control_plane/models/pipelinefunctionredis.py +165 -0
- cribl_control_plane/models/pipelinefunctionregexextract.py +100 -0
- cribl_control_plane/models/pipelinefunctionregexfilter.py +56 -0
- cribl_control_plane/models/pipelinefunctionrename.py +56 -0
- cribl_control_plane/models/pipelinefunctionrollupmetrics.py +56 -0
- cribl_control_plane/models/pipelinefunctionsampling.py +56 -0
- cribl_control_plane/models/pipelinefunctionsend.py +128 -0
- cribl_control_plane/models/pipelinefunctionsensitivedatascanner.py +120 -0
- cribl_control_plane/models/pipelinefunctionserde.py +149 -0
- cribl_control_plane/models/pipelinefunctionserialize.py +122 -0
- cribl_control_plane/models/pipelinefunctionsidlookup.py +56 -0
- cribl_control_plane/models/pipelinefunctionsnmptrapserialize.py +56 -0
- cribl_control_plane/models/pipelinefunctionsort.py +84 -0
- cribl_control_plane/models/pipelinefunctionstore.py +120 -0
- cribl_control_plane/models/pipelinefunctionsuppress.py +102 -0
- cribl_control_plane/models/pipelinefunctiontee.py +77 -0
- cribl_control_plane/models/pipelinefunctiontrimtimestamp.py +56 -0
- cribl_control_plane/models/pipelinefunctionunion.py +67 -0
- cribl_control_plane/models/pipelinefunctionunroll.py +67 -0
- cribl_control_plane/models/pipelinefunctionwindow.py +83 -0
- cribl_control_plane/models/pipelinefunctionxmlunroll.py +79 -0
- cribl_control_plane/models/productscore.py +2 -1
- cribl_control_plane/models/rbacresource.py +2 -1
- cribl_control_plane/models/resourcepolicy.py +15 -2
- cribl_control_plane/models/rollbacksettings_union.py +44 -0
- cribl_control_plane/models/routeconf.py +3 -4
- cribl_control_plane/models/runnablejob.py +27 -0
- cribl_control_plane/models/runnablejobcollection.py +629 -0
- cribl_control_plane/models/runnablejobexecutor.py +360 -0
- cribl_control_plane/models/runnablejobscheduledsearch.py +279 -0
- cribl_control_plane/models/savedjob.py +26 -0
- cribl_control_plane/models/savedjobcollection.py +411 -0
- cribl_control_plane/models/savedjobexecutor.py +301 -0
- cribl_control_plane/models/savedjobscheduledsearch.py +278 -0
- cribl_control_plane/models/snisettings_union.py +31 -0
- cribl_control_plane/models/systemsettingsconf.py +291 -0
- cribl_control_plane/models/tlssettings_union.py +43 -0
- cribl_control_plane/models/updateconfiggroupbyproductandidop.py +19 -20
- cribl_control_plane/models/updateconfiggroupdeploybyproductandidop.py +19 -21
- cribl_control_plane/models/updatecribllakedatasetbylakeidandidop.py +10 -25
- cribl_control_plane/models/updatehectokenrequest.py +7 -1
- cribl_control_plane/models/updateinputbyidop.py +1 -19
- cribl_control_plane/models/updateinputhectokenbyidandtokenop.py +1 -19
- cribl_control_plane/models/updateoutputbyidop.py +1 -19
- cribl_control_plane/models/updatepacksbyidop.py +1 -20
- cribl_control_plane/models/updatepacksop.py +25 -0
- cribl_control_plane/models/updatepipelinebyidop.py +9 -26
- cribl_control_plane/models/updateroutesbyidop.py +3 -21
- cribl_control_plane/models/updatesavedjobbyidop.py +42 -0
- cribl_control_plane/models/upgradegroupsettings_union.py +43 -0
- cribl_control_plane/models/upgradepackageurls.py +20 -0
- cribl_control_plane/models/upgradesettings.py +38 -0
- cribl_control_plane/models/uploadpackresponse.py +13 -0
- cribl_control_plane/models/workertypes.py +2 -1
- cribl_control_plane/nodes.py +37 -23
- cribl_control_plane/packs.py +292 -37
- cribl_control_plane/pipelines.py +114 -64
- cribl_control_plane/routes_sdk.py +86 -50
- cribl_control_plane/samples.py +32 -16
- cribl_control_plane/sdk.py +30 -6
- cribl_control_plane/settings.py +20 -0
- cribl_control_plane/sources.py +85 -33
- cribl_control_plane/statuses.py +16 -6
- cribl_control_plane/summaries.py +16 -6
- cribl_control_plane/system_sdk.py +20 -0
- cribl_control_plane/teams.py +16 -6
- cribl_control_plane/tokens.py +49 -21
- cribl_control_plane/utils/__init__.py +15 -3
- cribl_control_plane/utils/annotations.py +32 -8
- cribl_control_plane/utils/eventstreaming.py +10 -0
- cribl_control_plane/utils/forms.py +21 -10
- cribl_control_plane/utils/queryparams.py +14 -2
- cribl_control_plane/utils/retries.py +69 -5
- cribl_control_plane/utils/unmarshal_json_response.py +15 -1
- cribl_control_plane/versions.py +11 -6
- cribl_control_plane/versions_configs.py +16 -6
- {cribl_control_plane-0.0.39.dist-info → cribl_control_plane-0.5.0b3.dist-info}/METADATA +106 -42
- cribl_control_plane-0.5.0b3.dist-info/RECORD +591 -0
- {cribl_control_plane-0.0.39.dist-info → cribl_control_plane-0.5.0b3.dist-info}/WHEEL +1 -1
- cribl_control_plane-0.5.0b3.dist-info/licenses/LICENSE +201 -0
- cribl_control_plane/errors/healthstatus_error.py +0 -32
- cribl_control_plane/models/appmode.py +0 -13
- cribl_control_plane/models/createpipelineop.py +0 -24
- cribl_control_plane/models/createversionpushop.py +0 -23
- cribl_control_plane/models/healthstatus.py +0 -33
- cribl_control_plane-0.0.39.dist-info/RECORD +0 -315
|
@@ -1,9 +1,13 @@
|
|
|
1
1
|
"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
|
|
2
2
|
|
|
3
3
|
from __future__ import annotations
|
|
4
|
+
from cribl_control_plane import models, utils
|
|
4
5
|
from cribl_control_plane.types import BaseModel
|
|
6
|
+
from cribl_control_plane.utils import validate_open_enum
|
|
5
7
|
from enum import Enum
|
|
6
8
|
import pydantic
|
|
9
|
+
from pydantic import field_serializer
|
|
10
|
+
from pydantic.functional_validators import PlainValidator
|
|
7
11
|
from typing import List, Optional
|
|
8
12
|
from typing_extensions import Annotated, NotRequired, TypedDict
|
|
9
13
|
|
|
@@ -23,11 +27,14 @@ class OutputSentinelExtraHTTPHeader(BaseModel):
|
|
|
23
27
|
name: Optional[str] = None
|
|
24
28
|
|
|
25
29
|
|
|
26
|
-
class OutputSentinelFailedRequestLoggingMode(str, Enum):
|
|
30
|
+
class OutputSentinelFailedRequestLoggingMode(str, Enum, metaclass=utils.OpenEnumMeta):
|
|
27
31
|
r"""Data to log when a request fails. All headers are redacted by default, unless listed as safe headers below."""
|
|
28
32
|
|
|
33
|
+
# Payload
|
|
29
34
|
PAYLOAD = "payload"
|
|
35
|
+
# Payload + Headers
|
|
30
36
|
PAYLOAD_AND_HEADERS = "payloadAndHeaders"
|
|
37
|
+
# None
|
|
31
38
|
NONE = "none"
|
|
32
39
|
|
|
33
40
|
|
|
@@ -85,54 +92,66 @@ class OutputSentinelTimeoutRetrySettings(BaseModel):
|
|
|
85
92
|
r"""The maximum backoff interval, in milliseconds, Cribl Stream should apply. Default (and minimum) is 10,000 ms (10 seconds); maximum is 180,000 ms (180 seconds)."""
|
|
86
93
|
|
|
87
94
|
|
|
88
|
-
class OutputSentinelBackpressureBehavior(str, Enum):
|
|
95
|
+
class OutputSentinelBackpressureBehavior(str, Enum, metaclass=utils.OpenEnumMeta):
|
|
89
96
|
r"""How to handle events when all receivers are exerting backpressure"""
|
|
90
97
|
|
|
98
|
+
# Block
|
|
91
99
|
BLOCK = "block"
|
|
100
|
+
# Drop
|
|
92
101
|
DROP = "drop"
|
|
102
|
+
# Persistent Queue
|
|
93
103
|
QUEUE = "queue"
|
|
94
104
|
|
|
95
105
|
|
|
96
|
-
class AuthType(str, Enum):
|
|
106
|
+
class AuthType(str, Enum, metaclass=utils.OpenEnumMeta):
|
|
97
107
|
OAUTH = "oauth"
|
|
98
108
|
|
|
99
109
|
|
|
100
|
-
class EndpointConfiguration(str, Enum):
|
|
110
|
+
class EndpointConfiguration(str, Enum, metaclass=utils.OpenEnumMeta):
|
|
101
111
|
r"""Enter the data collection endpoint URL or the individual ID"""
|
|
102
112
|
|
|
113
|
+
# URL
|
|
103
114
|
URL = "url"
|
|
115
|
+
# ID
|
|
104
116
|
ID = "ID"
|
|
105
117
|
|
|
106
118
|
|
|
107
|
-
class OutputSentinelFormat(str, Enum):
|
|
119
|
+
class OutputSentinelFormat(str, Enum, metaclass=utils.OpenEnumMeta):
|
|
108
120
|
NDJSON = "ndjson"
|
|
109
121
|
JSON_ARRAY = "json_array"
|
|
110
122
|
CUSTOM = "custom"
|
|
111
123
|
ADVANCED = "advanced"
|
|
112
124
|
|
|
113
125
|
|
|
114
|
-
class
|
|
126
|
+
class OutputSentinelMode(str, Enum, metaclass=utils.OpenEnumMeta):
|
|
127
|
+
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."""
|
|
128
|
+
|
|
129
|
+
# Error
|
|
130
|
+
ERROR = "error"
|
|
131
|
+
# Backpressure
|
|
132
|
+
ALWAYS = "always"
|
|
133
|
+
# Always On
|
|
134
|
+
BACKPRESSURE = "backpressure"
|
|
135
|
+
|
|
136
|
+
|
|
137
|
+
class OutputSentinelCompression(str, Enum, metaclass=utils.OpenEnumMeta):
|
|
115
138
|
r"""Codec to use to compress the persisted data"""
|
|
116
139
|
|
|
140
|
+
# None
|
|
117
141
|
NONE = "none"
|
|
142
|
+
# Gzip
|
|
118
143
|
GZIP = "gzip"
|
|
119
144
|
|
|
120
145
|
|
|
121
|
-
class OutputSentinelQueueFullBehavior(str, Enum):
|
|
146
|
+
class OutputSentinelQueueFullBehavior(str, Enum, metaclass=utils.OpenEnumMeta):
|
|
122
147
|
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."""
|
|
123
148
|
|
|
149
|
+
# Block
|
|
124
150
|
BLOCK = "block"
|
|
151
|
+
# Drop new data
|
|
125
152
|
DROP = "drop"
|
|
126
153
|
|
|
127
154
|
|
|
128
|
-
class OutputSentinelMode(str, Enum):
|
|
129
|
-
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."""
|
|
130
|
-
|
|
131
|
-
ERROR = "error"
|
|
132
|
-
BACKPRESSURE = "backpressure"
|
|
133
|
-
ALWAYS = "always"
|
|
134
|
-
|
|
135
|
-
|
|
136
155
|
class OutputSentinelPqControlsTypedDict(TypedDict):
|
|
137
156
|
pass
|
|
138
157
|
|
|
@@ -220,6 +239,16 @@ class OutputSentinelTypedDict(TypedDict):
|
|
|
220
239
|
r"""Custom JavaScript code to format incoming event data accessible through the __e variable. The formatted content is added to (__e['__eventOut']) if available. Otherwise, the original event is serialized as JSON. Caution: This function is evaluated in an unprotected context, allowing you to execute almost any JavaScript code."""
|
|
221
240
|
format_payload_code: NotRequired[str]
|
|
222
241
|
r"""Optional JavaScript code to format the payload sent to the Destination. The payload, containing a batch of formatted events, is accessible through the __e['payload'] variable. The formatted payload is returned in the __e['__payloadOut'] variable. Caution: This function is evaluated in an unprotected context, allowing you to execute almost any JavaScript code."""
|
|
242
|
+
pq_strict_ordering: NotRequired[bool]
|
|
243
|
+
r"""Use FIFO (first in, first out) processing. Disable to forward new events to receivers before queue is flushed."""
|
|
244
|
+
pq_rate_per_sec: NotRequired[float]
|
|
245
|
+
r"""Throttling rate (in events per second) to impose while writing to Destinations from PQ. Defaults to 0, which disables throttling."""
|
|
246
|
+
pq_mode: NotRequired[OutputSentinelMode]
|
|
247
|
+
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."""
|
|
248
|
+
pq_max_buffer_size: NotRequired[float]
|
|
249
|
+
r"""The maximum number of events to hold in memory before writing the events to disk"""
|
|
250
|
+
pq_max_backpressure_sec: NotRequired[float]
|
|
251
|
+
r"""How long (in seconds) to wait for backpressure to resolve before engaging the queue"""
|
|
223
252
|
pq_max_file_size: NotRequired[str]
|
|
224
253
|
r"""The maximum size to store in each queue file before closing and optionally compressing (KB, MB, etc.)"""
|
|
225
254
|
pq_max_size: NotRequired[str]
|
|
@@ -230,8 +259,6 @@ class OutputSentinelTypedDict(TypedDict):
|
|
|
230
259
|
r"""Codec to use to compress the persisted data"""
|
|
231
260
|
pq_on_backpressure: NotRequired[OutputSentinelQueueFullBehavior]
|
|
232
261
|
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."""
|
|
233
|
-
pq_mode: NotRequired[OutputSentinelMode]
|
|
234
|
-
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."""
|
|
235
262
|
pq_controls: NotRequired[OutputSentinelPqControlsTypedDict]
|
|
236
263
|
url: NotRequired[str]
|
|
237
264
|
r"""URL to send events to. Can be overwritten by an event's __url field."""
|
|
@@ -319,7 +346,10 @@ class OutputSentinel(BaseModel):
|
|
|
319
346
|
r"""Enable round-robin DNS lookup. When a DNS server returns multiple addresses, @{product} will cycle through them in the order returned. For optimal performance, consider enabling this setting for non-load balanced destinations."""
|
|
320
347
|
|
|
321
348
|
failed_request_logging_mode: Annotated[
|
|
322
|
-
|
|
349
|
+
Annotated[
|
|
350
|
+
Optional[OutputSentinelFailedRequestLoggingMode],
|
|
351
|
+
PlainValidator(validate_open_enum(False)),
|
|
352
|
+
],
|
|
323
353
|
pydantic.Field(alias="failedRequestLoggingMode"),
|
|
324
354
|
] = OutputSentinelFailedRequestLoggingMode.NONE
|
|
325
355
|
r"""Data to log when a request fails. All headers are redacted by default, unless listed as safe headers below."""
|
|
@@ -346,18 +376,26 @@ class OutputSentinel(BaseModel):
|
|
|
346
376
|
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."""
|
|
347
377
|
|
|
348
378
|
on_backpressure: Annotated[
|
|
349
|
-
|
|
379
|
+
Annotated[
|
|
380
|
+
Optional[OutputSentinelBackpressureBehavior],
|
|
381
|
+
PlainValidator(validate_open_enum(False)),
|
|
382
|
+
],
|
|
350
383
|
pydantic.Field(alias="onBackpressure"),
|
|
351
384
|
] = OutputSentinelBackpressureBehavior.BLOCK
|
|
352
385
|
r"""How to handle events when all receivers are exerting backpressure"""
|
|
353
386
|
|
|
354
|
-
auth_type: Annotated[
|
|
387
|
+
auth_type: Annotated[
|
|
388
|
+
Annotated[Optional[AuthType], PlainValidator(validate_open_enum(False))],
|
|
389
|
+
pydantic.Field(alias="authType"),
|
|
390
|
+
] = None
|
|
355
391
|
|
|
356
392
|
scope: Optional[str] = "https://monitor.azure.com/.default"
|
|
357
393
|
r"""Scope to pass in the OAuth request"""
|
|
358
394
|
|
|
359
395
|
endpoint_url_configuration: Annotated[
|
|
360
|
-
|
|
396
|
+
Annotated[
|
|
397
|
+
Optional[EndpointConfiguration], PlainValidator(validate_open_enum(False))
|
|
398
|
+
],
|
|
361
399
|
pydantic.Field(alias="endpointURLConfiguration"),
|
|
362
400
|
] = EndpointConfiguration.URL
|
|
363
401
|
r"""Enter the data collection endpoint URL or the individual ID"""
|
|
@@ -370,7 +408,10 @@ class OutputSentinel(BaseModel):
|
|
|
370
408
|
description: Optional[str] = None
|
|
371
409
|
|
|
372
410
|
format_: Annotated[
|
|
373
|
-
|
|
411
|
+
Annotated[
|
|
412
|
+
Optional[OutputSentinelFormat], PlainValidator(validate_open_enum(False))
|
|
413
|
+
],
|
|
414
|
+
pydantic.Field(alias="format"),
|
|
374
415
|
] = None
|
|
375
416
|
|
|
376
417
|
custom_source_expression: Annotated[
|
|
@@ -413,6 +454,34 @@ class OutputSentinel(BaseModel):
|
|
|
413
454
|
] = None
|
|
414
455
|
r"""Optional JavaScript code to format the payload sent to the Destination. The payload, containing a batch of formatted events, is accessible through the __e['payload'] variable. The formatted payload is returned in the __e['__payloadOut'] variable. Caution: This function is evaluated in an unprotected context, allowing you to execute almost any JavaScript code."""
|
|
415
456
|
|
|
457
|
+
pq_strict_ordering: Annotated[
|
|
458
|
+
Optional[bool], pydantic.Field(alias="pqStrictOrdering")
|
|
459
|
+
] = True
|
|
460
|
+
r"""Use FIFO (first in, first out) processing. Disable to forward new events to receivers before queue is flushed."""
|
|
461
|
+
|
|
462
|
+
pq_rate_per_sec: Annotated[
|
|
463
|
+
Optional[float], pydantic.Field(alias="pqRatePerSec")
|
|
464
|
+
] = 0
|
|
465
|
+
r"""Throttling rate (in events per second) to impose while writing to Destinations from PQ. Defaults to 0, which disables throttling."""
|
|
466
|
+
|
|
467
|
+
pq_mode: Annotated[
|
|
468
|
+
Annotated[
|
|
469
|
+
Optional[OutputSentinelMode], PlainValidator(validate_open_enum(False))
|
|
470
|
+
],
|
|
471
|
+
pydantic.Field(alias="pqMode"),
|
|
472
|
+
] = OutputSentinelMode.ERROR
|
|
473
|
+
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."""
|
|
474
|
+
|
|
475
|
+
pq_max_buffer_size: Annotated[
|
|
476
|
+
Optional[float], pydantic.Field(alias="pqMaxBufferSize")
|
|
477
|
+
] = 42
|
|
478
|
+
r"""The maximum number of events to hold in memory before writing the events to disk"""
|
|
479
|
+
|
|
480
|
+
pq_max_backpressure_sec: Annotated[
|
|
481
|
+
Optional[float], pydantic.Field(alias="pqMaxBackpressureSec")
|
|
482
|
+
] = 30
|
|
483
|
+
r"""How long (in seconds) to wait for backpressure to resolve before engaging the queue"""
|
|
484
|
+
|
|
416
485
|
pq_max_file_size: Annotated[
|
|
417
486
|
Optional[str], pydantic.Field(alias="pqMaxFileSize")
|
|
418
487
|
] = "1 MB"
|
|
@@ -427,21 +496,23 @@ class OutputSentinel(BaseModel):
|
|
|
427
496
|
r"""The location for the persistent queue files. To this field's value, the system will append: /<worker-id>/<output-id>."""
|
|
428
497
|
|
|
429
498
|
pq_compress: Annotated[
|
|
430
|
-
|
|
499
|
+
Annotated[
|
|
500
|
+
Optional[OutputSentinelCompression],
|
|
501
|
+
PlainValidator(validate_open_enum(False)),
|
|
502
|
+
],
|
|
503
|
+
pydantic.Field(alias="pqCompress"),
|
|
431
504
|
] = OutputSentinelCompression.NONE
|
|
432
505
|
r"""Codec to use to compress the persisted data"""
|
|
433
506
|
|
|
434
507
|
pq_on_backpressure: Annotated[
|
|
435
|
-
|
|
508
|
+
Annotated[
|
|
509
|
+
Optional[OutputSentinelQueueFullBehavior],
|
|
510
|
+
PlainValidator(validate_open_enum(False)),
|
|
511
|
+
],
|
|
436
512
|
pydantic.Field(alias="pqOnBackpressure"),
|
|
437
513
|
] = OutputSentinelQueueFullBehavior.BLOCK
|
|
438
514
|
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."""
|
|
439
515
|
|
|
440
|
-
pq_mode: Annotated[Optional[OutputSentinelMode], pydantic.Field(alias="pqMode")] = (
|
|
441
|
-
OutputSentinelMode.ERROR
|
|
442
|
-
)
|
|
443
|
-
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."""
|
|
444
|
-
|
|
445
516
|
pq_controls: Annotated[
|
|
446
517
|
Optional[OutputSentinelPqControls], pydantic.Field(alias="pqControls")
|
|
447
518
|
] = None
|
|
@@ -457,3 +528,75 @@ class OutputSentinel(BaseModel):
|
|
|
457
528
|
|
|
458
529
|
stream_name: Annotated[Optional[str], pydantic.Field(alias="streamName")] = None
|
|
459
530
|
r"""The name of the stream (Sentinel table) in which to store the events"""
|
|
531
|
+
|
|
532
|
+
@field_serializer("failed_request_logging_mode")
|
|
533
|
+
def serialize_failed_request_logging_mode(self, value):
|
|
534
|
+
if isinstance(value, str):
|
|
535
|
+
try:
|
|
536
|
+
return models.OutputSentinelFailedRequestLoggingMode(value)
|
|
537
|
+
except ValueError:
|
|
538
|
+
return value
|
|
539
|
+
return value
|
|
540
|
+
|
|
541
|
+
@field_serializer("on_backpressure")
|
|
542
|
+
def serialize_on_backpressure(self, value):
|
|
543
|
+
if isinstance(value, str):
|
|
544
|
+
try:
|
|
545
|
+
return models.OutputSentinelBackpressureBehavior(value)
|
|
546
|
+
except ValueError:
|
|
547
|
+
return value
|
|
548
|
+
return value
|
|
549
|
+
|
|
550
|
+
@field_serializer("auth_type")
|
|
551
|
+
def serialize_auth_type(self, value):
|
|
552
|
+
if isinstance(value, str):
|
|
553
|
+
try:
|
|
554
|
+
return models.AuthType(value)
|
|
555
|
+
except ValueError:
|
|
556
|
+
return value
|
|
557
|
+
return value
|
|
558
|
+
|
|
559
|
+
@field_serializer("endpoint_url_configuration")
|
|
560
|
+
def serialize_endpoint_url_configuration(self, value):
|
|
561
|
+
if isinstance(value, str):
|
|
562
|
+
try:
|
|
563
|
+
return models.EndpointConfiguration(value)
|
|
564
|
+
except ValueError:
|
|
565
|
+
return value
|
|
566
|
+
return value
|
|
567
|
+
|
|
568
|
+
@field_serializer("format_")
|
|
569
|
+
def serialize_format_(self, value):
|
|
570
|
+
if isinstance(value, str):
|
|
571
|
+
try:
|
|
572
|
+
return models.OutputSentinelFormat(value)
|
|
573
|
+
except ValueError:
|
|
574
|
+
return value
|
|
575
|
+
return value
|
|
576
|
+
|
|
577
|
+
@field_serializer("pq_mode")
|
|
578
|
+
def serialize_pq_mode(self, value):
|
|
579
|
+
if isinstance(value, str):
|
|
580
|
+
try:
|
|
581
|
+
return models.OutputSentinelMode(value)
|
|
582
|
+
except ValueError:
|
|
583
|
+
return value
|
|
584
|
+
return value
|
|
585
|
+
|
|
586
|
+
@field_serializer("pq_compress")
|
|
587
|
+
def serialize_pq_compress(self, value):
|
|
588
|
+
if isinstance(value, str):
|
|
589
|
+
try:
|
|
590
|
+
return models.OutputSentinelCompression(value)
|
|
591
|
+
except ValueError:
|
|
592
|
+
return value
|
|
593
|
+
return value
|
|
594
|
+
|
|
595
|
+
@field_serializer("pq_on_backpressure")
|
|
596
|
+
def serialize_pq_on_backpressure(self, value):
|
|
597
|
+
if isinstance(value, str):
|
|
598
|
+
try:
|
|
599
|
+
return models.OutputSentinelQueueFullBehavior(value)
|
|
600
|
+
except ValueError:
|
|
601
|
+
return value
|
|
602
|
+
return value
|
|
@@ -1,9 +1,13 @@
|
|
|
1
1
|
"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
|
|
2
2
|
|
|
3
3
|
from __future__ import annotations
|
|
4
|
+
from cribl_control_plane import models, utils
|
|
4
5
|
from cribl_control_plane.types import BaseModel
|
|
6
|
+
from cribl_control_plane.utils import validate_open_enum
|
|
5
7
|
from enum import Enum
|
|
6
8
|
import pydantic
|
|
9
|
+
from pydantic import field_serializer
|
|
10
|
+
from pydantic.functional_validators import PlainValidator
|
|
7
11
|
from typing import List, Optional
|
|
8
12
|
from typing_extensions import Annotated, NotRequired, TypedDict
|
|
9
13
|
|
|
@@ -12,7 +16,7 @@ class OutputSentinelOneAiSiemType(str, Enum):
|
|
|
12
16
|
SENTINEL_ONE_AI_SIEM = "sentinel_one_ai_siem"
|
|
13
17
|
|
|
14
18
|
|
|
15
|
-
class OutputSentinelOneAiSiemRegion(str, Enum):
|
|
19
|
+
class OutputSentinelOneAiSiemRegion(str, Enum, metaclass=utils.OpenEnumMeta):
|
|
16
20
|
r"""The SentinelOne region to send events to. In most cases you can find the region by either looking at your SentinelOne URL or knowing what geographic region your SentinelOne instance is contained in."""
|
|
17
21
|
|
|
18
22
|
US = "US"
|
|
@@ -24,7 +28,7 @@ class OutputSentinelOneAiSiemRegion(str, Enum):
|
|
|
24
28
|
CUSTOM = "Custom"
|
|
25
29
|
|
|
26
30
|
|
|
27
|
-
class AISIEMEndpointPath(str, Enum):
|
|
31
|
+
class AISIEMEndpointPath(str, Enum, metaclass=utils.OpenEnumMeta):
|
|
28
32
|
r"""Endpoint to send events to. Use /services/collector/event for structured JSON payloads with standard HEC top-level fields. Use /services/collector/raw for unstructured log lines (plain text)."""
|
|
29
33
|
|
|
30
34
|
ROOT_SERVICES_COLLECTOR_EVENT = "/services/collector/event"
|
|
@@ -42,15 +46,22 @@ class OutputSentinelOneAiSiemExtraHTTPHeader(BaseModel):
|
|
|
42
46
|
name: Optional[str] = None
|
|
43
47
|
|
|
44
48
|
|
|
45
|
-
class OutputSentinelOneAiSiemFailedRequestLoggingMode(
|
|
49
|
+
class OutputSentinelOneAiSiemFailedRequestLoggingMode(
|
|
50
|
+
str, Enum, metaclass=utils.OpenEnumMeta
|
|
51
|
+
):
|
|
46
52
|
r"""Data to log when a request fails. All headers are redacted by default, unless listed as safe headers below."""
|
|
47
53
|
|
|
54
|
+
# Payload
|
|
48
55
|
PAYLOAD = "payload"
|
|
56
|
+
# Payload + Headers
|
|
49
57
|
PAYLOAD_AND_HEADERS = "payloadAndHeaders"
|
|
58
|
+
# None
|
|
50
59
|
NONE = "none"
|
|
51
60
|
|
|
52
61
|
|
|
53
|
-
class OutputSentinelOneAiSiemAuthenticationMethod(
|
|
62
|
+
class OutputSentinelOneAiSiemAuthenticationMethod(
|
|
63
|
+
str, Enum, metaclass=utils.OpenEnumMeta
|
|
64
|
+
):
|
|
54
65
|
r"""Select Manual to enter an auth token directly, or select Secret to use a text secret to authenticate"""
|
|
55
66
|
|
|
56
67
|
MANUAL = "manual"
|
|
@@ -111,36 +122,48 @@ class OutputSentinelOneAiSiemTimeoutRetrySettings(BaseModel):
|
|
|
111
122
|
r"""The maximum backoff interval, in milliseconds, Cribl Stream should apply. Default (and minimum) is 10,000 ms (10 seconds); maximum is 180,000 ms (180 seconds)."""
|
|
112
123
|
|
|
113
124
|
|
|
114
|
-
class OutputSentinelOneAiSiemBackpressureBehavior(
|
|
125
|
+
class OutputSentinelOneAiSiemBackpressureBehavior(
|
|
126
|
+
str, Enum, metaclass=utils.OpenEnumMeta
|
|
127
|
+
):
|
|
115
128
|
r"""How to handle events when all receivers are exerting backpressure"""
|
|
116
129
|
|
|
130
|
+
# Block
|
|
117
131
|
BLOCK = "block"
|
|
132
|
+
# Drop
|
|
118
133
|
DROP = "drop"
|
|
134
|
+
# Persistent Queue
|
|
119
135
|
QUEUE = "queue"
|
|
120
136
|
|
|
121
137
|
|
|
122
|
-
class
|
|
138
|
+
class OutputSentinelOneAiSiemMode(str, Enum, metaclass=utils.OpenEnumMeta):
|
|
139
|
+
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."""
|
|
140
|
+
|
|
141
|
+
# Error
|
|
142
|
+
ERROR = "error"
|
|
143
|
+
# Backpressure
|
|
144
|
+
ALWAYS = "always"
|
|
145
|
+
# Always On
|
|
146
|
+
BACKPRESSURE = "backpressure"
|
|
147
|
+
|
|
148
|
+
|
|
149
|
+
class OutputSentinelOneAiSiemCompression(str, Enum, metaclass=utils.OpenEnumMeta):
|
|
123
150
|
r"""Codec to use to compress the persisted data"""
|
|
124
151
|
|
|
152
|
+
# None
|
|
125
153
|
NONE = "none"
|
|
154
|
+
# Gzip
|
|
126
155
|
GZIP = "gzip"
|
|
127
156
|
|
|
128
157
|
|
|
129
|
-
class OutputSentinelOneAiSiemQueueFullBehavior(str, Enum):
|
|
158
|
+
class OutputSentinelOneAiSiemQueueFullBehavior(str, Enum, metaclass=utils.OpenEnumMeta):
|
|
130
159
|
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."""
|
|
131
160
|
|
|
161
|
+
# Block
|
|
132
162
|
BLOCK = "block"
|
|
163
|
+
# Drop new data
|
|
133
164
|
DROP = "drop"
|
|
134
165
|
|
|
135
166
|
|
|
136
|
-
class OutputSentinelOneAiSiemMode(str, Enum):
|
|
137
|
-
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."""
|
|
138
|
-
|
|
139
|
-
ERROR = "error"
|
|
140
|
-
BACKPRESSURE = "backpressure"
|
|
141
|
-
ALWAYS = "always"
|
|
142
|
-
|
|
143
|
-
|
|
144
167
|
class OutputSentinelOneAiSiemPqControlsTypedDict(TypedDict):
|
|
145
168
|
pass
|
|
146
169
|
|
|
@@ -240,6 +263,16 @@ class OutputSentinelOneAiSiemTypedDict(TypedDict):
|
|
|
240
263
|
r"""Specify the dataSource.vendorvalue to pass as a parameter to AI SIEM. This value should reflect the vendor of the data being inserted. Don't quote this value. The default is cribl."""
|
|
241
264
|
event_type: NotRequired[str]
|
|
242
265
|
r"""Specify the event.type value to pass as an optional parameter to AI SIEM. This value acts as a label, grouping events into meaningful categories like Process Creation, File Modification, or Network Connection. Don't quote this value. By default, this field is empty."""
|
|
266
|
+
pq_strict_ordering: NotRequired[bool]
|
|
267
|
+
r"""Use FIFO (first in, first out) processing. Disable to forward new events to receivers before queue is flushed."""
|
|
268
|
+
pq_rate_per_sec: NotRequired[float]
|
|
269
|
+
r"""Throttling rate (in events per second) to impose while writing to Destinations from PQ. Defaults to 0, which disables throttling."""
|
|
270
|
+
pq_mode: NotRequired[OutputSentinelOneAiSiemMode]
|
|
271
|
+
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."""
|
|
272
|
+
pq_max_buffer_size: NotRequired[float]
|
|
273
|
+
r"""The maximum number of events to hold in memory before writing the events to disk"""
|
|
274
|
+
pq_max_backpressure_sec: NotRequired[float]
|
|
275
|
+
r"""How long (in seconds) to wait for backpressure to resolve before engaging the queue"""
|
|
243
276
|
pq_max_file_size: NotRequired[str]
|
|
244
277
|
r"""The maximum size to store in each queue file before closing and optionally compressing (KB, MB, etc.)"""
|
|
245
278
|
pq_max_size: NotRequired[str]
|
|
@@ -250,8 +283,6 @@ class OutputSentinelOneAiSiemTypedDict(TypedDict):
|
|
|
250
283
|
r"""Codec to use to compress the persisted data"""
|
|
251
284
|
pq_on_backpressure: NotRequired[OutputSentinelOneAiSiemQueueFullBehavior]
|
|
252
285
|
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."""
|
|
253
|
-
pq_mode: NotRequired[OutputSentinelOneAiSiemMode]
|
|
254
|
-
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."""
|
|
255
286
|
pq_controls: NotRequired[OutputSentinelOneAiSiemPqControlsTypedDict]
|
|
256
287
|
|
|
257
288
|
|
|
@@ -275,12 +306,15 @@ class OutputSentinelOneAiSiem(BaseModel):
|
|
|
275
306
|
streamtags: Optional[List[str]] = None
|
|
276
307
|
r"""Tags for filtering and grouping in @{product}"""
|
|
277
308
|
|
|
278
|
-
region:
|
|
309
|
+
region: Annotated[
|
|
310
|
+
Optional[OutputSentinelOneAiSiemRegion],
|
|
311
|
+
PlainValidator(validate_open_enum(False)),
|
|
312
|
+
] = OutputSentinelOneAiSiemRegion.US
|
|
279
313
|
r"""The SentinelOne region to send events to. In most cases you can find the region by either looking at your SentinelOne URL or knowing what geographic region your SentinelOne instance is contained in."""
|
|
280
314
|
|
|
281
|
-
endpoint:
|
|
282
|
-
AISIEMEndpointPath
|
|
283
|
-
|
|
315
|
+
endpoint: Annotated[
|
|
316
|
+
Optional[AISIEMEndpointPath], PlainValidator(validate_open_enum(False))
|
|
317
|
+
] = AISIEMEndpointPath.ROOT_SERVICES_COLLECTOR_EVENT
|
|
284
318
|
r"""Endpoint to send events to. Use /services/collector/event for structured JSON payloads with standard HEC top-level fields. Use /services/collector/raw for unstructured log lines (plain text)."""
|
|
285
319
|
|
|
286
320
|
concurrency: Optional[float] = 5
|
|
@@ -322,7 +356,10 @@ class OutputSentinelOneAiSiem(BaseModel):
|
|
|
322
356
|
r"""Headers to add to all events"""
|
|
323
357
|
|
|
324
358
|
failed_request_logging_mode: Annotated[
|
|
325
|
-
|
|
359
|
+
Annotated[
|
|
360
|
+
Optional[OutputSentinelOneAiSiemFailedRequestLoggingMode],
|
|
361
|
+
PlainValidator(validate_open_enum(False)),
|
|
362
|
+
],
|
|
326
363
|
pydantic.Field(alias="failedRequestLoggingMode"),
|
|
327
364
|
] = OutputSentinelOneAiSiemFailedRequestLoggingMode.NONE
|
|
328
365
|
r"""Data to log when a request fails. All headers are redacted by default, unless listed as safe headers below."""
|
|
@@ -333,7 +370,10 @@ class OutputSentinelOneAiSiem(BaseModel):
|
|
|
333
370
|
r"""List of headers that are safe to log in plain text"""
|
|
334
371
|
|
|
335
372
|
auth_type: Annotated[
|
|
336
|
-
|
|
373
|
+
Annotated[
|
|
374
|
+
Optional[OutputSentinelOneAiSiemAuthenticationMethod],
|
|
375
|
+
PlainValidator(validate_open_enum(False)),
|
|
376
|
+
],
|
|
337
377
|
pydantic.Field(alias="authType"),
|
|
338
378
|
] = OutputSentinelOneAiSiemAuthenticationMethod.MANUAL
|
|
339
379
|
r"""Select Manual to enter an auth token directly, or select Secret to use a text secret to authenticate"""
|
|
@@ -351,11 +391,14 @@ class OutputSentinelOneAiSiem(BaseModel):
|
|
|
351
391
|
|
|
352
392
|
response_honor_retry_after_header: Annotated[
|
|
353
393
|
Optional[bool], pydantic.Field(alias="responseHonorRetryAfterHeader")
|
|
354
|
-
] =
|
|
394
|
+
] = True
|
|
355
395
|
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
396
|
|
|
357
397
|
on_backpressure: Annotated[
|
|
358
|
-
|
|
398
|
+
Annotated[
|
|
399
|
+
Optional[OutputSentinelOneAiSiemBackpressureBehavior],
|
|
400
|
+
PlainValidator(validate_open_enum(False)),
|
|
401
|
+
],
|
|
359
402
|
pydantic.Field(alias="onBackpressure"),
|
|
360
403
|
] = OutputSentinelOneAiSiemBackpressureBehavior.BLOCK
|
|
361
404
|
r"""How to handle events when all receivers are exerting backpressure"""
|
|
@@ -437,6 +480,35 @@ class OutputSentinelOneAiSiem(BaseModel):
|
|
|
437
480
|
event_type: Annotated[Optional[str], pydantic.Field(alias="eventType")] = ""
|
|
438
481
|
r"""Specify the event.type value to pass as an optional parameter to AI SIEM. This value acts as a label, grouping events into meaningful categories like Process Creation, File Modification, or Network Connection. Don't quote this value. By default, this field is empty."""
|
|
439
482
|
|
|
483
|
+
pq_strict_ordering: Annotated[
|
|
484
|
+
Optional[bool], pydantic.Field(alias="pqStrictOrdering")
|
|
485
|
+
] = True
|
|
486
|
+
r"""Use FIFO (first in, first out) processing. Disable to forward new events to receivers before queue is flushed."""
|
|
487
|
+
|
|
488
|
+
pq_rate_per_sec: Annotated[
|
|
489
|
+
Optional[float], pydantic.Field(alias="pqRatePerSec")
|
|
490
|
+
] = 0
|
|
491
|
+
r"""Throttling rate (in events per second) to impose while writing to Destinations from PQ. Defaults to 0, which disables throttling."""
|
|
492
|
+
|
|
493
|
+
pq_mode: Annotated[
|
|
494
|
+
Annotated[
|
|
495
|
+
Optional[OutputSentinelOneAiSiemMode],
|
|
496
|
+
PlainValidator(validate_open_enum(False)),
|
|
497
|
+
],
|
|
498
|
+
pydantic.Field(alias="pqMode"),
|
|
499
|
+
] = OutputSentinelOneAiSiemMode.ERROR
|
|
500
|
+
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."""
|
|
501
|
+
|
|
502
|
+
pq_max_buffer_size: Annotated[
|
|
503
|
+
Optional[float], pydantic.Field(alias="pqMaxBufferSize")
|
|
504
|
+
] = 42
|
|
505
|
+
r"""The maximum number of events to hold in memory before writing the events to disk"""
|
|
506
|
+
|
|
507
|
+
pq_max_backpressure_sec: Annotated[
|
|
508
|
+
Optional[float], pydantic.Field(alias="pqMaxBackpressureSec")
|
|
509
|
+
] = 30
|
|
510
|
+
r"""How long (in seconds) to wait for backpressure to resolve before engaging the queue"""
|
|
511
|
+
|
|
440
512
|
pq_max_file_size: Annotated[
|
|
441
513
|
Optional[str], pydantic.Field(alias="pqMaxFileSize")
|
|
442
514
|
] = "1 MB"
|
|
@@ -451,21 +523,95 @@ class OutputSentinelOneAiSiem(BaseModel):
|
|
|
451
523
|
r"""The location for the persistent queue files. To this field's value, the system will append: /<worker-id>/<output-id>."""
|
|
452
524
|
|
|
453
525
|
pq_compress: Annotated[
|
|
454
|
-
|
|
526
|
+
Annotated[
|
|
527
|
+
Optional[OutputSentinelOneAiSiemCompression],
|
|
528
|
+
PlainValidator(validate_open_enum(False)),
|
|
529
|
+
],
|
|
530
|
+
pydantic.Field(alias="pqCompress"),
|
|
455
531
|
] = OutputSentinelOneAiSiemCompression.NONE
|
|
456
532
|
r"""Codec to use to compress the persisted data"""
|
|
457
533
|
|
|
458
534
|
pq_on_backpressure: Annotated[
|
|
459
|
-
|
|
535
|
+
Annotated[
|
|
536
|
+
Optional[OutputSentinelOneAiSiemQueueFullBehavior],
|
|
537
|
+
PlainValidator(validate_open_enum(False)),
|
|
538
|
+
],
|
|
460
539
|
pydantic.Field(alias="pqOnBackpressure"),
|
|
461
540
|
] = OutputSentinelOneAiSiemQueueFullBehavior.BLOCK
|
|
462
541
|
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."""
|
|
463
542
|
|
|
464
|
-
pq_mode: Annotated[
|
|
465
|
-
Optional[OutputSentinelOneAiSiemMode], pydantic.Field(alias="pqMode")
|
|
466
|
-
] = OutputSentinelOneAiSiemMode.ERROR
|
|
467
|
-
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."""
|
|
468
|
-
|
|
469
543
|
pq_controls: Annotated[
|
|
470
544
|
Optional[OutputSentinelOneAiSiemPqControls], pydantic.Field(alias="pqControls")
|
|
471
545
|
] = None
|
|
546
|
+
|
|
547
|
+
@field_serializer("region")
|
|
548
|
+
def serialize_region(self, value):
|
|
549
|
+
if isinstance(value, str):
|
|
550
|
+
try:
|
|
551
|
+
return models.OutputSentinelOneAiSiemRegion(value)
|
|
552
|
+
except ValueError:
|
|
553
|
+
return value
|
|
554
|
+
return value
|
|
555
|
+
|
|
556
|
+
@field_serializer("endpoint")
|
|
557
|
+
def serialize_endpoint(self, value):
|
|
558
|
+
if isinstance(value, str):
|
|
559
|
+
try:
|
|
560
|
+
return models.AISIEMEndpointPath(value)
|
|
561
|
+
except ValueError:
|
|
562
|
+
return value
|
|
563
|
+
return value
|
|
564
|
+
|
|
565
|
+
@field_serializer("failed_request_logging_mode")
|
|
566
|
+
def serialize_failed_request_logging_mode(self, value):
|
|
567
|
+
if isinstance(value, str):
|
|
568
|
+
try:
|
|
569
|
+
return models.OutputSentinelOneAiSiemFailedRequestLoggingMode(value)
|
|
570
|
+
except ValueError:
|
|
571
|
+
return value
|
|
572
|
+
return value
|
|
573
|
+
|
|
574
|
+
@field_serializer("auth_type")
|
|
575
|
+
def serialize_auth_type(self, value):
|
|
576
|
+
if isinstance(value, str):
|
|
577
|
+
try:
|
|
578
|
+
return models.OutputSentinelOneAiSiemAuthenticationMethod(value)
|
|
579
|
+
except ValueError:
|
|
580
|
+
return value
|
|
581
|
+
return value
|
|
582
|
+
|
|
583
|
+
@field_serializer("on_backpressure")
|
|
584
|
+
def serialize_on_backpressure(self, value):
|
|
585
|
+
if isinstance(value, str):
|
|
586
|
+
try:
|
|
587
|
+
return models.OutputSentinelOneAiSiemBackpressureBehavior(value)
|
|
588
|
+
except ValueError:
|
|
589
|
+
return value
|
|
590
|
+
return value
|
|
591
|
+
|
|
592
|
+
@field_serializer("pq_mode")
|
|
593
|
+
def serialize_pq_mode(self, value):
|
|
594
|
+
if isinstance(value, str):
|
|
595
|
+
try:
|
|
596
|
+
return models.OutputSentinelOneAiSiemMode(value)
|
|
597
|
+
except ValueError:
|
|
598
|
+
return value
|
|
599
|
+
return value
|
|
600
|
+
|
|
601
|
+
@field_serializer("pq_compress")
|
|
602
|
+
def serialize_pq_compress(self, value):
|
|
603
|
+
if isinstance(value, str):
|
|
604
|
+
try:
|
|
605
|
+
return models.OutputSentinelOneAiSiemCompression(value)
|
|
606
|
+
except ValueError:
|
|
607
|
+
return value
|
|
608
|
+
return value
|
|
609
|
+
|
|
610
|
+
@field_serializer("pq_on_backpressure")
|
|
611
|
+
def serialize_pq_on_backpressure(self, value):
|
|
612
|
+
if isinstance(value, str):
|
|
613
|
+
try:
|
|
614
|
+
return models.OutputSentinelOneAiSiemQueueFullBehavior(value)
|
|
615
|
+
except ValueError:
|
|
616
|
+
return value
|
|
617
|
+
return value
|