cribl-control-plane 0.0.38__py3-none-any.whl → 0.4.0a6__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 (241) hide show
  1. cribl_control_plane/_hooks/clientcredentials.py +92 -42
  2. cribl_control_plane/_version.py +4 -4
  3. cribl_control_plane/acl.py +5 -3
  4. cribl_control_plane/auth_sdk.py +6 -3
  5. cribl_control_plane/basesdk.py +11 -1
  6. cribl_control_plane/commits.py +7 -5
  7. cribl_control_plane/destinations.py +6 -4
  8. cribl_control_plane/destinations_pq.py +2 -2
  9. cribl_control_plane/errors/__init__.py +23 -8
  10. cribl_control_plane/errors/apierror.py +2 -0
  11. cribl_control_plane/errors/criblcontrolplaneerror.py +11 -7
  12. cribl_control_plane/errors/error.py +4 -2
  13. cribl_control_plane/errors/healthserverstatus_error.py +41 -0
  14. cribl_control_plane/errors/no_response_error.py +5 -1
  15. cribl_control_plane/errors/responsevalidationerror.py +2 -0
  16. cribl_control_plane/groups_configs.py +8 -3
  17. cribl_control_plane/groups_sdk.py +64 -38
  18. cribl_control_plane/health.py +22 -12
  19. cribl_control_plane/httpclient.py +0 -1
  20. cribl_control_plane/lakedatasets.py +40 -12
  21. cribl_control_plane/models/__init__.py +1180 -54
  22. cribl_control_plane/models/authtoken.py +5 -1
  23. cribl_control_plane/models/{routecloneconf.py → branchinfo.py} +4 -4
  24. cribl_control_plane/models/cacheconnection.py +30 -2
  25. cribl_control_plane/models/cacheconnectionbackfillstatus.py +2 -1
  26. cribl_control_plane/models/cloudprovider.py +2 -1
  27. cribl_control_plane/models/configgroup.py +66 -11
  28. cribl_control_plane/models/configgroupcloud.py +17 -3
  29. cribl_control_plane/models/createconfiggroupbyproductop.py +27 -9
  30. cribl_control_plane/models/createinputhectokenbyidop.py +6 -5
  31. cribl_control_plane/models/createroutesappendbyidop.py +2 -2
  32. cribl_control_plane/models/createversionpushop.py +5 -5
  33. cribl_control_plane/models/createversionrevertop.py +2 -2
  34. cribl_control_plane/models/createversionundoop.py +3 -3
  35. cribl_control_plane/models/cribllakedataset.py +22 -2
  36. cribl_control_plane/models/cribllakedatasetupdate.py +95 -0
  37. cribl_control_plane/models/datasetmetadata.py +18 -2
  38. cribl_control_plane/models/deleteconfiggroupbyproductandidop.py +18 -2
  39. cribl_control_plane/models/deleteoutputpqbyidop.py +5 -5
  40. cribl_control_plane/models/deletepipelinebyidop.py +2 -2
  41. cribl_control_plane/models/difffiles.py +171 -0
  42. cribl_control_plane/models/distributedsummary.py +6 -0
  43. cribl_control_plane/models/getconfiggroupaclbyproductandidop.py +24 -2
  44. cribl_control_plane/models/getconfiggroupaclteamsbyproductandidop.py +24 -2
  45. cribl_control_plane/models/getconfiggroupbyproductandidop.py +14 -1
  46. cribl_control_plane/models/getconfiggroupconfigversionbyproductandidop.py +18 -2
  47. cribl_control_plane/models/getoutputpqbyidop.py +6 -5
  48. cribl_control_plane/models/getpipelinebyidop.py +2 -2
  49. cribl_control_plane/models/getroutesbyidop.py +2 -2
  50. cribl_control_plane/models/getsummaryop.py +18 -2
  51. cribl_control_plane/models/getversionbranchop.py +6 -5
  52. cribl_control_plane/models/getversioncountop.py +6 -5
  53. cribl_control_plane/models/getversiondiffop.py +6 -5
  54. cribl_control_plane/models/getversionshowop.py +6 -5
  55. cribl_control_plane/models/gitcountresult.py +13 -0
  56. cribl_control_plane/models/gitdiffresult.py +16 -0
  57. cribl_control_plane/models/gitinfo.py +14 -3
  58. cribl_control_plane/models/gitshowresult.py +19 -0
  59. cribl_control_plane/models/groupcreaterequest.py +171 -0
  60. cribl_control_plane/models/hbcriblinfo.py +39 -3
  61. cribl_control_plane/models/healthserverstatus.py +55 -0
  62. cribl_control_plane/models/heartbeatmetadata.py +3 -0
  63. cribl_control_plane/models/input.py +83 -78
  64. cribl_control_plane/models/inputappscope.py +126 -30
  65. cribl_control_plane/models/inputazureblob.py +62 -6
  66. cribl_control_plane/models/inputcloudflarehec.py +513 -0
  67. cribl_control_plane/models/inputcollection.py +47 -4
  68. cribl_control_plane/models/inputconfluentcloud.py +254 -30
  69. cribl_control_plane/models/inputcribl.py +47 -4
  70. cribl_control_plane/models/inputcriblhttp.py +121 -30
  71. cribl_control_plane/models/inputcribllakehttp.py +122 -30
  72. cribl_control_plane/models/inputcriblmetrics.py +48 -4
  73. cribl_control_plane/models/inputcribltcp.py +122 -24
  74. cribl_control_plane/models/inputcrowdstrike.py +92 -10
  75. cribl_control_plane/models/inputdatadogagent.py +98 -24
  76. cribl_control_plane/models/inputdatagen.py +47 -4
  77. cribl_control_plane/models/inputedgeprometheus.py +210 -50
  78. cribl_control_plane/models/inputelastic.py +167 -36
  79. cribl_control_plane/models/inputeventhub.py +209 -6
  80. cribl_control_plane/models/inputexec.py +59 -6
  81. cribl_control_plane/models/inputfile.py +78 -10
  82. cribl_control_plane/models/inputfirehose.py +97 -24
  83. cribl_control_plane/models/inputgooglepubsub.py +67 -6
  84. cribl_control_plane/models/inputgrafana.py +251 -71
  85. cribl_control_plane/models/inputhttp.py +97 -24
  86. cribl_control_plane/models/inputhttpraw.py +97 -24
  87. cribl_control_plane/models/inputjournalfiles.py +48 -4
  88. cribl_control_plane/models/inputkafka.py +248 -26
  89. cribl_control_plane/models/inputkinesis.py +130 -14
  90. cribl_control_plane/models/inputkubeevents.py +47 -4
  91. cribl_control_plane/models/inputkubelogs.py +61 -8
  92. cribl_control_plane/models/inputkubemetrics.py +61 -8
  93. cribl_control_plane/models/inputloki.py +113 -34
  94. cribl_control_plane/models/inputmetrics.py +97 -24
  95. cribl_control_plane/models/inputmodeldriventelemetry.py +107 -26
  96. cribl_control_plane/models/inputmsk.py +141 -30
  97. cribl_control_plane/models/inputnetflow.py +47 -4
  98. cribl_control_plane/models/inputoffice365mgmt.py +112 -14
  99. cribl_control_plane/models/inputoffice365msgtrace.py +114 -16
  100. cribl_control_plane/models/inputoffice365service.py +114 -16
  101. cribl_control_plane/models/inputopentelemetry.py +143 -32
  102. cribl_control_plane/models/inputprometheus.py +193 -44
  103. cribl_control_plane/models/inputprometheusrw.py +114 -27
  104. cribl_control_plane/models/inputrawudp.py +47 -4
  105. cribl_control_plane/models/inputs3.py +78 -8
  106. cribl_control_plane/models/inputs3inventory.py +92 -10
  107. cribl_control_plane/models/inputsecuritylake.py +93 -10
  108. cribl_control_plane/models/inputsnmp.py +68 -6
  109. cribl_control_plane/models/inputsplunk.py +130 -28
  110. cribl_control_plane/models/inputsplunkhec.py +111 -25
  111. cribl_control_plane/models/inputsplunksearch.py +108 -14
  112. cribl_control_plane/models/inputsqs.py +99 -16
  113. cribl_control_plane/models/inputsyslog.py +189 -47
  114. cribl_control_plane/models/inputsystemmetrics.py +202 -32
  115. cribl_control_plane/models/inputsystemstate.py +61 -8
  116. cribl_control_plane/models/inputtcp.py +122 -26
  117. cribl_control_plane/models/inputtcpjson.py +112 -26
  118. cribl_control_plane/models/inputwef.py +121 -15
  119. cribl_control_plane/models/inputwindowsmetrics.py +186 -33
  120. cribl_control_plane/models/inputwineventlogs.py +93 -11
  121. cribl_control_plane/models/inputwiz.py +78 -8
  122. cribl_control_plane/models/inputwizwebhook.py +97 -24
  123. cribl_control_plane/models/inputzscalerhec.py +111 -25
  124. cribl_control_plane/models/jobinfo.py +34 -0
  125. cribl_control_plane/models/jobstatus.py +48 -0
  126. cribl_control_plane/models/lakedatasetmetrics.py +17 -0
  127. cribl_control_plane/models/lakehouseconnectiontype.py +2 -1
  128. cribl_control_plane/models/listconfiggroupbyproductop.py +14 -1
  129. cribl_control_plane/models/logininfo.py +3 -3
  130. cribl_control_plane/models/masterworkerentry.py +17 -2
  131. cribl_control_plane/models/nodeactiveupgradestatus.py +2 -1
  132. cribl_control_plane/models/nodefailedupgradestatus.py +2 -1
  133. cribl_control_plane/models/nodeprovidedinfo.py +11 -1
  134. cribl_control_plane/models/nodeskippedupgradestatus.py +2 -1
  135. cribl_control_plane/models/nodeupgradestate.py +2 -1
  136. cribl_control_plane/models/nodeupgradestatus.py +51 -5
  137. cribl_control_plane/models/outpostnodeinfo.py +16 -0
  138. cribl_control_plane/models/output.py +104 -90
  139. cribl_control_plane/models/outputazureblob.py +171 -18
  140. cribl_control_plane/models/outputazuredataexplorer.py +514 -90
  141. cribl_control_plane/models/outputazureeventhub.py +315 -31
  142. cribl_control_plane/models/outputazurelogs.py +145 -26
  143. cribl_control_plane/models/outputchronicle.py +532 -0
  144. cribl_control_plane/models/outputclickhouse.py +205 -34
  145. cribl_control_plane/models/outputcloudflarer2.py +632 -0
  146. cribl_control_plane/models/outputcloudwatch.py +129 -23
  147. cribl_control_plane/models/outputconfluentcloud.py +384 -57
  148. cribl_control_plane/models/outputcriblhttp.py +199 -32
  149. cribl_control_plane/models/outputcribllake.py +156 -16
  150. cribl_control_plane/models/outputcribltcp.py +194 -29
  151. cribl_control_plane/models/outputcrowdstrikenextgensiem.py +172 -28
  152. cribl_control_plane/models/outputdatabricks.py +501 -0
  153. cribl_control_plane/models/outputdatadog.py +199 -31
  154. cribl_control_plane/models/outputdataset.py +181 -29
  155. cribl_control_plane/models/outputdiskspool.py +17 -2
  156. cribl_control_plane/models/outputdls3.py +233 -24
  157. cribl_control_plane/models/outputdynatracehttp.py +208 -34
  158. cribl_control_plane/models/outputdynatraceotlp.py +210 -36
  159. cribl_control_plane/models/outputelastic.py +199 -30
  160. cribl_control_plane/models/outputelasticcloud.py +171 -26
  161. cribl_control_plane/models/outputexabeam.py +96 -10
  162. cribl_control_plane/models/outputfilesystem.py +139 -14
  163. cribl_control_plane/models/outputgooglechronicle.py +216 -35
  164. cribl_control_plane/models/outputgooglecloudlogging.py +174 -31
  165. cribl_control_plane/models/outputgooglecloudstorage.py +215 -24
  166. cribl_control_plane/models/outputgooglepubsub.py +131 -23
  167. cribl_control_plane/models/outputgrafanacloud.py +376 -74
  168. cribl_control_plane/models/outputgraphite.py +128 -25
  169. cribl_control_plane/models/outputhoneycomb.py +145 -26
  170. cribl_control_plane/models/outputhumiohec.py +162 -28
  171. cribl_control_plane/models/outputinfluxdb.py +165 -28
  172. cribl_control_plane/models/outputkafka.py +375 -52
  173. cribl_control_plane/models/outputkinesis.py +165 -27
  174. cribl_control_plane/models/outputloki.py +164 -34
  175. cribl_control_plane/models/outputmicrosoftfabric.py +540 -0
  176. cribl_control_plane/models/outputminio.py +225 -25
  177. cribl_control_plane/models/outputmsk.py +267 -54
  178. cribl_control_plane/models/outputnewrelic.py +171 -29
  179. cribl_control_plane/models/outputnewrelicevents.py +163 -28
  180. cribl_control_plane/models/outputopentelemetry.py +240 -40
  181. cribl_control_plane/models/outputprometheus.py +145 -26
  182. cribl_control_plane/models/outputring.py +49 -8
  183. cribl_control_plane/models/outputs3.py +233 -26
  184. cribl_control_plane/models/outputsecuritylake.py +179 -18
  185. cribl_control_plane/models/outputsentinel.py +172 -29
  186. cribl_control_plane/models/outputsentineloneaisiem.py +181 -35
  187. cribl_control_plane/models/outputservicenow.py +223 -38
  188. cribl_control_plane/models/outputsignalfx.py +145 -26
  189. cribl_control_plane/models/outputsns.py +143 -25
  190. cribl_control_plane/models/outputsplunk.py +206 -36
  191. cribl_control_plane/models/outputsplunkhec.py +238 -26
  192. cribl_control_plane/models/outputsplunklb.py +253 -43
  193. cribl_control_plane/models/outputsqs.py +163 -33
  194. cribl_control_plane/models/outputstatsd.py +127 -25
  195. cribl_control_plane/models/outputstatsdext.py +128 -25
  196. cribl_control_plane/models/outputsumologic.py +146 -25
  197. cribl_control_plane/models/outputsyslog.py +318 -46
  198. cribl_control_plane/models/outputtcpjson.py +186 -32
  199. cribl_control_plane/models/outputwavefront.py +145 -26
  200. cribl_control_plane/models/outputwebhook.py +211 -33
  201. cribl_control_plane/models/outputxsiam.py +143 -26
  202. cribl_control_plane/models/packinfo.py +8 -5
  203. cribl_control_plane/models/packinstallinfo.py +11 -8
  204. cribl_control_plane/models/productscore.py +2 -1
  205. cribl_control_plane/models/rbacresource.py +2 -1
  206. cribl_control_plane/models/resourcepolicy.py +15 -2
  207. cribl_control_plane/models/routeconf.py +3 -4
  208. cribl_control_plane/models/runnablejob.py +27 -0
  209. cribl_control_plane/models/runnablejobcollection.py +669 -0
  210. cribl_control_plane/models/runnablejobexecutor.py +368 -0
  211. cribl_control_plane/models/runnablejobscheduledsearch.py +286 -0
  212. cribl_control_plane/models/updateconfiggroupbyproductandidop.py +19 -2
  213. cribl_control_plane/models/updateconfiggroupdeploybyproductandidop.py +19 -2
  214. cribl_control_plane/models/updatecribllakedatasetbylakeidandidop.py +9 -5
  215. cribl_control_plane/models/updateinputhectokenbyidandtokenop.py +6 -5
  216. cribl_control_plane/models/updatepacksop.py +25 -0
  217. cribl_control_plane/models/updatepipelinebyidop.py +6 -6
  218. cribl_control_plane/models/updateroutesbyidop.py +2 -2
  219. cribl_control_plane/models/uploadpackresponse.py +13 -0
  220. cribl_control_plane/models/workertypes.py +2 -1
  221. cribl_control_plane/nodes.py +5 -3
  222. cribl_control_plane/packs.py +202 -7
  223. cribl_control_plane/pipelines.py +18 -18
  224. cribl_control_plane/routes_sdk.py +22 -22
  225. cribl_control_plane/sdk.py +19 -6
  226. cribl_control_plane/sources.py +5 -3
  227. cribl_control_plane/tokens.py +23 -15
  228. cribl_control_plane/utils/__init__.py +15 -3
  229. cribl_control_plane/utils/annotations.py +32 -8
  230. cribl_control_plane/utils/eventstreaming.py +10 -0
  231. cribl_control_plane/utils/retries.py +69 -5
  232. cribl_control_plane/utils/unmarshal_json_response.py +15 -1
  233. cribl_control_plane/versions.py +11 -6
  234. {cribl_control_plane-0.0.38.dist-info → cribl_control_plane-0.4.0a6.dist-info}/METADATA +69 -23
  235. cribl_control_plane-0.4.0a6.dist-info/RECORD +336 -0
  236. {cribl_control_plane-0.0.38.dist-info → cribl_control_plane-0.4.0a6.dist-info}/WHEEL +1 -1
  237. cribl_control_plane-0.4.0a6.dist-info/licenses/LICENSE +201 -0
  238. cribl_control_plane/errors/healthstatus_error.py +0 -32
  239. cribl_control_plane/models/appmode.py +0 -13
  240. cribl_control_plane/models/healthstatus.py +0 -33
  241. cribl_control_plane-0.0.38.dist-info/RECORD +0 -315
