cribl-control-plane 0.2.1__py3-none-any.whl → 0.2.1rc2__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Potentially problematic release.


This version of cribl-control-plane might be problematic. Click here for more details.

Files changed (157) hide show
  1. cribl_control_plane/_version.py +3 -5
  2. cribl_control_plane/errors/__init__.py +8 -5
  3. cribl_control_plane/errors/{healthstatus_error.py → healthserverstatus_error.py} +10 -9
  4. cribl_control_plane/groups_sdk.py +52 -28
  5. cribl_control_plane/health.py +22 -16
  6. cribl_control_plane/models/__init__.py +103 -50
  7. cribl_control_plane/models/authtoken.py +5 -1
  8. cribl_control_plane/models/configgroup.py +35 -6
  9. cribl_control_plane/models/createconfiggroupbyproductop.py +6 -5
  10. cribl_control_plane/models/createroutesappendbyidop.py +2 -2
  11. cribl_control_plane/models/createversionundoop.py +3 -3
  12. cribl_control_plane/models/deleteoutputpqbyidop.py +2 -2
  13. cribl_control_plane/models/distributedsummary.py +6 -0
  14. cribl_control_plane/models/groupcreaterequest.py +152 -0
  15. cribl_control_plane/models/hbcriblinfo.py +14 -3
  16. cribl_control_plane/models/{healthstatus.py → healthserverstatus.py} +7 -7
  17. cribl_control_plane/models/heartbeatmetadata.py +3 -0
  18. cribl_control_plane/models/input.py +65 -63
  19. cribl_control_plane/models/inputappscope.py +4 -0
  20. cribl_control_plane/models/inputazureblob.py +4 -0
  21. cribl_control_plane/models/inputcollection.py +4 -0
  22. cribl_control_plane/models/inputconfluentcloud.py +8 -18
  23. cribl_control_plane/models/inputcribl.py +4 -0
  24. cribl_control_plane/models/inputcriblhttp.py +4 -0
  25. cribl_control_plane/models/inputcribllakehttp.py +4 -0
  26. cribl_control_plane/models/inputcriblmetrics.py +4 -0
  27. cribl_control_plane/models/inputcribltcp.py +4 -0
  28. cribl_control_plane/models/inputcrowdstrike.py +7 -0
  29. cribl_control_plane/models/inputdatadogagent.py +4 -0
  30. cribl_control_plane/models/inputdatagen.py +4 -0
  31. cribl_control_plane/models/inputedgeprometheus.py +12 -0
  32. cribl_control_plane/models/inputelastic.py +11 -0
  33. cribl_control_plane/models/inputeventhub.py +6 -0
  34. cribl_control_plane/models/inputexec.py +4 -0
  35. cribl_control_plane/models/inputfile.py +6 -0
  36. cribl_control_plane/models/inputfirehose.py +4 -0
  37. cribl_control_plane/models/inputgooglepubsub.py +7 -0
  38. cribl_control_plane/models/inputgrafana.py +8 -0
  39. cribl_control_plane/models/inputhttp.py +4 -0
  40. cribl_control_plane/models/inputhttpraw.py +4 -0
  41. cribl_control_plane/models/inputjournalfiles.py +4 -0
  42. cribl_control_plane/models/inputkafka.py +8 -17
  43. cribl_control_plane/models/inputkinesis.py +15 -0
  44. cribl_control_plane/models/inputkubeevents.py +4 -0
  45. cribl_control_plane/models/inputkubelogs.py +4 -0
  46. cribl_control_plane/models/inputkubemetrics.py +4 -0
  47. cribl_control_plane/models/inputloki.py +4 -0
  48. cribl_control_plane/models/inputmetrics.py +4 -0
  49. cribl_control_plane/models/inputmodeldriventelemetry.py +4 -0
  50. cribl_control_plane/models/inputmsk.py +7 -17
  51. cribl_control_plane/models/inputnetflow.py +4 -0
  52. cribl_control_plane/models/inputoffice365mgmt.py +11 -0
  53. cribl_control_plane/models/inputoffice365msgtrace.py +11 -0
  54. cribl_control_plane/models/inputoffice365service.py +11 -0
  55. cribl_control_plane/models/inputopentelemetry.py +8 -0
  56. cribl_control_plane/models/inputprometheus.py +10 -0
  57. cribl_control_plane/models/inputprometheusrw.py +4 -0
  58. cribl_control_plane/models/inputrawudp.py +4 -0
  59. cribl_control_plane/models/inputs3.py +7 -0
  60. cribl_control_plane/models/inputs3inventory.py +7 -0
  61. cribl_control_plane/models/inputsecuritylake.py +7 -0
  62. cribl_control_plane/models/inputsnmp.py +11 -0
  63. cribl_control_plane/models/inputsplunk.py +9 -0
  64. cribl_control_plane/models/inputsplunkhec.py +4 -0
  65. cribl_control_plane/models/inputsplunksearch.py +7 -0
  66. cribl_control_plane/models/inputsqs.py +9 -0
  67. cribl_control_plane/models/inputsyslog.py +8 -0
  68. cribl_control_plane/models/inputsystemmetrics.py +32 -0
  69. cribl_control_plane/models/inputsystemstate.py +4 -0
  70. cribl_control_plane/models/inputtcp.py +4 -0
  71. cribl_control_plane/models/inputtcpjson.py +4 -0
  72. cribl_control_plane/models/inputwef.py +6 -0
  73. cribl_control_plane/models/inputwindowsmetrics.py +28 -0
  74. cribl_control_plane/models/inputwineventlogs.py +8 -0
  75. cribl_control_plane/models/inputwiz.py +7 -0
  76. cribl_control_plane/models/inputwizwebhook.py +4 -0
  77. cribl_control_plane/models/inputzscalerhec.py +4 -0
  78. cribl_control_plane/models/jobinfo.py +4 -1
  79. cribl_control_plane/models/logininfo.py +3 -3
  80. cribl_control_plane/models/nodeprovidedinfo.py +11 -1
  81. cribl_control_plane/models/outpostnodeinfo.py +16 -0
  82. cribl_control_plane/models/output.py +77 -72
  83. cribl_control_plane/models/outputazureblob.py +20 -0
  84. cribl_control_plane/models/outputazuredataexplorer.py +28 -0
  85. cribl_control_plane/models/outputazureeventhub.py +17 -0
  86. cribl_control_plane/models/outputazurelogs.py +13 -0
  87. cribl_control_plane/models/outputchronicle.py +13 -0
  88. cribl_control_plane/models/outputclickhouse.py +17 -0
  89. cribl_control_plane/models/outputcloudwatch.py +13 -0
  90. cribl_control_plane/models/outputconfluentcloud.py +24 -18
  91. cribl_control_plane/models/outputcriblhttp.py +15 -0
  92. cribl_control_plane/models/outputcribllake.py +21 -0
  93. cribl_control_plane/models/outputcribltcp.py +12 -0
  94. cribl_control_plane/models/outputcrowdstrikenextgensiem.py +15 -0
  95. cribl_control_plane/models/outputdatabricks.py +411 -0
  96. cribl_control_plane/models/outputdatadog.py +30 -0
  97. cribl_control_plane/models/outputdataset.py +23 -0
  98. cribl_control_plane/models/outputdls3.py +35 -0
  99. cribl_control_plane/models/outputdynatracehttp.py +22 -0
  100. cribl_control_plane/models/outputdynatraceotlp.py +22 -0
  101. cribl_control_plane/models/outputelastic.py +18 -0
  102. cribl_control_plane/models/outputelasticcloud.py +13 -0
  103. cribl_control_plane/models/outputexabeam.py +14 -0
  104. cribl_control_plane/models/outputfilesystem.py +15 -0
  105. cribl_control_plane/models/outputgooglechronicle.py +21 -0
  106. cribl_control_plane/models/outputgooglecloudlogging.py +19 -0
  107. cribl_control_plane/models/outputgooglecloudstorage.py +28 -0
  108. cribl_control_plane/models/outputgooglepubsub.py +13 -0
  109. cribl_control_plane/models/outputgrafanacloud.py +50 -0
  110. cribl_control_plane/models/outputgraphite.py +12 -0
  111. cribl_control_plane/models/outputhoneycomb.py +13 -0
  112. cribl_control_plane/models/outputhumiohec.py +15 -0
  113. cribl_control_plane/models/outputinfluxdb.py +19 -0
  114. cribl_control_plane/models/outputkafka.py +24 -17
  115. cribl_control_plane/models/outputkinesis.py +15 -0
  116. cribl_control_plane/models/outputloki.py +20 -0
  117. cribl_control_plane/models/outputminio.py +28 -0
  118. cribl_control_plane/models/outputmsk.py +23 -17
  119. cribl_control_plane/models/outputnewrelic.py +16 -0
  120. cribl_control_plane/models/outputnewrelicevents.py +16 -0
  121. cribl_control_plane/models/outputopentelemetry.py +22 -0
  122. cribl_control_plane/models/outputprometheus.py +13 -0
  123. cribl_control_plane/models/outputring.py +2 -0
  124. cribl_control_plane/models/outputs3.py +35 -0
  125. cribl_control_plane/models/outputsecuritylake.py +29 -0
  126. cribl_control_plane/models/outputsentinel.py +15 -0
  127. cribl_control_plane/models/outputsentineloneaisiem.py +13 -0
  128. cribl_control_plane/models/outputservicenow.py +21 -0
  129. cribl_control_plane/models/outputsignalfx.py +13 -0
  130. cribl_control_plane/models/outputsns.py +13 -0
  131. cribl_control_plane/models/outputsplunk.py +15 -0
  132. cribl_control_plane/models/outputsplunkhec.py +13 -0
  133. cribl_control_plane/models/outputsplunklb.py +15 -0
  134. cribl_control_plane/models/outputsqs.py +15 -0
  135. cribl_control_plane/models/outputstatsd.py +12 -0
  136. cribl_control_plane/models/outputstatsdext.py +12 -0
  137. cribl_control_plane/models/outputsumologic.py +15 -0
  138. cribl_control_plane/models/outputsyslog.py +24 -0
  139. cribl_control_plane/models/outputtcpjson.py +12 -0
  140. cribl_control_plane/models/outputwavefront.py +13 -0
  141. cribl_control_plane/models/outputwebhook.py +23 -0
  142. cribl_control_plane/models/outputxsiam.py +13 -0
  143. cribl_control_plane/models/packinfo.py +8 -5
  144. cribl_control_plane/models/packinstallinfo.py +8 -5
  145. cribl_control_plane/models/routeconf.py +3 -4
  146. cribl_control_plane/models/runnablejobcollection.py +4 -0
  147. cribl_control_plane/models/updatepacksop.py +25 -0
  148. cribl_control_plane/models/{routecloneconf.py → uploadpackresponse.py} +4 -4
  149. cribl_control_plane/packs.py +202 -7
  150. cribl_control_plane/routes_sdk.py +6 -6
  151. cribl_control_plane/tokens.py +23 -15
  152. {cribl_control_plane-0.2.1.dist-info → cribl_control_plane-0.2.1rc2.dist-info}/METADATA +37 -5
  153. {cribl_control_plane-0.2.1.dist-info → cribl_control_plane-0.2.1rc2.dist-info}/RECORD +154 -153
  154. cribl_control_plane/models/appmode.py +0 -14
  155. cribl_control_plane/models/error.py +0 -16
  156. cribl_control_plane/models/gethealthinfoop.py +0 -17
  157. {cribl_control_plane-0.2.1.dist-info → cribl_control_plane-0.2.1rc2.dist-info}/WHEEL +0 -0
