@@ -1238,6 +1238,182 @@ public bool? ActionSummaryIndexTrackAlert
1238
1238
public string ActionSummaryIndexTtl
1239
1239
{ get ; set ; }
1240
1240
1241
+ /// <summary>
1242
+ /// Gets or sets the search command which is responsible for executing the
1243
+ /// webhook action for a <see cref="SavedSearch"/>.
1244
+ /// </summary>
1245
+ /// <remarks>
1246
+ /// Generally the command is a template search pipeline which is realized
1247
+ /// with values from the <see cref="SavedSearch"/>. Reference template
1248
+ /// arguments by enclosing their names in dollar signs ($). For example, to
1249
+ /// reference <see cref="SavedSearch"/>.Name use
1250
+ /// <c>$name$</c>. To reference <see cref="SavedSearch"/>.Search use
1251
+ /// <c>$search$</c>.
1252
+ /// </remarks>
1253
+ /// <value>
1254
+ /// The search command which is responsible for executing the webhook action
1255
+ /// for a <see cref="SavedSearch"/>.
1256
+ /// </value>
1257
+ [ DataMember ( Name = "action.webook.command" , EmitDefaultValue = false ) ]
1258
+ public string ActionWebHookCommand
1259
+ { get ; set ; }
1260
+
1261
+ /// <summary>
1262
+ /// Gets or sets the human-readable description of a webhook action
1263
+ /// <see cref= "SavedSearch"/>.
1264
+ /// </summary>
1265
+ /// <remarks>
1266
+ /// The default value is an empty string.
1267
+ /// </remarks>
1268
+ /// <value>
1269
+ /// The human-readable description of a webhook action <see cref="SavedSearch"/>.
1270
+ /// </value>
1271
+ [ DataMember ( Name = "action.webhook.description" , EmitDefaultValue = false ) ]
1272
+ public string ActionWebHookDescription
1273
+ { get ; set ; }
1274
+
1275
+ /// <summary>
1276
+ /// Gets or sets the hostname used in the web link (URI) that is sent in the
1277
+ /// webhook action of a <see cref="SavedSearch"/>.
1278
+ /// </summary>
1279
+ /// <remarks>
1280
+ /// Valid forms are <c>"hostname"</c> and <c>"protocol://hostname:port"</c>.
1281
+ /// </remarks>
1282
+ /// <value>
1283
+ /// The hostname used in the web link (URI) that is sent in the webhook
1284
+ /// action of a <see cref="SavedSearch"/>.
1285
+ /// </value>
1286
+ [ DataMember ( Name = "action.webhook.hostname" , EmitDefaultValue = false ) ]
1287
+ public string ActionWebHookHostName
1288
+ { get ; set ; }
1289
+
1290
+ /// <summary>
1291
+ /// Gets or sets the icon path used in the UI for the webhook
1292
+ /// action of a <see cref="SavedSearch"/>.
1293
+ /// </summary>>
1294
+ /// <value>
1295
+ /// The name of the webhook action icon path to display in the UI
1296
+ /// of a <see cref="SavedSearch"/>.
1297
+ /// </value>
1298
+ [ DataMember ( Name = "action.webhook.icon_path" , EmitDefaultValue = false ) ]
1299
+ public string ActionWebHookIconPath
1300
+ { get ; set ; }
1301
+
1302
+ /// <summary>
1303
+ /// Gets or sets a value indicating whether whether the alert action is based
1304
+ /// on the custom alert actions framework and is supposed to be listed in
1305
+ /// the search UI
1306
+ /// </summary>
1307
+ /// <remarks>
1308
+ /// The default value is <c>false</c>.
1309
+ /// </remarks>
1310
+ /// <value>
1311
+ /// <c>true</c>, if the webhook action is custom of a <see cref="SavedSearch"/>.
1312
+ /// </value>
1313
+ [ DataMember ( Name = "action.webhook.is_custom" , EmitDefaultValue = false ) ]
1314
+ public bool ? ActionWebHookIsCustom
1315
+ { get ; set ; }
1316
+
1317
+ /// <summary>
1318
+ /// Gets or sets the label of the webhook action <see cref="SavedSearch"/>.
1319
+ /// </summary>>
1320
+ /// <value>
1321
+ /// The name label of the webhook <see cref="SavedSearch"/>.
1322
+ /// </value>
1323
+ [ DataMember ( Name = "action.webhook.label" , EmitDefaultValue = false ) ]
1324
+ public string ActionWebHookLabel
1325
+ { get ; set ; }
1326
+
1327
+ /// <summary>
1328
+ /// Gets or sets the global maximum number of search results to send when the
1329
+ /// webhook for a <see cref="SavedSearch"/> is enabled.
1330
+ /// </summary>
1331
+ /// <remarks>
1332
+ /// The default value is <c>100</c>.
1333
+ /// </remarks>
1334
+ /// <value>
1335
+ /// The global maximum number of search results to send when the webhook for a
1336
+ /// <see cref="SavedSearch"/> is enabled.
1337
+ /// </value>
1338
+ [ DataMember ( Name = "action.webhook.maxresults" , EmitDefaultValue = false ) ]
1339
+ public int ? ActionWebHookMaxResults
1340
+ { get ; set ; }
1341
+
1342
+ /// <summary>
1343
+ /// Gets or sets the maximum period of time the webhook action for a
1344
+ /// <see cref="SavedSearch"/> may execute before it is aborted.
1345
+ /// </summary>
1346
+ /// <remarks>
1347
+ /// Express this value as a string of the form <c><![CDATA[ <integer>
1348
+ /// ("s"|"m"|"h"|"d")]]></c>. The default is <c>"5m"</c>.
1349
+ /// </remarks>
1350
+ /// <value>
1351
+ /// The maximum period of time the webhook action for a
1352
+ /// <see cref= "SavedSearch"/> may execute before it is aborted.
1353
+ /// </value>
1354
+ [ DataMember ( Name = "action.webhook.maxtime" , EmitDefaultValue = false ) ]
1355
+ public string ActionWebHookMaxTime
1356
+ { get ; set ; }
1357
+
1358
+ /// <summary>
1359
+ /// Gets or sets the value of the User-Agent header sent to the webhook
1360
+ /// receiver in a <see cref= "SavedSearch"/>
1361
+ /// </summary>
1362
+ /// <value>
1363
+ /// The value of the User-Agent header sent to the webhook
1364
+ /// receiver in a <see cref= "SavedSearch"/>
1365
+ /// </value>
1366
+ [ DataMember ( Name = "action.webhook.param.user_agent" , EmitDefaultValue = false ) ]
1367
+ public string ActionWebHookParamUserAgent
1368
+ { get ; set ; }
1369
+
1370
+ /// <summary>
1371
+ /// Gets or sets the payload format that is used in the webhook action of
1372
+ /// a <see cref="SavedSearch"/>.
1373
+ /// </summary>
1374
+ /// <remarks>
1375
+ /// Valid values are <c>"json"</c> and <c>"xml"</c>, defaults to <c>"xml"</c>.
1376
+ /// </remarks>
1377
+ /// <value>
1378
+ /// The payload format set in the webhook action of a <see cref="SavedSearch"/>.
1379
+ /// </value>
1380
+ [ DataMember ( Name = "action.webhook.payload_format" , EmitDefaultValue = false ) ]
1381
+ public string ActionWebHookPayloadFormat
1382
+ { get ; set ; }
1383
+
1384
+ /// <summary>
1385
+ /// Gets or sets a value that indicates whether the webhook action of a
1386
+ /// <see cref="SavedSearch"/> signifies a trackable alert.
1387
+ /// </summary>
1388
+ /// <remarks>
1389
+ /// The default value is <c>false</c>.
1390
+ /// </remarks>
1391
+ /// <value>
1392
+ /// <c>true</c>, if the webhook action of a <see cref="SavedSearch"/>
1393
+ /// signifies a trackable alert; otherwise, <c>false</c>.
1394
+ /// </value>
1395
+ [ DataMember ( Name = "action.webhook.track_alert" , EmitDefaultValue = false ) ]
1396
+ public bool ? ActionWebHookTrackAlert
1397
+ { get ; set ; }
1398
+
1399
+ /// <summary>
1400
+ /// Gets or sets the minimum time-to-live for artifacts of the webhook action
1401
+ /// for a <see cref="SavedSearch"/>.
1402
+ /// </summary>
1403
+ /// <remarks>
1404
+ /// Express this value as a string of the form <c><![CDATA[ <integer>
1405
+ /// ["p"] ]]></c>. If <c>p</c> follows <![CDATA[<integer>]]>,
1406
+ /// the unit of time is the number of scheduled periods. Otherwise, the unit
1407
+ /// of time is seconds. The default is 86,400 seconds; equivalent to 24 hours.
1408
+ /// </remarks>
1409
+ /// <value>
1410
+ /// The minimum time-to-live for artifacts of the webhook action for a
1411
+ /// <see cref="SavedSearch"/>.
1412
+ /// </value>
1413
+ [ DataMember ( Name = "action.webhook.ttl" , EmitDefaultValue = false ) ]
1414
+ public string ActionWebHookTtl
1415
+ { get ; set ; }
1416
+
1241
1417
/// <summary>
1242
1418
/// Gets or sets the comparator used with <see cref="AlertThreshold"/>
1243
1419
/// to trigger alert actions.
@@ -1882,181 +2058,5 @@ public string RestartOnSearchPeerAdd
1882
2058
[ DataMember ( Name = "run_on_startup" , EmitDefaultValue = false ) ]
1883
2059
public bool ? RunOnStartup
1884
2060
{ get ; set ; }
1885
-
1886
- /// <summary>
1887
- /// Gets or sets the search command which is responsible for executing the
1888
- /// webhook action for a <see cref="SavedSearch"/>.
1889
- /// </summary>
1890
- /// <remarks>
1891
- /// Generally the command is a template search pipeline which is realized
1892
- /// with values from the <see cref="SavedSearch"/>. Reference template
1893
- /// arguments by enclosing their names in dollar signs ($). For example, to
1894
- /// reference <see cref="SavedSearch"/>.Name use
1895
- /// <c>$name$</c>. To reference <see cref="SavedSearch"/>.Search use
1896
- /// <c>$search$</c>.
1897
- /// </remarks>
1898
- /// <value>
1899
- /// The search command which is responsible for executing the webhook action
1900
- /// for a <see cref="SavedSearch"/>.
1901
- /// </value>
1902
- [ DataMember ( Name = "action.webook.command" , EmitDefaultValue = false ) ]
1903
- public string ActionWebHookCommand
1904
- { get ; set ; }
1905
-
1906
- /// <summary>
1907
- /// Gets or sets the human-readable description of a webhook action
1908
- /// <see cref= "SavedSearch"/>.
1909
- /// </summary>
1910
- /// <remarks>
1911
- /// The default value is an empty string.
1912
- /// </remarks>
1913
- /// <value>
1914
- /// The human-readable description of a webhook action <see cref="SavedSearch"/>.
1915
- /// </value>
1916
- [ DataMember ( Name = "action.webhook.description" , EmitDefaultValue = false ) ]
1917
- public string ActionWebHookDescription
1918
- { get ; set ; }
1919
-
1920
- /// <summary>
1921
- /// Gets or sets the hostname used in the web link (URI) that is sent in the
1922
- /// webhook action of a <see cref="SavedSearch"/>.
1923
- /// </summary>
1924
- /// <remarks>
1925
- /// Valid forms are <c>"hostname"</c> and <c>"protocol://hostname:port"</c>.
1926
- /// </remarks>
1927
- /// <value>
1928
- /// The hostname used in the web link (URI) that is sent in the webhook
1929
- /// action of a <see cref="SavedSearch"/>.
1930
- /// </value>
1931
- [ DataMember ( Name = "action.webhook.hostname" , EmitDefaultValue = false ) ]
1932
- public string ActionWebHookHostName
1933
- { get ; set ; }
1934
-
1935
- /// <summary>
1936
- /// Gets or sets the icon path used in the UI for the webhook
1937
- /// action of a <see cref="SavedSearch"/>.
1938
- /// </summary>>
1939
- /// <value>
1940
- /// The name of the webhook action icon path to display in the UI
1941
- /// of a <see cref="SavedSearch"/>.
1942
- /// </value>
1943
- [ DataMember ( Name = "action.webhook.icon_path" , EmitDefaultValue = false ) ]
1944
- public string ActionWebHookIconPath
1945
- { get ; set ; }
1946
-
1947
- /// <summary>
1948
- /// Gets or sets a value indicating whether whether the alert action is based
1949
- /// on the custom alert actions framework and is supposed to be listed in
1950
- /// the search UI
1951
- /// </summary>
1952
- /// <remarks>
1953
- /// The default value is <c>false</c>.
1954
- /// </remarks>
1955
- /// <value>
1956
- /// <c>true</c>, if the webhook action is custom of a <see cref="SavedSearch"/>.
1957
- /// </value>
1958
- [ DataMember ( Name = "action.webhook.is_custom" , EmitDefaultValue = false ) ]
1959
- public bool ? ActionWebHookIsCustom
1960
- { get ; set ; }
1961
-
1962
- /// <summary>
1963
- /// Gets or sets the label of the webhook action <see cref="SavedSearch"/>.
1964
- /// </summary>>
1965
- /// <value>
1966
- /// The name label of the webhook <see cref="SavedSearch"/>.
1967
- /// </value>
1968
- [ DataMember ( Name = "action.webhook.label" , EmitDefaultValue = false ) ]
1969
- public string ActionWebHookLabel
1970
- { get ; set ; }
1971
-
1972
- /// <summary>
1973
- /// Gets or sets the global maximum number of search results to send when the
1974
- /// webhook for a <see cref="SavedSearch"/> is enabled.
1975
- /// </summary>
1976
- /// <remarks>
1977
- /// The default value is <c>100</c>.
1978
- /// </remarks>
1979
- /// <value>
1980
- /// The global maximum number of search results to send when the webhook for a
1981
- /// <see cref="SavedSearch"/> is enabled.
1982
- /// </value>
1983
- [ DataMember ( Name = "action.webhook.maxresults" , EmitDefaultValue = false ) ]
1984
- public int ? ActionWebHookMaxResults
1985
- { get ; set ; }
1986
-
1987
- /// <summary>
1988
- /// Gets or sets the maximum period of time the webhook action for a
1989
- /// <see cref="SavedSearch"/> may execute before it is aborted.
1990
- /// </summary>
1991
- /// <remarks>
1992
- /// Express this value as a string of the form <c><![CDATA[ <integer>
1993
- /// ("s"|"m"|"h"|"d")]]></c>. The default is <c>"5m"</c>.
1994
- /// </remarks>
1995
- /// <value>
1996
- /// The maximum period of time the webhook action for a
1997
- /// <see cref= "SavedSearch"/> may execute before it is aborted.
1998
- /// </value>
1999
- [ DataMember ( Name = "action.webhook.maxtime" , EmitDefaultValue = false ) ]
2000
- public string ActionWebHookMaxTime
2001
- { get ; set ; }
2002
-
2003
- /// <summary>
2004
- /// Gets or sets the value of the User-Agent header sent to the webhook
2005
- /// receiver in a <see cref= "SavedSearch"/>
2006
- /// </summary>
2007
- /// <value>
2008
- /// The value of the User-Agent header sent to the webhook
2009
- /// receiver in a <see cref= "SavedSearch"/>
2010
- /// </value>
2011
- [ DataMember ( Name = "action.webhook.param.user_agent" , EmitDefaultValue = false ) ]
2012
- public string ActionWebHookParamUserAgent
2013
- { get ; set ; }
2014
-
2015
- /// <summary>
2016
- /// Gets or sets the payload format that is used in the webhook action of
2017
- /// a <see cref="SavedSearch"/>.
2018
- /// </summary>
2019
- /// <remarks>
2020
- /// Valid values are <c>"json"</c> and <c>"xml"</c>, defaults to <c>"xml"</c>.
2021
- /// </remarks>
2022
- /// <value>
2023
- /// The payload format set in the webhook action of a <see cref="SavedSearch"/>.
2024
- /// </value>
2025
- [ DataMember ( Name = "action.webhook.payload_format" , EmitDefaultValue = false ) ]
2026
- public string ActionWebHookPayloadFormat
2027
- { get ; set ; }
2028
-
2029
- /// <summary>
2030
- /// Gets or sets a value that indicates whether the webhook action of a
2031
- /// <see cref="SavedSearch"/> signifies a trackable alert.
2032
- /// </summary>
2033
- /// <remarks>
2034
- /// The default value is <c>false</c>.
2035
- /// </remarks>
2036
- /// <value>
2037
- /// <c>true</c>, if the webhook action of a <see cref="SavedSearch"/>
2038
- /// signifies a trackable alert; otherwise, <c>false</c>.
2039
- /// </value>
2040
- [ DataMember ( Name = "action.webhook.track_alert" , EmitDefaultValue = false ) ]
2041
- public bool ? ActionWebHookTrackAlert
2042
- { get ; set ; }
2043
-
2044
- /// <summary>
2045
- /// Gets or sets the minimum time-to-live for artifacts of the webhook action
2046
- /// for a <see cref="SavedSearch"/>.
2047
- /// </summary>
2048
- /// <remarks>
2049
- /// Express this value as a string of the form <c><![CDATA[ <integer>
2050
- /// ["p"] ]]></c>. If <c>p</c> follows <![CDATA[<integer>]]>,
2051
- /// the unit of time is the number of scheduled periods. Otherwise, the unit
2052
- /// of time is seconds. The default is 86,400 seconds; equivalent to 24 hours.
2053
- /// </remarks>
2054
- /// <value>
2055
- /// The minimum time-to-live for artifacts of the webhook action for a
2056
- /// <see cref="SavedSearch"/>.
2057
- /// </value>
2058
- [ DataMember ( Name = "action.webhook.ttl" , EmitDefaultValue = false ) ]
2059
- public string ActionWebHookTtl
2060
- { get ; set ; }
2061
2061
}
2062
2062
}
0 commit comments