@@ -3,9 +3,17 @@
3
3
  from __future__ import annotations
4
4
  from .configgroup import ConfigGroup, ConfigGroupTypedDict
5
5
  from .productscore import ProductsCore
6
+ from cribl_control_plane import models
6
7
  from cribl_control_plane.types import BaseModel
7
- from cribl_control_plane.utils import FieldMetadata, PathParamMetadata, RequestMetadata
8
+ from cribl_control_plane.utils import (
9
+ FieldMetadata,
10
+ PathParamMetadata,
11
+ RequestMetadata,
12
+ validate_open_enum,
13
+ )
8
14
  import pydantic
15
+ from pydantic import field_serializer
16
+ from pydantic.functional_validators import PlainValidator
9
17
  from typing import List, Optional
10
18
  from typing_extensions import Annotated, NotRequired, TypedDict
11
19
 
@@ -21,7 +29,7 @@ class UpdateConfigGroupByProductAndIDRequestTypedDict(TypedDict):
21
29
 
22
30
  class UpdateConfigGroupByProductAndIDRequest(BaseModel):
23
31
  product: Annotated[
24
- ProductsCore,
32
+ Annotated[ProductsCore, PlainValidator(validate_open_enum(False))],
25
33
  FieldMetadata(path=PathParamMetadata(style="simple", explode=False)),
26
34
  ]