@@ -18,7 +18,9 @@ class OutputSplunkType(str, Enum):
18
18
  class OutputSplunkNestedFieldSerialization(str, Enum, metaclass=utils.OpenEnumMeta):
19
19
  r"""How to serialize nested fields into index-time fields"""
20
20
 
21
+ # JSON
21
22
  JSON = "json"
23
+ # None
22
24
  NONE = "none"
23
25
 
24
26
 
@@ -115,8 +117,11 @@ class OutputSplunkMaxS2SVersion(str, Enum, metaclass=utils.OpenEnumMeta):
115
117
  class OutputSplunkBackpressureBehavior(str, Enum, metaclass=utils.OpenEnumMeta):
116
118
  r"""How to handle events when all receivers are exerting backpressure"""
117
119
 
120
+ # Block
118
121
  BLOCK = "block"
122
+ # Drop
119
123
  DROP = "drop"
124
+ # Persistent Queue
120
125
  QUEUE = "queue"
121
126
 
122
127
 
@@ -130,30 +135,40 @@ class OutputSplunkAuthenticationMethod(str, Enum, metaclass=utils.OpenEnumMeta):
130
135
  class OutputSplunkCompressCompression(str, Enum, metaclass=utils.OpenEnumMeta):
131
136
  r"""Controls whether the sender should send compressed data to the server. Select 'Disabled' to reject compressed connections or 'Always' to ignore server's configuration and send compressed data."""