27
35
  r"""Name of the Cribl product to get the Worker Groups or Edge Fleets for."""
@@ -39,6 +47,15 @@ class UpdateConfigGroupByProductAndIDRequest(BaseModel):
39
47
  ]
40
48
  r"""ConfigGroup object"""
41
49
 
50
+ @field_serializer("product")
51
+ def serialize_product(self, value):
52
+ if isinstance(value, str):
53
+ try:
54
+ return models.ProductsCore(value)
55
+ except ValueError:
56
+ return value
57
+ return value
58
+
42
59
 
43
60
  class UpdateConfigGroupByProductAndIDResponseTypedDict(TypedDict):
44
61
  r"""a list of ConfigGroup objects"""
@@ -4,8 +4,16 @@ from __future__ import annotations
4
4
  from .configgroup import ConfigGroup, ConfigGroupTypedDict
5
5
  from .deployrequest import DeployRequest, DeployRequestTypedDict
6
6
  from .productscore import ProductsCore
7
+ from cribl_control_plane import models
7
8
  from cribl_control_plane.types import BaseModel
8
- from cribl_control_plane.utils import FieldMetadata, PathParamMetadata, RequestMetadata
9
+ from cribl_control_plane.utils import (
10
+ FieldMetadata,
11
+ PathParamMetadata,
12
+ RequestMetadata,
13
+ validate_open_enum,
14
+ )
15
+ from pydantic import field_serializer
16
+ from pydantic.functional_validators import PlainValidator
9
17
  from typing import List, Optional
10
18
  from typing_extensions import Annotated, NotRequired, TypedDict
11
19
 
@@ -21,7 +29,7 @@ class UpdateConfigGroupDeployByProductAndIDRequestTypedDict(TypedDict):
21
29
 
22
30
  class UpdateConfigGroupDeployByProductAndIDRequest(BaseModel):
23
31
  product: Annotated[
24
- ProductsCore,
32
+ Annotated[ProductsCore, PlainValidator(validate_open_enum(False))],
25
33
  FieldMetadata(path=PathParamMetadata(style="simple", explode=False)),
26
34
  ]
27
35
  r"""Name of the Cribl product to get the Worker Groups or Edge Fleets for."""
@@ -37,6 +45,15 @@ class UpdateConfigGroupDeployByProductAndIDRequest(BaseModel):
37
45
  ]
38
46
  r"""DeployRequest object"""
39
47
 
48
+ @field_serializer("product")
49
+ def serialize_product(self, value):
50
+ if isinstance(value, str):
51
+ try:
52
+ return models.ProductsCore(value)
53
+ except ValueError:
54
+ return value
55
+ return value
56
+
40
57
 
41
58
  class UpdateConfigGroupDeployByProductAndIDResponseTypedDict(TypedDict):
42
59
  r"""a list of ConfigGroup objects"""
@@ -2,6 +2,10 @@
2
2
 
3
3
  from __future__ import annotations
4
4
  from .cribllakedataset import CriblLakeDataset, CriblLakeDatasetTypedDict
5
+ from .cribllakedatasetupdate import (
6
+ CriblLakeDatasetUpdate,
7
+ CriblLakeDatasetUpdateTypedDict,
8
+ )
5
9
  from cribl_control_plane.types import BaseModel
6
10
  from cribl_control_plane.utils import FieldMetadata, PathParamMetadata, RequestMetadata
7
11
  import pydantic
@@ -14,8 +18,8 @@ class UpdateCriblLakeDatasetByLakeIDAndIDRequestTypedDict(TypedDict):
14
18
  r"""The <code>id</code> of the Lake that contains the Lake Dataset to update."""
15
19
  id_param: str
16
20
  r"""The <code>id</code> of the Lake Dataset to update."""
17
- cribl_lake_dataset: CriblLakeDatasetTypedDict
18
- r"""CriblLakeDataset object"""
21
+ cribl_lake_dataset_update: CriblLakeDatasetUpdateTypedDict
22
+ r"""CriblLakeDatasetUpdate object"""
19
23
 
20
24
 
21
25
  class UpdateCriblLakeDatasetByLakeIDAndIDRequest(BaseModel):
@@ -33,11 +37,11 @@ class UpdateCriblLakeDatasetByLakeIDAndIDRequest(BaseModel):
33
37
  ]
34
38
  r"""The <code>id</code> of the Lake Dataset to update."""
35
39
 