132
137
 
138
+ # Disabled
133
139
  DISABLED = "disabled"
140
+ # Automatic
134
141
  AUTO = "auto"
142
+ # Always
135
143
  ALWAYS = "always"
136
144
 
137
145
 
138
146
  class OutputSplunkPqCompressCompression(str, Enum, metaclass=utils.OpenEnumMeta):
139
147
  r"""Codec to use to compress the persisted data"""
140
148
 
149
+ # None
141
150
  NONE = "none"
151
+ # Gzip
142
152
  GZIP = "gzip"
143
153
 
144
154
 
145
155
  class OutputSplunkQueueFullBehavior(str, Enum, metaclass=utils.OpenEnumMeta):
146
156
  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."""
147
157
 
158
+ # Block
148
159
  BLOCK = "block"
160
+ # Drop new data
149
161
  DROP = "drop"
150
162
 
151
163
 
152
164
  class OutputSplunkMode(str, Enum, metaclass=utils.OpenEnumMeta):
153
165
  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."""
154
166
 
167
+ # Error
155
168
  ERROR = "error"
169
+ # Backpressure
156
170
  BACKPRESSURE = "backpressure"
171
+ # Always On
157
172
  ALWAYS = "always"
158
173
 
159
174
 
@@ -29,8 +29,11 @@ class OutputSplunkHecExtraHTTPHeader(BaseModel):
29
29
  class OutputSplunkHecFailedRequestLoggingMode(str, Enum, metaclass=utils.OpenEnumMeta):
30
30
  r"""Data to log when a request fails. All headers are redacted by default, unless listed as safe headers below."""
31
31
 
32
+ # Payload
32
33
  PAYLOAD = "payload"