36
- cribl_lake_dataset: Annotated[
37
- CriblLakeDataset,
40
+ cribl_lake_dataset_update: Annotated[
41
+ CriblLakeDatasetUpdate,
38
42
  FieldMetadata(request=RequestMetadata(media_type="application/json")),
39
43
  ]
40
- r"""CriblLakeDataset object"""
44
+ r"""CriblLakeDatasetUpdate object"""
41
45
 
42
46
 
43
47
  class UpdateCriblLakeDatasetByLakeIDAndIDResponseTypedDict(TypedDict):
@@ -1,10 +1,11 @@
1
1
  """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
2
2
 
3
3
  from __future__ import annotations
4
+ from .inputsplunkhec import InputSplunkHec, InputSplunkHecTypedDict
4
5
  from .updatehectokenrequest import UpdateHecTokenRequest, UpdateHecTokenRequestTypedDict
5
6
  from cribl_control_plane.types import BaseModel
6
7
  from cribl_control_plane.utils import FieldMetadata, PathParamMetadata, RequestMetadata
7
- from typing import Any, Dict, List, Optional
8
+ from typing import List, Optional
8
9
  from typing_extensions import Annotated, NotRequired, TypedDict
9
10
 
10
11
 
@@ -36,17 +37,17 @@ class UpdateInputHecTokenByIDAndTokenRequest(BaseModel):
36
37
 
37
38
 
38
39
  class UpdateInputHecTokenByIDAndTokenResponseTypedDict(TypedDict):
39
- r"""a list of any objects"""
40
+ r"""a list of InputSplunkHec objects"""
40
41
 
41
42
  count: NotRequired[int]
42
43
  r"""number of items present in the items array"""
43
- items: NotRequired[List[Dict[str, Any]]]
44
+ items: NotRequired[List[InputSplunkHecTypedDict]]
44
45
 
45
46
 
46
47
  class UpdateInputHecTokenByIDAndTokenResponse(BaseModel):
47
- r"""a list of any objects"""
48
+ r"""a list of InputSplunkHec objects"""
48
49
 
49
50
  count: Optional[int] = None
50
51
  r"""number of items present in the items array"""
51
52
 
52
- items: Optional[List[Dict[str, Any]]] = None
53
+ items: Optional[List[InputSplunkHec]] = None
@@ -0,0 +1,25 @@
1
+ """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
2
+
3
+ from __future__ import annotations
4
+ from cribl_control_plane.types import BaseModel
5
+ from cribl_control_plane.utils import FieldMetadata, QueryParamMetadata
6
+ import io
7
+ from typing import IO, Union
8
+ from typing_extensions import Annotated, TypedDict
9
+
10
+
11
+ class UpdatePacksRequestTypedDict(TypedDict):
12
+ filename: str
13
+ r"""Filename of the Pack file to upload."""
14
+ request_body: Union[bytes, IO[bytes], io.BufferedReader]
15
+
16
+
17
+ class UpdatePacksRequest(BaseModel):
18
+ filename: Annotated[
19
+ str, FieldMetadata(query=QueryParamMetadata(style="form", explode=True))
20
+ ]
21
+ r"""Filename of the Pack file to upload."""
22
+
23
+ request_body: Annotated[
24
+ Union[bytes, IO[bytes], io.BufferedReader], FieldMetadata(request=True)
25
+ ]
@@ -11,9 +11,9 @@ from typing_extensions import Annotated, NotRequired, TypedDict
11
11
 
12
12
  class UpdatePipelineByIDRequestTypedDict(TypedDict):
13
13
  id_param: str
14
- r"""Unique ID to PATCH"""
14
+ r"""The <code>id</code> of the Pipeline to update."""
15
15
  pipeline: PipelineTypedDict
16
- r"""Pipeline object to be updated"""
16
+ r"""Pipeline object"""
17
17
 
18
18
 
19
19
  class UpdatePipelineByIDRequest(BaseModel):
@@ -22,16 +22,16 @@ class UpdatePipelineByIDRequest(BaseModel):
22
22
  pydantic.Field(alias="id"),
23
23
  FieldMetadata(path=PathParamMetadata(style="simple", explode=False)),
24
24
  ]
25
- r"""Unique ID to PATCH"""
25
+ r"""The <code>id</code> of the Pipeline to update."""
26
26
 
27
27
  pipeline: Annotated[
28
28
  Pipeline, FieldMetadata(request=RequestMetadata(media_type="application/json"))
29
29
  ]
30
- r"""Pipeline object to be updated"""
30
+ r"""Pipeline object"""
31
31
 
32
32
 
33
33
  class UpdatePipelineByIDResponseTypedDict(TypedDict):
34
- r"""a list of any objects"""
34
+ r"""a list of Pipeline objects"""
35
35
 
36
36
  count: NotRequired[int]
37
37
  r"""number of items present in the items array"""
@@ -39,7 +39,7 @@ class UpdatePipelineByIDResponseTypedDict(TypedDict):
39
39
 
40
40
 
41
41
  class UpdatePipelineByIDResponse(BaseModel):
42
- r"""a list of any objects"""
42
+ r"""a list of Pipeline objects"""
43
43
 
44
44
  count: Optional[int] = None
45
45
  r"""number of items present in the items array"""
@@ -11,7 +11,7 @@ from typing_extensions import Annotated, NotRequired, TypedDict
11
11
 
12
12
  class UpdateRoutesByIDRequestTypedDict(TypedDict):
13
13
  id_param: str
14
- r"""Unique ID to PATCH"""
14
+ r"""The <code>id</code> of the Routing table that contains the Route to update. The supported value is <code>default</code>."""
15
15
  routes: RoutesTypedDict
16
16
  r"""Routes object"""
17
17
 
@@ -22,7 +22,7 @@ class UpdateRoutesByIDRequest(BaseModel):
22
22
  pydantic.Field(alias="id"),
23
23
  FieldMetadata(path=PathParamMetadata(style="simple", explode=False)),
24
24
  ]
25
- r"""Unique ID to PATCH"""
25
+ r"""The <code>id</code> of the Routing table that contains the Route to update. The supported value is <code>default</code>."""
26
26
 