34
+ # Payload + Headers
33
35
  PAYLOAD_AND_HEADERS = "payloadAndHeaders"
36
+ # None
34
37
  NONE = "none"
35
38
 
36
39
 
@@ -98,8 +101,11 @@ class OutputSplunkHecTimeoutRetrySettings(BaseModel):
98
101
  class OutputSplunkHecBackpressureBehavior(str, Enum, metaclass=utils.OpenEnumMeta):
99
102
  r"""How to handle events when all receivers are exerting backpressure"""
100
103
 
104
+ # Block
101
105
  BLOCK = "block"
106
+ # Drop
102
107
  DROP = "drop"
108
+ # Persistent Queue
103
109
  QUEUE = "queue"
104
110
 
105
111
 
@@ -121,22 +127,29 @@ class OutputSplunkHecURL(BaseModel):
121
127
  class OutputSplunkHecCompression(str, Enum, metaclass=utils.OpenEnumMeta):
122
128
  r"""Codec to use to compress the persisted data"""
123
129
 
130
+ # None
124
131
  NONE = "none"
132
+ # Gzip
125
133
  GZIP = "gzip"
126
134
 
127
135
 
128
136
  class OutputSplunkHecQueueFullBehavior(str, Enum, metaclass=utils.OpenEnumMeta):
129
137
  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."""
130
138
 
139
+ # Block
131
140
  BLOCK = "block"
141
+ # Drop new data
132
142
  DROP = "drop"
133
143
 
134
144
 
135
145
  class OutputSplunkHecMode(str, Enum, metaclass=utils.OpenEnumMeta):
136
146
  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."""
137
147
 
148
+ # Error
138
149
  ERROR = "error"
150
+ # Backpressure
139
151
  BACKPRESSURE = "backpressure"
152
+ # Always On
140
153
  ALWAYS = "always"
141
154
 
142
155
 
@@ -18,7 +18,9 @@ class OutputSplunkLbType(str, Enum):
18
18
  class OutputSplunkLbNestedFieldSerialization(str, Enum, metaclass=utils.OpenEnumMeta):
19
19
  r"""How to serialize nested fields into index-time fields"""
20
20
 
21
+ # JSON
21
22
  JSON = "json"
23
+ # None
22
24
  NONE = "none"
23
25
 
24
26
 
@@ -115,8 +117,11 @@ class OutputSplunkLbMaxS2SVersion(str, Enum, metaclass=utils.OpenEnumMeta):
115
117
  class OutputSplunkLbBackpressureBehavior(str, Enum, metaclass=utils.OpenEnumMeta):
116
118
  r"""How to handle events when all receivers are exerting backpressure"""
117
119
 
120
+ # Block
118
121
  BLOCK = "block"
122
+ # Drop
119
123
  DROP = "drop"
124
+ # Persistent Queue
120
125
  QUEUE = "queue"
121
126
 
122
127
 