27
27
  routes: Annotated[
28
28
  Routes, FieldMetadata(request=RequestMetadata(media_type="application/json"))
@@ -0,0 +1,13 @@
1
+ """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
2
+
3
+ from __future__ import annotations
4
+ from cribl_control_plane.types import BaseModel
5
+ from typing_extensions import TypedDict
6
+
7
+
8
+ class UploadPackResponseTypedDict(TypedDict):
9
+ source: str
10
+
11
+
12
+ class UploadPackResponse(BaseModel):
13
+ source: str
@@ -1,9 +1,10 @@
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 utils
4
5
  from enum import Enum
5
6
 
6
7
 
7
- class WorkerTypes(str, Enum):
8
+ class WorkerTypes(str, Enum, metaclass=utils.OpenEnumMeta):
8
9
  WORKER = "worker"
9
10
  MANAGED_EDGE = "managed-edge"
@@ -14,13 +14,15 @@ from typing import Any, Mapping, Optional
14
14
  class Nodes(BaseSDK):
15
15
  summaries: Summaries
16
16
 
17
- def __init__(self, sdk_config: SDKConfiguration) -> None:
18
- BaseSDK.__init__(self, sdk_config)
17
+ def __init__(
18
+ self, sdk_config: SDKConfiguration, parent_ref: Optional[object] = None
19
+ ) -> None:
20
+ BaseSDK.__init__(self, sdk_config, parent_ref=parent_ref)
19
21
  self.sdk_configuration = sdk_config
20
22
  self._init_sdks()
21
23
 
22
24
  def _init_sdks(self):
23
- self.summaries = Summaries(self.sdk_configuration)
25
+ self.summaries = Summaries(self.sdk_configuration, parent_ref=self.parent_ref)
24
26
 
25
27
  def list(
26
28
  self,
@@ -6,7 +6,8 @@ from cribl_control_plane._hooks import HookContext
6
6
  from cribl_control_plane.types import BaseModel, OptionalNullable, UNSET
7
7
  from cribl_control_plane.utils import get_security_from_env
8
8
  from cribl_control_plane.utils.unmarshal_json_response import unmarshal_json_response
9
- from typing import Any, Mapping, Optional, Union, cast
9
+ import io
10
+ from typing import Any, IO, Mapping, Optional, Union, cast
10
11
 
11
12
 
12
13
  class Packs(BaseSDK):
@@ -23,9 +24,9 @@ class Packs(BaseSDK):
23
24
  timeout_ms: Optional[int] = None,
24
25
  http_headers: Optional[Mapping[str, str]] = None,
25
26
  ) -> models.CreatePacksResponse:
26
- r"""Create or install a Pack
27
+ r"""Install a Pack
27
28
 
28
- Create or install a Pack.
29
+ Install a Pack.<br><br>To install an uploaded Pack, provide the <code>source</code> value from the <code>PUT /packs</code> response as the <code>source</code> parameter in the request body.<br><br>To install a Pack by importing from a URL, provide the direct URL location of the <code>.crbl</code> file for the Pack as the <code>source</code> parameter in the request body.<br><br>To install a Pack by importing from a Git repository, provide <code>git+<repo-url></code> as the <code>source</code> parameter in the request body.<br><br>If you do not include the <code>source</code> parameter in the request body, an empty Pack is created.
29
30
 
30
31
  :param request: The request object to send.
31
32
  :param retries: Override the default retry configuration for this method
@@ -115,9 +116,9 @@ class Packs(BaseSDK):
115
116
  timeout_ms: Optional[int] = None,
116
117
  http_headers: Optional[Mapping[str, str]] = None,
117
118
  ) -> models.CreatePacksResponse:
118
- r"""Create or install a Pack
119
+ r"""Install a Pack
119
120
 
120
- Create or install a Pack.
121
+ Install a Pack.<br><br>To install an uploaded Pack, provide the <code>source</code> value from the <code>PUT /packs</code> response as the <code>source</code> parameter in the request body.<br><br>To install a Pack by importing from a URL, provide the direct URL location of the <code>.crbl</code> file for the Pack as the <code>source</code> parameter in the request body.<br><br>To install a Pack by importing from a Git repository, provide <code>git+<repo-url></code> as the <code>source</code> parameter in the request body.<br><br>If you do not include the <code>source</code> parameter in the request body, an empty Pack is created.
121
122
 
122
123
  :param request: The request object to send.
123
124
  :param retries: Override the default retry configuration for this method
@@ -370,6 +371,200 @@ class Packs(BaseSDK):
370
371
 
371
372
  raise errors.APIError("Unexpected response received", http_res)
372
373
 
374
+ def upload(
375
+ self,
376
+ *,
377
+ filename: str,
378
+ request_body: Union[bytes, IO[bytes], io.BufferedReader],
379
+ retries: OptionalNullable[utils.RetryConfig] = UNSET,
380
+ server_url: Optional[str] = None,
381
+ timeout_ms: Optional[int] = None,
382
+ http_headers: Optional[Mapping[str, str]] = None,
383
+ ) -> models.UploadPackResponse:
384
+ r"""Upload a Pack file
385
+
386
+ Upload a Pack file. Returns the <code>source</code> ID needed to install the Pack with <code>POST /packs source</code>, which you must call separately.
387
+
388
+ :param filename: Filename of the Pack file to upload.
389
+ :param request_body:
390
+ :param retries: Override the default retry configuration for this method
391
+ :param server_url: Override the default server URL for this method
392
+ :param timeout_ms: Override the default request timeout configuration for this method in milliseconds
393
+ :param http_headers: Additional headers to set or replace on requests.
394
+ """
395
+ base_url = None
396
+ url_variables = None
397
+ if timeout_ms is None:
398
+ timeout_ms = self.sdk_configuration.timeout_ms
399
+
400
+ if server_url is not None:
401
+ base_url = server_url
402
+ else:
403
+ base_url = self._get_url(base_url, url_variables)
404
+
405
+ request = models.UpdatePacksRequest(
406
+ filename=filename,
407
+ request_body=request_body,
408
+ )
409
+
410
+ req = self._build_request(
411
+ method="PUT",
412
+ path="/packs",
413
+ base_url=base_url,
414
+ url_variables=url_variables,
415
+ request=request,
416
+ request_body_required=True,
417
+ request_has_path_params=False,
418
+ request_has_query_params=True,
419
+ user_agent_header="user-agent",
420
+ accept_header_value="application/json",
421
+ http_headers=http_headers,
422
+ security=self.sdk_configuration.security,
423
+ get_serialized_body=lambda: utils.serialize_request_body(
424
+ request.request_body,
425
+ False,
426
+ False,
427
+ "raw",
428
+ Union[bytes, IO[bytes], io.BufferedReader],
429
+ ),
430
+ timeout_ms=timeout_ms,
431
+ )
432
+
433
+ if retries == UNSET:
434
+ if self.sdk_configuration.retry_config is not UNSET:
435
+ retries = self.sdk_configuration.retry_config
436
+
437
+ retry_config = None
438
+ if isinstance(retries, utils.RetryConfig):
439
+ retry_config = (retries, ["429", "500", "502", "503", "504"])
440
+
441
+ http_res = self.do_request(
442
+ hook_ctx=HookContext(
443
+ config=self.sdk_configuration,
444
+ base_url=base_url or "",
445
+ operation_id="updatePacks",
446
+ oauth2_scopes=[],
447
+ security_source=get_security_from_env(
448
+ self.sdk_configuration.security, models.Security
449
+ ),
450
+ ),
451
+ request=req,
452
+ error_status_codes=["401", "4XX", "500", "5XX"],
453
+ retry_config=retry_config,
454
+ )
455
+
456
+ response_data: Any = None
457
+ if utils.match_response(http_res, "200", "application/json"):
458
+ return unmarshal_json_response(models.UploadPackResponse, http_res)
459
+ if utils.match_response(http_res, "500", "application/json"):
460
+ response_data = unmarshal_json_response(errors.ErrorData, http_res)
461
+ raise errors.Error(response_data, http_res)
462
+ if utils.match_response(http_res, ["401", "4XX"], "*"):
463
+ http_res_text = utils.stream_to_text(http_res)
464
+ raise errors.APIError("API error occurred", http_res, http_res_text)
465
+ if utils.match_response(http_res, "5XX", "*"):
466
+ http_res_text = utils.stream_to_text(http_res)
467
+ raise errors.APIError("API error occurred", http_res, http_res_text)
468
+
469
+ raise errors.APIError("Unexpected response received", http_res)
470
+
471
+ async def upload_async(
472
+ self,
473
+ *,
474
+ filename: str,
475
+ request_body: Union[bytes, IO[bytes], io.BufferedReader],
476
+ retries: OptionalNullable[utils.RetryConfig] = UNSET,
477
+ server_url: Optional[str] = None,
478
+ timeout_ms: Optional[int] = None,
479
+ http_headers: Optional[Mapping[str, str]] = None,
480
+ ) -> models.UploadPackResponse:
481
+ r"""Upload a Pack file
482
+
483
+ Upload a Pack file. Returns the <code>source</code> ID needed to install the Pack with <code>POST /packs source</code>, which you must call separately.
484
+
485
+ :param filename: Filename of the Pack file to upload.
486
+ :param request_body:
487
+ :param retries: Override the default retry configuration for this method
488
+ :param server_url: Override the default server URL for this method
489
+ :param timeout_ms: Override the default request timeout configuration for this method in milliseconds
490
+ :param http_headers: Additional headers to set or replace on requests.
491
+ """
492
+ base_url = None
493
+ url_variables = None
494
+ if timeout_ms is None:
495
+ timeout_ms = self.sdk_configuration.timeout_ms
496
+
497
+ if server_url is not None:
498
+ base_url = server_url
499
+ else:
500
+ base_url = self._get_url(base_url, url_variables)
501
+
502
+ request = models.UpdatePacksRequest(
503
+ filename=filename,
504
+ request_body=request_body,
505
+ )
506
+
507
+ req = self._build_request_async(
508
+ method="PUT",
509
+ path="/packs",
510
+ base_url=base_url,
511
+ url_variables=url_variables,
512
+ request=request,
513
+ request_body_required=True,
514
+ request_has_path_params=False,
515
+ request_has_query_params=True,
516
+ user_agent_header="user-agent",
517
+ accept_header_value="application/json",
518
+ http_headers=http_headers,
519
+ security=self.sdk_configuration.security,
520
+ get_serialized_body=lambda: utils.serialize_request_body(
521
+ request.request_body,
522
+ False,
523
+ False,
524
+ "raw",
525
+ Union[bytes, IO[bytes], io.BufferedReader],
526
+ ),
527
+ timeout_ms=timeout_ms,
528
+ )
529
+
530
+ if retries == UNSET:
531
+ if self.sdk_configuration.retry_config is not UNSET:
532
+ retries = self.sdk_configuration.retry_config
533
+
534
+ retry_config = None
535
+ if isinstance(retries, utils.RetryConfig):
536
+ retry_config = (retries, ["429", "500", "502", "503", "504"])
537
+
538
+ http_res = await self.do_request_async(
539
+ hook_ctx=HookContext(
540
+ config=self.sdk_configuration,
541
+ base_url=base_url or "",
542
+ operation_id="updatePacks",
543
+ oauth2_scopes=[],
544
+ security_source=get_security_from_env(
545
+ self.sdk_configuration.security, models.Security
546
+ ),
547
+ ),
548
+ request=req,
549
+ error_status_codes=["401", "4XX", "500", "5XX"],
550
+ retry_config=retry_config,
551
+ )
552
+
553
+ response_data: Any = None
554
+ if utils.match_response(http_res, "200", "application/json"):
555
+ return unmarshal_json_response(models.UploadPackResponse, http_res)
556
+ if utils.match_response(http_res, "500", "application/json"):
557
+ response_data = unmarshal_json_response(errors.ErrorData, http_res)
558
+ raise errors.Error(response_data, http_res)
559
+ if utils.match_response(http_res, ["401", "4XX"], "*"):
560
+ http_res_text = await utils.stream_to_text_async(http_res)
561
+ raise errors.APIError("API error occurred", http_res, http_res_text)
562
+ if utils.match_response(http_res, "5XX", "*"):
563
+ http_res_text = await utils.stream_to_text_async(http_res)
564
+ raise errors.APIError("API error occurred", http_res, http_res_text)
565
+
566
+ raise errors.APIError("Unexpected response received", http_res)
567
+
373
568
  def delete(
374
569
  self,
375
570
  *,
@@ -733,7 +928,7 @@ class Packs(BaseSDK):
733
928
  ) -> models.UpdatePacksByIDResponse:
734
929
  r"""Upgrade a Pack
735
930
 
736
- Upgrade the specified Pack.</br></br>If the Pack includes any user–modified versions of default Cribl Knowledge resources such as lookups, copy the modified files locally for safekeeping before upgrading the Pack. Copy the modified files back to the upgraded Pack after you install it with <code>POST /packs</code> to overwrite the default versions in the Pack.</br></br>After you upgrade the Pack, update any Routes, Pipelines, Sources, and Destinations that use the previous Pack version so that they reference the upgraded Pack.
931
+ Upgrade the specified Pack.</br></br>If the Pack includes any user–modified versions of default Cribl Knowledge resources such as lookups, copy the modified files locally for safekeeping before upgrading the Pack.Copy the modified files back to the upgraded Pack after you install it with <code>POST /packs</code> to overwrite the default versions in the Pack.</br></br>After you upgrade the Pack, update any Routes, Pipelines, Sources, and Destinations that use the previous Pack version so that they reference the upgraded Pack.
737
932
 
738
933
  :param id: The <code>id</code> of the Pack to upgrade.
739
934
  :param source:
@@ -841,7 +1036,7 @@ class Packs(BaseSDK):
841
1036
  ) -> models.UpdatePacksByIDResponse:
842
1037
  r"""Upgrade a Pack
843
1038
 
844
- Upgrade the specified Pack.</br></br>If the Pack includes any user–modified versions of default Cribl Knowledge resources such as lookups, copy the modified files locally for safekeeping before upgrading the Pack. Copy the modified files back to the upgraded Pack after you install it with <code>POST /packs</code> to overwrite the default versions in the Pack.</br></br>After you upgrade the Pack, update any Routes, Pipelines, Sources, and Destinations that use the previous Pack version so that they reference the upgraded Pack.
1039
+ Upgrade the specified Pack.</br></br>If the Pack includes any user–modified versions of default Cribl Knowledge resources such as lookups, copy the modified files locally for safekeeping before upgrading the Pack.Copy the modified files back to the upgraded Pack after you install it with <code>POST /packs</code> to overwrite the default versions in the Pack.</br></br>After you upgrade the Pack, update any Routes, Pipelines, Sources, and Destinations that use the previous Pack version so that they reference the upgraded Pack.
845
1040
 
846
1041
  :param id: The <code>id</code> of the Pack to upgrade.
847
1042
  :param source:
@@ -22,7 +22,7 @@ class Pipelines(BaseSDK):
22
22
  ) -> models.ListPipelineResponse:
23
23
  r"""List all Pipelines