@@ -130,8 +135,11 @@ class OutputSplunkLbAuthenticationMethod(str, Enum, metaclass=utils.OpenEnumMeta
130
135
  class OutputSplunkLbCompressCompression(str, Enum, metaclass=utils.OpenEnumMeta):
131
136
  r"""Controls whether the sender should send compressed data to the server. Select 'Disabled' to reject compressed connections or 'Always' to ignore server's configuration and send compressed data."""
132
137
 
138
+ # Disabled
133
139
  DISABLED = "disabled"
140
+ # Automatic
134
141
  AUTO = "auto"
142
+ # Always
135
143
  ALWAYS = "always"
136
144
 
137
145
 
@@ -272,22 +280,29 @@ class OutputSplunkLbHost(BaseModel):
272
280
  class OutputSplunkLbPqCompressCompression(str, Enum, metaclass=utils.OpenEnumMeta):
273
281
  r"""Codec to use to compress the persisted data"""
274
282
 
283
+ # None
275
284
  NONE = "none"
285
+ # Gzip
276
286
  GZIP = "gzip"
277
287
 
278
288
 
279
289
  class OutputSplunkLbQueueFullBehavior(str, Enum, metaclass=utils.OpenEnumMeta):
280
290
  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."""
281
291
 
292
+ # Block
282
293
  BLOCK = "block"
294
+ # Drop new data
283
295
  DROP = "drop"
284
296
 
285
297
 
286
298
  class OutputSplunkLbMode(str, Enum, metaclass=utils.OpenEnumMeta):
287
299
  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."""
288
300
 
301
+ # Error
289
302
  ERROR = "error"
303
+ # Backpressure
290
304
  BACKPRESSURE = "backpressure"
305
+ # Always On
291
306
  ALWAYS = "always"
292
307
 
293
308
 
@@ -18,15 +18,20 @@ class OutputSqsType(str, Enum):
18
18
  class OutputSqsQueueType(str, Enum, metaclass=utils.OpenEnumMeta):
19
19
  r"""The queue type used (or created). Defaults to Standard."""
20
20
 
21
+ # Standard
21
22
  STANDARD = "standard"
23
+ # FIFO
22
24
  FIFO = "fifo"
23
25
 
24
26
 
25
27
  class OutputSqsAuthenticationMethod(str, Enum, metaclass=utils.OpenEnumMeta):
26
28
  r"""AWS authentication method. Choose Auto to use IAM roles."""
27
29
 
30
+ # Auto
28
31
  AUTO = "auto"
32
+ # Manual
29
33
  MANUAL = "manual"
34
+ # Secret Key pair
30
35
  SECRET = "secret"
31
36
 
32
37
 
@@ -40,30 +45,40 @@ class OutputSqsSignatureVersion(str, Enum, metaclass=utils.OpenEnumMeta):
40
45
  class OutputSqsBackpressureBehavior(str, Enum, metaclass=utils.OpenEnumMeta):
41
46
  r"""How to handle events when all receivers are exerting backpressure"""
42
47
 
48
+ # Block
43
49
  BLOCK = "block"
50
+ # Drop
44
51
  DROP = "drop"
52
+ # Persistent Queue
45
53
  QUEUE = "queue"
46
54
 
47
55
 
48
56
  class OutputSqsCompression(str, Enum, metaclass=utils.OpenEnumMeta):
49
57
  r"""Codec to use to compress the persisted data"""
50
58
 
59
+ # None
51
60
  NONE = "none"
61
+ # Gzip
52
62
  GZIP = "gzip"
53
63
 
54
64
 
55
65
  class OutputSqsQueueFullBehavior(str, Enum, metaclass=utils.OpenEnumMeta):
56
66
  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."""
57
67
 
68
+ # Block
58
69
  BLOCK = "block"
70
+ # Drop new data
59
71
  DROP = "drop"
60
72
 
61
73
 
62
74
  class OutputSqsMode(str, Enum, metaclass=utils.OpenEnumMeta):
63
75
  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."""
64
76
 
77
+ # Error
65
78
  ERROR = "error"
79
+ # Backpressure
66
80
  BACKPRESSURE = "backpressure"
81
+ # Always On
67
82
  ALWAYS = "always"
68
83
 
69
84
 
@@ -18,37 +18,49 @@ class OutputStatsdType(str, Enum):
18
18
  class OutputStatsdDestinationProtocol(str, Enum, metaclass=utils.OpenEnumMeta):
19
19
  r"""Protocol to use when communicating with the destination."""
20
20
 
21
+ # UDP
21
22
  UDP = "udp"
23
+ # TCP
22
24
  TCP = "tcp"
23
25
 
24
26
 
25
27
  class OutputStatsdBackpressureBehavior(str, Enum, metaclass=utils.OpenEnumMeta):
26
28
  r"""How to handle events when all receivers are exerting backpressure"""
27
29
 
30
+ # Block
28
31
  BLOCK = "block"
32
+ # Drop
29
33
  DROP = "drop"
34
+ # Persistent Queue
30
35
  QUEUE = "queue"
31
36
 
32
37
 
33
38
  class OutputStatsdCompression(str, Enum, metaclass=utils.OpenEnumMeta):
34
39
  r"""Codec to use to compress the persisted data"""
35
40
 
41
+ # None
36
42
  NONE = "none"
43
+ # Gzip
37
44
  GZIP = "gzip"
38
45
 
39
46
 
40
47
  class OutputStatsdQueueFullBehavior(str, Enum, metaclass=utils.OpenEnumMeta):
41
48
  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."""
42
49
 
50
+ # Block
43
51
  BLOCK = "block"
52
+ # Drop new data
44
53
  DROP = "drop"
45
54
 
46
55
 
47
56
  class OutputStatsdMode(str, Enum, metaclass=utils.OpenEnumMeta):
48
57
  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."""
49
58
 
59
+ # Error
50
60
  ERROR = "error"
61
+ # Backpressure
51
62
  BACKPRESSURE = "backpressure"
63
+ # Always On
52
64
  ALWAYS = "always"
53
65
 
54
66
 
@@ -18,37 +18,49 @@ class OutputStatsdExtType(str, Enum):
18
18
  class OutputStatsdExtDestinationProtocol(str, Enum, metaclass=utils.OpenEnumMeta):
19
19
  r"""Protocol to use when communicating with the destination."""
20
20
 
21
+ # UDP
21
22
  UDP = "udp"
23
+ # TCP
22
24
  TCP = "tcp"
23
25
 
24
26
 
25
27
  class OutputStatsdExtBackpressureBehavior(str, Enum, metaclass=utils.OpenEnumMeta):
26
28
  r"""How to handle events when all receivers are exerting backpressure"""
27
29
 
30
+ # Block
28
31
  BLOCK = "block"
32
+ # Drop
29
33
  DROP = "drop"
34
+ # Persistent Queue
30
35
  QUEUE = "queue"
31
36
 
32
37
 
33
38
  class OutputStatsdExtCompression(str, Enum, metaclass=utils.OpenEnumMeta):
34
39
  r"""Codec to use to compress the persisted data"""
35
40
 
41
+ # None
36
42
  NONE = "none"
43
+ # Gzip
37
44
  GZIP = "gzip"
38
45
 
39
46
 
40
47
  class OutputStatsdExtQueueFullBehavior(str, Enum, metaclass=utils.OpenEnumMeta):
41
48
  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."""
42
49
 
50
+ # Block
43
51
  BLOCK = "block"
52
+ # Drop new data
44
53
  DROP = "drop"
45
54
 
46
55
 
47
56
  class OutputStatsdExtMode(str, Enum, metaclass=utils.OpenEnumMeta):
48
57
  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."""
49
58
 
59
+ # Error
50
60
  ERROR = "error"
61
+ # Backpressure
51
62
  BACKPRESSURE = "backpressure"
63
+ # Always On
52
64
  ALWAYS = "always"
53
65
 
54
66
 
@@ -18,7 +18,9 @@ class OutputSumoLogicType(str, Enum):
18
18
  class OutputSumoLogicDataFormat(str, Enum, metaclass=utils.OpenEnumMeta):
19
19
  r"""Preserve the raw event format instead of JSONifying it"""
20
20
 
21
+ # JSON
21
22
  JSON = "json"
23
+ # Raw
22
24
  RAW = "raw"
23
25
 
24
26
 
@@ -36,8 +38,11 @@ class OutputSumoLogicExtraHTTPHeader(BaseModel):
36
38
  class OutputSumoLogicFailedRequestLoggingMode(str, Enum, metaclass=utils.OpenEnumMeta):
37
39
  r"""Data to log when a request fails. All headers are redacted by default, unless listed as safe headers below."""
38
40
 
41
+ # Payload
39
42
  PAYLOAD = "payload"
43
+ # Payload + Headers
40
44
  PAYLOAD_AND_HEADERS = "payloadAndHeaders"
45
+ # None
41
46
  NONE = "none"
42
47
 
43
48
 
@@ -98,30 +103,40 @@ class OutputSumoLogicTimeoutRetrySettings(BaseModel):
98
103
  class OutputSumoLogicBackpressureBehavior(str, Enum, metaclass=utils.OpenEnumMeta):
99
104
  r"""How to handle events when all receivers are exerting backpressure"""
100
105
 
106
+ # Block
101
107
  BLOCK = "block"
108
+ # Drop
102
109
  DROP = "drop"
110
+ # Persistent Queue
103
111
  QUEUE = "queue"
104
112
 
105
113
 
106
114
  class OutputSumoLogicCompression(str, Enum, metaclass=utils.OpenEnumMeta):
107
115
  r"""Codec to use to compress the persisted data"""
108
116
 
117
+ # None
109
118
  NONE = "none"
119
+ # Gzip
110
120
  GZIP = "gzip"
111
121
 
112
122
 
113
123
  class OutputSumoLogicQueueFullBehavior(str, Enum, metaclass=utils.OpenEnumMeta):
114
124
  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."""
115
125
 
126
+ # Block
116
127
  BLOCK = "block"
128
+ # Drop new data
117
129
  DROP = "drop"
118
130
 
119
131
 
120
132
  class OutputSumoLogicMode(str, Enum, metaclass=utils.OpenEnumMeta):
121
133
  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
134
 
135
+ # Error
123
136
  ERROR = "error"
137
+ # Backpressure
124
138
  BACKPRESSURE = "backpressure"
139
+ # Always On
125
140
  ALWAYS = "always"
126
141
 
127
142
 
@@ -18,7 +18,9 @@ class OutputSyslogType(str, Enum):
18
18
  class OutputSyslogProtocol(str, Enum, metaclass=utils.OpenEnumMeta):
19
19
  r"""The network protocol to use for sending out syslog messages"""
20
20
 
21
+ # TCP
21
22
  TCP = "tcp"
23
+ # UDP
22
24
  UDP = "udp"
23
25
 
24
26
 
@@ -52,27 +54,39 @@ class Facility(int, Enum, metaclass=utils.OpenEnumMeta):
52
54
  class OutputSyslogSeverity(int, Enum, metaclass=utils.OpenEnumMeta):
53
55
  r"""Default value for message severity. Will be overwritten by value of __severity if set. Defaults to notice."""
54
56
 
57
+ # emergency
55
58
  ZERO = 0
59
+ # alert
56
60
  ONE = 1
61
+ # critical
57
62
  TWO = 2
63
+ # error
58
64
  THREE = 3
65
+ # warning
59
66
  FOUR = 4
67
+ # notice
60
68
  FIVE = 5
69
+ # info
61
70
  SIX = 6
71
+ # debug
62
72
  SEVEN = 7
63
73
 
64
74
 
65
75
  class OutputSyslogMessageFormat(str, Enum, metaclass=utils.OpenEnumMeta):
66
76
  r"""The syslog message format depending on the receiver's support"""
67
77
 
78
+ # RFC3164
68
79
  RFC3164 = "rfc3164"
80
+ # RFC5424
69
81
  RFC5424 = "rfc5424"
70
82
 
71
83
 
72
84
  class TimestampFormat(str, Enum, metaclass=utils.OpenEnumMeta):
73
85
  r"""Timestamp format to use when serializing event's time field"""
74
86
 
87
+ # Syslog
75
88
  SYSLOG = "syslog"
89
+ # ISO8601
76
90
  ISO8601 = "iso8601"
77
91
 
78
92
 
@@ -162,30 +176,40 @@ class OutputSyslogTLSSettingsClientSide(BaseModel):
162
176
  class OutputSyslogBackpressureBehavior(str, Enum, metaclass=utils.OpenEnumMeta):
163
177
  r"""How to handle events when all receivers are exerting backpressure"""
164
178
 
179
+ # Block
165
180
  BLOCK = "block"
181
+ # Drop
166
182
  DROP = "drop"
183
+ # Persistent Queue
167
184
  QUEUE = "queue"
168
185
 
169
186
 
170
187
  class OutputSyslogCompression(str, Enum, metaclass=utils.OpenEnumMeta):
171
188
  r"""Codec to use to compress the persisted data"""
172
189
 
190
+ # None
173
191
  NONE = "none"
192
+ # Gzip
174
193
  GZIP = "gzip"
175
194
 
176
195
 
177
196
  class OutputSyslogQueueFullBehavior(str, Enum, metaclass=utils.OpenEnumMeta):
178
197
  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."""
179
198
 
199
+ # Block
180
200
  BLOCK = "block"
201
+ # Drop new data
181
202
  DROP = "drop"
182
203
 
183
204
 
184
205
  class OutputSyslogMode(str, Enum, metaclass=utils.OpenEnumMeta):
185
206
  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."""
186
207
 
208
+ # Error
187
209
  ERROR = "error"
210
+ # Backpressure
188
211
  BACKPRESSURE = "backpressure"
212
+ # Always On
189
213
  ALWAYS = "always"
190
214
 
191
215
 
@@ -18,7 +18,9 @@ class OutputTcpjsonType(str, Enum):
18
18
  class OutputTcpjsonCompression(str, Enum, metaclass=utils.OpenEnumMeta):
19
19
  r"""Codec to use to compress the data before sending"""
20
20
 
21
+ # None
21
22
  NONE = "none"
23
+ # Gzip
22
24
  GZIP = "gzip"
23
25
 
24
26
 
@@ -108,8 +110,11 @@ class OutputTcpjsonTLSSettingsClientSide(BaseModel):
108
110
  class OutputTcpjsonBackpressureBehavior(str, Enum, metaclass=utils.OpenEnumMeta):
109
111
  r"""How to handle events when all receivers are exerting backpressure"""
110
112
 
113
+ # Block
111
114
  BLOCK = "block"
115
+ # Drop
112
116
  DROP = "drop"
117
+ # Persistent Queue
113
118
  QUEUE = "queue"
114
119
 
115
120
 
@@ -162,22 +167,29 @@ class OutputTcpjsonHost(BaseModel):
162
167
  class OutputTcpjsonPqCompressCompression(str, Enum, metaclass=utils.OpenEnumMeta):
163
168
  r"""Codec to use to compress the persisted data"""
164
169
 
170
+ # None
165
171
  NONE = "none"
172
+ # Gzip
166
173
  GZIP = "gzip"
167
174
 
168
175
 
169
176
  class OutputTcpjsonQueueFullBehavior(str, Enum, metaclass=utils.OpenEnumMeta):
170
177
  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."""
171
178
 
179
+ # Block
172
180
  BLOCK = "block"
181
+ # Drop new data
173
182
  DROP = "drop"
174
183
 
175
184
 
176
185
  class OutputTcpjsonMode(str, Enum, metaclass=utils.OpenEnumMeta):
177
186
  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."""
178
187
 
188
+ # Error
179
189
  ERROR = "error"
190
+ # Backpressure
180
191
  BACKPRESSURE = "backpressure"
192
+ # Always On
181
193
  ALWAYS = "always"
182
194
 
183
195
 
@@ -36,8 +36,11 @@ class OutputWavefrontExtraHTTPHeader(BaseModel):
36
36
  class OutputWavefrontFailedRequestLoggingMode(str, Enum, metaclass=utils.OpenEnumMeta):
37
37
  r"""Data to log when a request fails. All headers are redacted by default, unless listed as safe headers below."""
38
38
 
39
+ # Payload
39
40
  PAYLOAD = "payload"
41
+ # Payload + Headers
40
42
  PAYLOAD_AND_HEADERS = "payloadAndHeaders"
43
+ # None
41
44
  NONE = "none"
42
45
 
43
46
 
@@ -98,30 +101,40 @@ class OutputWavefrontTimeoutRetrySettings(BaseModel):
98
101
  class OutputWavefrontBackpressureBehavior(str, Enum, metaclass=utils.OpenEnumMeta):
99
102
  r"""How to handle events when all receivers are exerting backpressure"""
100
103
 
104
+ # Block
101
105
  BLOCK = "block"
106
+ # Drop
102
107
  DROP = "drop"
108
+ # Persistent Queue
103
109
  QUEUE = "queue"
104
110
 
105
111
 
106
112
  class OutputWavefrontCompression(str, Enum, metaclass=utils.OpenEnumMeta):
107
113
  r"""Codec to use to compress the persisted data"""
108
114
 
115
+ # None
109
116
  NONE = "none"
117
+ # Gzip
110
118
  GZIP = "gzip"
111
119
 
112
120
 
113
121
  class OutputWavefrontQueueFullBehavior(str, Enum, metaclass=utils.OpenEnumMeta):
114
122
  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."""
115
123
 
124
+ # Block
116
125
  BLOCK = "block"
126
+ # Drop new data
117
127
  DROP = "drop"
118
128
 
119
129
 
120
130
  class OutputWavefrontMode(str, Enum, metaclass=utils.OpenEnumMeta):
121
131
  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
132
 
133
+ # Error
123
134
  ERROR = "error"
135
+ # Backpressure
124
136
  BACKPRESSURE = "backpressure"
137
+ # Always On
125
138
  ALWAYS = "always"
126
139
 
127
140
 
@@ -26,9 +26,13 @@ class OutputWebhookMethod(str, Enum, metaclass=utils.OpenEnumMeta):
26
26
  class OutputWebhookFormat(str, Enum, metaclass=utils.OpenEnumMeta):
27
27
  r"""How to format events before sending out"""
28
28
 
29
+ # NDJSON (Newline Delimited JSON)
29
30
  NDJSON = "ndjson"
31
+ # JSON Array
30
32
  JSON_ARRAY = "json_array"
33
+ # Custom
31
34
  CUSTOM = "custom"
35
+ # Advanced
32
36
  ADVANCED = "advanced"
33
37
 
34
38
 
@@ -46,8 +50,11 @@ class OutputWebhookExtraHTTPHeader(BaseModel):
46
50
  class OutputWebhookFailedRequestLoggingMode(str, Enum, metaclass=utils.OpenEnumMeta):
47
51
  r"""Data to log when a request fails. All headers are redacted by default, unless listed as safe headers below."""
48
52
 
53
+ # Payload
49
54
  PAYLOAD = "payload"
55
+ # Payload + Headers
50
56
  PAYLOAD_AND_HEADERS = "payloadAndHeaders"
57
+ # None
51
58
  NONE = "none"
52
59
 
53
60
 
@@ -108,19 +115,28 @@ class OutputWebhookTimeoutRetrySettings(BaseModel):
108
115
  class OutputWebhookBackpressureBehavior(str, Enum, metaclass=utils.OpenEnumMeta):
109
116
  r"""How to handle events when all receivers are exerting backpressure"""
110
117
 
118
+ # Block
111
119
  BLOCK = "block"
120
+ # Drop
112
121
  DROP = "drop"
122
+ # Persistent Queue
113
123
  QUEUE = "queue"
114
124
 
115
125
 
116
126
  class OutputWebhookAuthenticationType(str, Enum, metaclass=utils.OpenEnumMeta):
117
127
  r"""Authentication method to use for the HTTP request"""
118
128
 
129
+ # None
119
130
  NONE = "none"
131
+ # Basic
120
132
  BASIC = "basic"
133
+ # Basic (credentials secret)
121
134
  CREDENTIALS_SECRET = "credentialsSecret"
135
+ # Token
122
136
  TOKEN = "token"
137
+ # Token (text secret)
123
138
  TEXT_SECRET = "textSecret"
139
+ # OAuth
124
140
  OAUTH = "oauth"
125
141
 
126
142
 
@@ -199,22 +215,29 @@ class OutputWebhookTLSSettingsClientSide(BaseModel):
199
215
  class OutputWebhookCompression(str, Enum, metaclass=utils.OpenEnumMeta):
200
216
  r"""Codec to use to compress the persisted data"""
201
217
 
218
+ # None
202
219
  NONE = "none"
220
+ # Gzip
203
221
  GZIP = "gzip"
204
222
 
205
223
 
206
224
  class OutputWebhookQueueFullBehavior(str, Enum, metaclass=utils.OpenEnumMeta):
207
225
  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."""
208
226
 
227
+ # Block
209
228
  BLOCK = "block"
229
+ # Drop new data
210
230
  DROP = "drop"
211
231
 
212
232
 
213
233
  class OutputWebhookMode(str, Enum, metaclass=utils.OpenEnumMeta):
214
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."""
215
235
 
236
+ # Error
216
237
  ERROR = "error"
238
+ # Backpressure
217
239
  BACKPRESSURE = "backpressure"
240
+ # Always On
218
241
  ALWAYS = "always"
219
242
 
220
243