24
24
 
25
- List all Pipelines
25
+ Get a list of all Pipelines.
26
26
 
27
27
  :param retries: Override the default retry configuration for this method
28
28
  :param server_url: Override the default server URL for this method
@@ -102,7 +102,7 @@ class Pipelines(BaseSDK):
102
102
  ) -> models.ListPipelineResponse:
103
103
  r"""List all Pipelines
104
104
 
105
- List all Pipelines
105
+ Get a list of all Pipelines.
106
106
 
107
107
  :param retries: Override the default retry configuration for this method
108
108
  :param server_url: Override the default server URL for this method
@@ -184,7 +184,7 @@ class Pipelines(BaseSDK):
184
184
  ) -> models.CreatePipelineResponse:
185
185
  r"""Create a Pipeline
186
186
 
187
- Create a Pipeline
187
+ Create a new Pipeline.
188
188
 
189
189
  :param id:
190
190
  :param conf:
@@ -277,7 +277,7 @@ class Pipelines(BaseSDK):
277
277
  ) -> models.CreatePipelineResponse:
278
278
  r"""Create a Pipeline
279
279
 
280
- Create a Pipeline
280
+ Create a new Pipeline.
281
281
 
282
282
  :param id:
283
283
  :param conf:
@@ -367,11 +367,11 @@ class Pipelines(BaseSDK):
367
367
  timeout_ms: Optional[int] = None,
368
368
  http_headers: Optional[Mapping[str, str]] = None,
369
369
  ) -> models.GetPipelineByIDResponse:
370
- r"""Retrieve a Pipeline
370
+ r"""Get a Pipeline
371
371
 
372
- Retrieve a Pipeline
372
+ Get the specified Pipeline.
373
373
 
374
- :param id: Unique ID to GET
374
+ :param id: The <code>id</code> of the Pipeline to get.
375
375
  :param retries: Override the default retry configuration for this method
376
376
  :param server_url: Override the default server URL for this method
377
377
  :param timeout_ms: Override the default request timeout configuration for this method in milliseconds
@@ -454,11 +454,11 @@ class Pipelines(BaseSDK):
454
454
  timeout_ms: Optional[int] = None,
455
455
  http_headers: Optional[Mapping[str, str]] = None,
456
456
  ) -> models.GetPipelineByIDResponse:
457
- r"""Retrieve a Pipeline
457
+ r"""Get a Pipeline
458
458
 
459
- Retrieve a Pipeline
459
+ Get the specified Pipeline.
460
460
 
461
- :param id: Unique ID to GET
461
+ :param id: The <code>id</code> of the Pipeline to get.
462
462
  :param retries: Override the default retry configuration for this method
463
463
  :param server_url: Override the default server URL for this method
464
464
  :param timeout_ms: Override the default request timeout configuration for this method in milliseconds
@@ -545,9 +545,9 @@ class Pipelines(BaseSDK):
545
545
  ) -> models.UpdatePipelineByIDResponse:
546
546
  r"""Update a Pipeline
547
547
 
548
- Update a Pipeline
548
+ Update the specified Pipeline.</br></br>Provide a complete representation of the Pipeline that you want to update in the request body. This endpoint does not support partial updates. Cribl removes any omitted fields when updating the Pipeline.</br></br>Confirm that the configuration in your request body is correct before sending the request. If the configuration is incorrect, the updated Pipeline might not function as expected.
549
549
 
550
- :param id_param: Unique ID to PATCH
550
+ :param id_param: The <code>id</code> of the Pipeline to update.
551
551
  :param id:
552
552
  :param conf:
553
553
  :param retries: Override the default retry configuration for this method
@@ -643,9 +643,9 @@ class Pipelines(BaseSDK):
643
643
  ) -> models.UpdatePipelineByIDResponse:
644
644
  r"""Update a Pipeline
645
645
 
646
- Update a Pipeline
646
+ Update the specified Pipeline.</br></br>Provide a complete representation of the Pipeline that you want to update in the request body. This endpoint does not support partial updates. Cribl removes any omitted fields when updating the Pipeline.</br></br>Confirm that the configuration in your request body is correct before sending the request. If the configuration is incorrect, the updated Pipeline might not function as expected.
647
647
 
648
- :param id_param: Unique ID to PATCH
648
+ :param id_param: The <code>id</code> of the Pipeline to update.
649
649
  :param id:
650
650
  :param conf:
651
651
  :param retries: Override the default retry configuration for this method
@@ -739,9 +739,9 @@ class Pipelines(BaseSDK):
739
739
  ) -> models.DeletePipelineByIDResponse:
740
740
  r"""Delete a Pipeline
741
741
 
742
- Delete a Pipeline
742
+ Delete the specified Pipeline.
743
743
 
744
- :param id: Unique ID to DELETE
744
+ :param id: The <code>id</code> of the Pipeline to delete.
745
745
  :param retries: Override the default retry configuration for this method
746
746
  :param server_url: Override the default server URL for this method
747
747
  :param timeout_ms: Override the default request timeout configuration for this method in milliseconds
@@ -826,9 +826,9 @@ class Pipelines(BaseSDK):
826
826
  ) -> models.DeletePipelineByIDResponse:
827
827
  r"""Delete a Pipeline
828
828
 
829
- Delete a Pipeline
829
+ Delete the specified Pipeline.
830
830
 
831
- :param id: Unique ID to DELETE
831
+ :param id: The <code>id</code> of the Pipeline to delete.
832
832
  :param retries: Override the default retry configuration for this method
833
833
  :param server_url: Override the default server URL for this method
834
834
  :param timeout_ms: Override the default request timeout configuration for this method in milliseconds