cribl-control-plane 0.0.30__py3-none-any.whl → 0.0.32__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 (53) hide show
  1. cribl_control_plane/_version.py +3 -3
  2. cribl_control_plane/branches.py +6 -6
  3. cribl_control_plane/commits.py +216 -36
  4. cribl_control_plane/commits_files.py +16 -16
  5. cribl_control_plane/destinations.py +18 -18
  6. cribl_control_plane/destinations_pq.py +10 -10
  7. cribl_control_plane/hectokens.py +10 -10
  8. cribl_control_plane/lakedatasets.py +36 -36
  9. cribl_control_plane/models/__init__.py +19 -0
  10. cribl_control_plane/models/createcribllakedatasetbylakeidop.py +2 -2
  11. cribl_control_plane/models/createinputhectokenbyidop.py +2 -2
  12. cribl_control_plane/models/createoutputtestbyidop.py +2 -2
  13. cribl_control_plane/models/createroutesappendbyidop.py +6 -5
  14. cribl_control_plane/models/createversionundoop.py +2 -2
  15. cribl_control_plane/models/deletecribllakedatasetbylakeidandidop.py +4 -4
  16. cribl_control_plane/models/deleteinputbyidop.py +2 -2
  17. cribl_control_plane/models/deleteoutputbyidop.py +2 -2
  18. cribl_control_plane/models/deleteoutputpqbyidop.py +2 -2
  19. cribl_control_plane/models/deletepacksbyidop.py +2 -2
  20. cribl_control_plane/models/getconfiggroupaclteamsbyproductandidop.py +3 -3
  21. cribl_control_plane/models/getcribllakedatasetbylakeidandidop.py +4 -4
  22. cribl_control_plane/models/getcribllakedatasetbylakeidop.py +2 -2
  23. cribl_control_plane/models/getinputbyidop.py +2 -2
  24. cribl_control_plane/models/getmasterworkerentryop.py +2 -2
  25. cribl_control_plane/models/getoutputbyidop.py +2 -2
  26. cribl_control_plane/models/getoutputpqbyidop.py +2 -2
  27. cribl_control_plane/models/getoutputsamplesbyidop.py +2 -2
  28. cribl_control_plane/models/getpacksop.py +2 -2
  29. cribl_control_plane/models/getsummaryop.py +3 -3
  30. cribl_control_plane/models/getversioncountop.py +4 -4
  31. cribl_control_plane/models/getversiondiffop.py +8 -8
  32. cribl_control_plane/models/getversionfilesop.py +4 -4
  33. cribl_control_plane/models/getversionop.py +46 -0
  34. cribl_control_plane/models/getversionshowop.py +8 -8
  35. cribl_control_plane/models/getversionstatusop.py +2 -2
  36. cribl_control_plane/models/gitlogresult.py +33 -0
  37. cribl_control_plane/models/listmasterworkerentryop.py +23 -23
  38. cribl_control_plane/models/updatecribllakedatasetbylakeidandidop.py +4 -4
  39. cribl_control_plane/models/updateinputbyidop.py +2 -2
  40. cribl_control_plane/models/updateinputhectokenbyidandtokenop.py +4 -4
  41. cribl_control_plane/models/updateoutputbyidop.py +2 -2
  42. cribl_control_plane/models/updatepacksbyidop.py +2 -2
  43. cribl_control_plane/nodes.py +30 -30
  44. cribl_control_plane/packs.py +16 -16
  45. cribl_control_plane/samples.py +10 -10
  46. cribl_control_plane/sources.py +18 -18
  47. cribl_control_plane/statuses.py +6 -6
  48. cribl_control_plane/summaries.py +6 -6
  49. cribl_control_plane/teams.py +2 -2
  50. cribl_control_plane/versions_configs.py +4 -4
  51. {cribl_control_plane-0.0.30.dist-info → cribl_control_plane-0.0.32.dist-info}/METADATA +24 -23
  52. {cribl_control_plane-0.0.30.dist-info → cribl_control_plane-0.0.32.dist-info}/RECORD +53 -51
  53. {cribl_control_plane-0.0.30.dist-info → cribl_control_plane-0.0.32.dist-info}/WHEEL +0 -0
@@ -30,9 +30,9 @@ class HecTokens(BaseSDK):
30
30
  ) -> models.CreateInputHecTokenByIDResponse:
31
31
  r"""Add an HEC token and optional metadata to a Splunk HEC Source
32
32
 
33
- Add token and optional metadata to an existing HEC Source
33
+ Add an HEC token and optional metadata to the specified Splunk HEC Source.
34
34
 
35
- :param id: HEC Source id
35
+ :param id: The <code>id</code> of the Splunk HEC Source.
36
36
  :param token:
37
37
  :param description:
38
38
  :param enabled:
@@ -147,9 +147,9 @@ class HecTokens(BaseSDK):
147
147
  ) -> models.CreateInputHecTokenByIDResponse:
148
148
  r"""Add an HEC token and optional metadata to a Splunk HEC Source
149
149
 
150
- Add token and optional metadata to an existing HEC Source
150
+ Add an HEC token and optional metadata to the specified Splunk HEC Source.
151
151
 
152
- :param id: HEC Source id
152
+ :param id: The <code>id</code> of the Splunk HEC Source.
153
153
  :param token:
154
154
  :param description:
155
155
  :param enabled:
@@ -264,10 +264,10 @@ class HecTokens(BaseSDK):
264
264
  ) -> models.UpdateInputHecTokenByIDAndTokenResponse:
265
265
  r"""Update metadata for an HEC token for a Splunk HEC Source
266
266
 
267
- Update token metadata on existing HEC Source
267
+ Update the metadata for the specified HEC token for the specified Splunk HEC Source.
268
268
 
269
- :param id: HEC Source id
270
- :param token: token to update
269
+ :param id: The <code>id</code> of the Splunk HEC Source.
270
+ :param token: The <code>id</code> of the HEC token to update.
271
271
  :param description:
272
272
  :param enabled:
273
273
  :param metadata:
@@ -381,10 +381,10 @@ class HecTokens(BaseSDK):
381
381
  ) -> models.UpdateInputHecTokenByIDAndTokenResponse:
382
382
  r"""Update metadata for an HEC token for a Splunk HEC Source
383
383
 
384
- Update token metadata on existing HEC Source
384
+ Update the metadata for the specified HEC token for the specified Splunk HEC Source.
385
385
 
386
- :param id: HEC Source id
387
- :param token: token to update
386
+ :param id: The <code>id</code> of the Splunk HEC Source.
387
+ :param token: The <code>id</code> of the HEC token to update.
388
388
  :param description:
389
389
  :param enabled:
390
390
  :param metadata:
@@ -37,11 +37,11 @@ class LakeDatasets(BaseSDK):
37
37
  timeout_ms: Optional[int] = None,
38
38
  http_headers: Optional[Mapping[str, str]] = None,
39
39
  ) -> models.CreateCriblLakeDatasetByLakeIDResponse:
40
- r"""Create a Lake Dataset in the specified Lake
40
+ r"""Create a Lake Dataset
41
41
 
42
- Create a Dataset in the specified Lake
42
+ Create a new Lake Dataset in the specified Lake.
43
43
 
44
- :param lake_id: lake id that contains the Datasets
44
+ :param lake_id: The <code>id</code> of the Lake to create the Lake Dataset in.
45
45
  :param id:
46
46
  :param accelerated_fields:
47
47
  :param bucket_name:
@@ -181,11 +181,11 @@ class LakeDatasets(BaseSDK):
181
181
  timeout_ms: Optional[int] = None,
182
182
  http_headers: Optional[Mapping[str, str]] = None,
183
183
  ) -> models.CreateCriblLakeDatasetByLakeIDResponse:
184
- r"""Create a Lake Dataset in the specified Lake
184
+ r"""Create a Lake Dataset
185
185
 
186
- Create a Dataset in the specified Lake
186
+ Create a new Lake Dataset in the specified Lake.
187
187
 
188
- :param lake_id: lake id that contains the Datasets
188
+ :param lake_id: The <code>id</code> of the Lake to create the Lake Dataset in.
189
189
  :param id:
190
190
  :param accelerated_fields:
191
191
  :param bucket_name:
@@ -307,11 +307,11 @@ class LakeDatasets(BaseSDK):
307
307
  timeout_ms: Optional[int] = None,
308
308
  http_headers: Optional[Mapping[str, str]] = None,
309
309
  ) -> models.GetCriblLakeDatasetByLakeIDResponse:
310
- r"""List all Lake Datasets in the specified Lake
310
+ r"""List all Lake Datasets
311
311
 
312
- Get the list of Dataset contained in the specified Lake
312
+ Get a list of all Lake Datasets in the specified Lake.
313
313
 
314
- :param lake_id: lake id that contains the Datasets
314
+ :param lake_id: The <code>id</code> of the Lake that contains the Lake Datasets to list.
315
315
  :param retries: Override the default retry configuration for this method
316
316
  :param server_url: Override the default server URL for this method
317
317
  :param timeout_ms: Override the default request timeout configuration for this method in milliseconds
@@ -396,11 +396,11 @@ class LakeDatasets(BaseSDK):
396
396
  timeout_ms: Optional[int] = None,
397
397
  http_headers: Optional[Mapping[str, str]] = None,
398
398
  ) -> models.GetCriblLakeDatasetByLakeIDResponse:
399
- r"""List all Lake Datasets in the specified Lake
399
+ r"""List all Lake Datasets
400
400
 
401
- Get the list of Dataset contained in the specified Lake
401
+ Get a list of all Lake Datasets in the specified Lake.
402
402
 
403
- :param lake_id: lake id that contains the Datasets
403
+ :param lake_id: The <code>id</code> of the Lake that contains the Lake Datasets to list.
404
404
  :param retries: Override the default retry configuration for this method
405
405
  :param server_url: Override the default server URL for this method
406
406
  :param timeout_ms: Override the default request timeout configuration for this method in milliseconds
@@ -486,12 +486,12 @@ class LakeDatasets(BaseSDK):
486
486
  timeout_ms: Optional[int] = None,
487
487
  http_headers: Optional[Mapping[str, str]] = None,
488
488
  ) -> models.DeleteCriblLakeDatasetByLakeIDAndIDResponse:
489
- r"""Delete a Lake Dataset in the specified Lake
489
+ r"""Delete a Lake Dataset
490
490
 
491
- Delete a Dataset in the specified Lake
491
+ Delete the specified Lake Dataset in the specified Lake
492
492
 
493
- :param lake_id: lake id that contains the Datasets
494
- :param id: dataset id to delete
493
+ :param lake_id: The <code>id</code> of the Lake that contains the Lake Dataset to delete.
494
+ :param id: The <code>id</code> of the Lake Dataset to delete.
495
495
  :param retries: Override the default retry configuration for this method
496
496
  :param server_url: Override the default server URL for this method
497
497
  :param timeout_ms: Override the default request timeout configuration for this method in milliseconds
@@ -578,12 +578,12 @@ class LakeDatasets(BaseSDK):
578
578
  timeout_ms: Optional[int] = None,
579
579
  http_headers: Optional[Mapping[str, str]] = None,
580
580
  ) -> models.DeleteCriblLakeDatasetByLakeIDAndIDResponse:
581
- r"""Delete a Lake Dataset in the specified Lake
581
+ r"""Delete a Lake Dataset
582
582
 
583
- Delete a Dataset in the specified Lake
583
+ Delete the specified Lake Dataset in the specified Lake
584
584
 
585
- :param lake_id: lake id that contains the Datasets
586
- :param id: dataset id to delete
585
+ :param lake_id: The <code>id</code> of the Lake that contains the Lake Dataset to delete.
586
+ :param id: The <code>id</code> of the Lake Dataset to delete.
587
587
  :param retries: Override the default retry configuration for this method
588
588
  :param server_url: Override the default server URL for this method
589
589
  :param timeout_ms: Override the default request timeout configuration for this method in milliseconds
@@ -670,12 +670,12 @@ class LakeDatasets(BaseSDK):
670
670
  timeout_ms: Optional[int] = None,
671
671
  http_headers: Optional[Mapping[str, str]] = None,
672
672
  ) -> models.GetCriblLakeDatasetByLakeIDAndIDResponse:
673
- r"""Retrieve a Lake Dataset in the specified Lake
673
+ r"""Get a Lake Dataset
674
674
 
675
- Get a Dataset in the specified Lake
675
+ Get the specified Lake Dataset in the specified Lake.
676
676
 
677
- :param lake_id: lake id that contains the Datasets
678
- :param id: dataset id to get
677
+ :param lake_id: The <code>id</code> of the Lake that contains the Lake Dataset to get.
678
+ :param id: The <code>id</code> of the Lake Dataset to get.
679
679
  :param retries: Override the default retry configuration for this method
680
680
  :param server_url: Override the default server URL for this method
681
681
  :param timeout_ms: Override the default request timeout configuration for this method in milliseconds
@@ -762,12 +762,12 @@ class LakeDatasets(BaseSDK):
762
762
  timeout_ms: Optional[int] = None,
763
763
  http_headers: Optional[Mapping[str, str]] = None,
764
764
  ) -> models.GetCriblLakeDatasetByLakeIDAndIDResponse:
765
- r"""Retrieve a Lake Dataset in the specified Lake
765
+ r"""Get a Lake Dataset
766
766
 
767
- Get a Dataset in the specified Lake
767
+ Get the specified Lake Dataset in the specified Lake.
768
768
 
769
- :param lake_id: lake id that contains the Datasets
770
- :param id: dataset id to get
769
+ :param lake_id: The <code>id</code> of the Lake that contains the Lake Dataset to get.
770
+ :param id: The <code>id</code> of the Lake Dataset to get.
771
771
  :param retries: Override the default retry configuration for this method
772
772
  :param server_url: Override the default server URL for this method
773
773
  :param timeout_ms: Override the default request timeout configuration for this method in milliseconds
@@ -872,12 +872,12 @@ class LakeDatasets(BaseSDK):
872
872
  timeout_ms: Optional[int] = None,
873
873
  http_headers: Optional[Mapping[str, str]] = None,
874
874
  ) -> models.UpdateCriblLakeDatasetByLakeIDAndIDResponse:
875
- r"""Update a Lake Dataset in the specified Lake
875
+ r"""Update a Lake Dataset
876
876
 
877
- Update a Dataset in the specified Lake
877
+ Update the specified Lake Dataset in the specified Lake.
878
878
 
879
- :param lake_id: lake id that contains the Datasets
880
- :param id_param: dataset id to update
879
+ :param lake_id: The <code>id</code> of the Lake that contains the Lake Dataset to update.
880
+ :param id_param: The <code>id</code> of the Lake Dataset to update.
881
881
  :param id:
882
882
  :param accelerated_fields:
883
883
  :param bucket_name:
@@ -1019,12 +1019,12 @@ class LakeDatasets(BaseSDK):
1019
1019
  timeout_ms: Optional[int] = None,
1020
1020
  http_headers: Optional[Mapping[str, str]] = None,
1021
1021
  ) -> models.UpdateCriblLakeDatasetByLakeIDAndIDResponse:
1022
- r"""Update a Lake Dataset in the specified Lake
1022
+ r"""Update a Lake Dataset
1023
1023
 
1024
- Update a Dataset in the specified Lake
1024
+ Update the specified Lake Dataset in the specified Lake.
1025
1025
 
1026
- :param lake_id: lake id that contains the Datasets
1027
- :param id_param: dataset id to update
1026
+ :param lake_id: The <code>id</code> of the Lake that contains the Lake Dataset to update.
1027
+ :param id_param: The <code>id</code> of the Lake Dataset to update.
1028
1028
  :param id:
1029
1029
  :param accelerated_fields:
1030
1030
  :param bucket_name:
@@ -282,6 +282,12 @@ if TYPE_CHECKING:
282
282
  GetVersionInfoResponse,
283
283
  GetVersionInfoResponseTypedDict,
284
284
  )
285
+ from .getversionop import (
286
+ GetVersionRequest,
287
+ GetVersionRequestTypedDict,
288
+ GetVersionResponse,
289
+ GetVersionResponseTypedDict,
290
+ )
285
291
  from .getversionshowop import (
286
292
  GetVersionShowRequest,
287
293
  GetVersionShowRequestTypedDict,
@@ -308,6 +314,7 @@ if TYPE_CHECKING:
308
314
  from .gitfile import GitFile, GitFileTypedDict
309
315
  from .gitfilesresponse import GitFilesResponse, GitFilesResponseTypedDict
310
316
  from .gitinfo import GitInfo, GitInfoTypedDict, Remote, RemoteTypedDict
317
+ from .gitlogresult import GitLogResult, GitLogResultTypedDict
311
318
  from .gitrevertparams import GitRevertParams, GitRevertParamsTypedDict
312
319
  from .gitrevertresult import (
313
320
  Audit,
@@ -3284,6 +3291,10 @@ __all__ = [
3284
3291
  "GetVersionFilesResponseTypedDict",
3285
3292
  "GetVersionInfoResponse",
3286
3293
  "GetVersionInfoResponseTypedDict",
3294
+ "GetVersionRequest",
3295
+ "GetVersionRequestTypedDict",
3296
+ "GetVersionResponse",
3297
+ "GetVersionResponseTypedDict",
3287
3298
  "GetVersionShowRequest",
3288
3299
  "GetVersionShowRequestTypedDict",
3289
3300
  "GetVersionShowResponse",
@@ -3305,6 +3316,8 @@ __all__ = [
3305
3316
  "GitFilesResponseTypedDict",
3306
3317
  "GitInfo",
3307
3318
  "GitInfoTypedDict",
3319
+ "GitLogResult",
3320
+ "GitLogResultTypedDict",
3308
3321
  "GitRevertParams",
3309
3322
  "GitRevertParamsTypedDict",
3310
3323
  "GitRevertResult",
@@ -5908,6 +5921,10 @@ _dynamic_imports: dict[str, str] = {
5908
5921
  "GetVersionFilesResponseTypedDict": ".getversionfilesop",
5909
5922
  "GetVersionInfoResponse": ".getversioninfoop",
5910
5923
  "GetVersionInfoResponseTypedDict": ".getversioninfoop",
5924
+ "GetVersionRequest": ".getversionop",
5925
+ "GetVersionRequestTypedDict": ".getversionop",
5926
+ "GetVersionResponse": ".getversionop",
5927
+ "GetVersionResponseTypedDict": ".getversionop",
5911
5928
  "GetVersionShowRequest": ".getversionshowop",
5912
5929
  "GetVersionShowRequestTypedDict": ".getversionshowop",
5913
5930
  "GetVersionShowResponse": ".getversionshowop",
@@ -5934,6 +5951,8 @@ _dynamic_imports: dict[str, str] = {
5934
5951
  "GitInfoTypedDict": ".gitinfo",
5935
5952
  "Remote": ".gitinfo",
5936
5953
  "RemoteTypedDict": ".gitinfo",
5954
+ "GitLogResult": ".gitlogresult",
5955
+ "GitLogResultTypedDict": ".gitlogresult",
5937
5956
  "GitRevertParams": ".gitrevertparams",
5938
5957
  "GitRevertParamsTypedDict": ".gitrevertparams",
5939
5958
  "Audit": ".gitrevertresult",
@@ -11,7 +11,7 @@ from typing_extensions import Annotated, NotRequired, TypedDict
11
11
 
12
12
  class CreateCriblLakeDatasetByLakeIDRequestTypedDict(TypedDict):
13
13
  lake_id: str
14
- r"""lake id that contains the Datasets"""
14
+ r"""The <code>id</code> of the Lake to create the Lake Dataset in."""
15
15
  cribl_lake_dataset: CriblLakeDatasetTypedDict
16
16
  r"""CriblLakeDataset object"""
17
17
 
@@ -22,7 +22,7 @@ class CreateCriblLakeDatasetByLakeIDRequest(BaseModel):
22
22
  pydantic.Field(alias="lakeId"),
23
23
  FieldMetadata(path=PathParamMetadata(style="simple", explode=False)),
24
24
  ]
25
- r"""lake id that contains the Datasets"""
25
+ r"""The <code>id</code> of the Lake to create the Lake Dataset in."""
26
26
 
27
27
  cribl_lake_dataset: Annotated[
28
28
  CriblLakeDataset,
@@ -10,7 +10,7 @@ from typing_extensions import Annotated, NotRequired, TypedDict
10
10
 
11
11
  class CreateInputHecTokenByIDRequestTypedDict(TypedDict):
12
12
  id: str
13
- r"""HEC Source id"""
13
+ r"""The <code>id</code> of the Splunk HEC Source."""
14
14
  add_hec_token_request: AddHecTokenRequestTypedDict
15
15
  r"""AddHecTokenRequest object"""
16
16
 
@@ -19,7 +19,7 @@ class CreateInputHecTokenByIDRequest(BaseModel):
19
19
  id: Annotated[
20
20
  str, FieldMetadata(path=PathParamMetadata(style="simple", explode=False))
21
21
  ]
22
- r"""HEC Source id"""
22
+ r"""The <code>id</code> of the Splunk HEC Source."""
23
23
 
24
24
  add_hec_token_request: Annotated[
25
25
  AddHecTokenRequest,
@@ -11,7 +11,7 @@ from typing_extensions import Annotated, NotRequired, TypedDict
11
11
 
12
12
  class CreateOutputTestByIDRequestTypedDict(TypedDict):
13
13
  id: str
14
- r"""Destination Id"""
14
+ r"""The <code>id</code> of the Destination to send sample event data to."""
15
15
  output_test_request: OutputTestRequestTypedDict
16
16
  r"""OutputTestRequest object"""
17
17
 
@@ -20,7 +20,7 @@ class CreateOutputTestByIDRequest(BaseModel):
20
20
  id: Annotated[
21
21
  str, FieldMetadata(path=PathParamMetadata(style="simple", explode=False))
22
22
  ]
23
- r"""Destination Id"""
23
+ r"""The <code>id</code> of the Destination to send sample event data to."""
24
24
 
25
25
  output_test_request: Annotated[
26
26
  OutputTestRequest,
@@ -2,9 +2,10 @@
2
2
 
3
3
  from __future__ import annotations
4
4
  from .routeconf import RouteConf, RouteConfTypedDict
5
+ from .routes import Routes, RoutesTypedDict
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
 
@@ -29,17 +30,17 @@ class CreateRoutesAppendByIDRequest(BaseModel):
29
30
 
30
31
 
31
32
  class CreateRoutesAppendByIDResponseTypedDict(TypedDict):
32
- r"""a list of any objects"""
33
+ r"""a list of Routes objects"""
33
34
 
34
35
  count: NotRequired[int]
35
36
  r"""number of items present in the items array"""
36
- items: NotRequired[List[Dict[str, Any]]]
37
+ items: NotRequired[List[RoutesTypedDict]]
37
38
 
38
39
 
39
40
  class CreateRoutesAppendByIDResponse(BaseModel):
40
- r"""a list of any objects"""
41
+ r"""a list of Routes objects"""
41
42
 
42
43
  count: Optional[int] = None
43
44
  r"""number of items present in the items array"""
44
45
 
45
- items: Optional[List[Dict[str, Any]]] = None
46
+ items: Optional[List[Routes]] = None
@@ -9,7 +9,7 @@ from typing_extensions import Annotated, NotRequired, TypedDict
9
9
 
10
10
  class CreateVersionUndoRequestTypedDict(TypedDict):
11
11
  group: NotRequired[str]
12
- r"""Group ID"""
12
+ r"""The <code>id</code> of the Worker Group or Edge Fleet to undo the uncommited changes for."""
13
13
 
14
14
 
15
15
  class CreateVersionUndoRequest(BaseModel):
@@ -17,7 +17,7 @@ class CreateVersionUndoRequest(BaseModel):
17
17
  Optional[str],
18
18
  FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
19
19
  ] = None
20
- r"""Group ID"""
20
+ r"""The <code>id</code> of the Worker Group or Edge Fleet to undo the uncommited changes for."""
21
21
 
22
22
 
23
23
  class CreateVersionUndoResponseTypedDict(TypedDict):
@@ -11,9 +11,9 @@ from typing_extensions import Annotated, NotRequired, TypedDict
11
11
 
12
12
  class DeleteCriblLakeDatasetByLakeIDAndIDRequestTypedDict(TypedDict):
13
13
  lake_id: str
14
- r"""lake id that contains the Datasets"""
14
+ r"""The <code>id</code> of the Lake that contains the Lake Dataset to delete."""
15
15
  id: str
16
- r"""dataset id to delete"""
16
+ r"""The <code>id</code> of the Lake Dataset to delete."""
17
17
 
18
18
 
19
19
  class DeleteCriblLakeDatasetByLakeIDAndIDRequest(BaseModel):
@@ -22,12 +22,12 @@ class DeleteCriblLakeDatasetByLakeIDAndIDRequest(BaseModel):
22
22
  pydantic.Field(alias="lakeId"),
23
23
  FieldMetadata(path=PathParamMetadata(style="simple", explode=False)),
24
24
  ]
25
- r"""lake id that contains the Datasets"""
25
+ r"""The <code>id</code> of the Lake that contains the Lake Dataset to delete."""
26
26
 
27
27
  id: Annotated[
28
28
  str, FieldMetadata(path=PathParamMetadata(style="simple", explode=False))
29
29
  ]
30
- r"""dataset id to delete"""
30
+ r"""The <code>id</code> of the Lake Dataset to delete."""
31
31
 
32
32
 
33
33
  class DeleteCriblLakeDatasetByLakeIDAndIDResponseTypedDict(TypedDict):
@@ -10,14 +10,14 @@ from typing_extensions import Annotated, NotRequired, TypedDict
10
10
 
11
11
  class DeleteInputByIDRequestTypedDict(TypedDict):
12
12
  id: str
13
- r"""Unique ID to DELETE"""
13
+ r"""The <code>id</code> of the Source to delete."""
14
14
 
15
15
 
16
16
  class DeleteInputByIDRequest(BaseModel):
17
17
  id: Annotated[
18
18
  str, FieldMetadata(path=PathParamMetadata(style="simple", explode=False))
19
19
  ]
20
- r"""Unique ID to DELETE"""
20
+ r"""The <code>id</code> of the Source to delete."""
21
21
 
22
22
 
23
23
  class DeleteInputByIDResponseTypedDict(TypedDict):
@@ -10,14 +10,14 @@ from typing_extensions import Annotated, NotRequired, TypedDict
10
10
 
11
11
  class DeleteOutputByIDRequestTypedDict(TypedDict):
12
12
  id: str
13
- r"""Unique ID to DELETE"""
13
+ r"""The <code>id</code> of the Destination to delete."""
14
14
 
15
15
 
16
16
  class DeleteOutputByIDRequest(BaseModel):
17
17
  id: Annotated[
18
18
  str, FieldMetadata(path=PathParamMetadata(style="simple", explode=False))
19
19
  ]
20
- r"""Unique ID to DELETE"""
20
+ r"""The <code>id</code> of the Destination to delete."""
21
21
 
22
22
 
23
23
  class DeleteOutputByIDResponseTypedDict(TypedDict):
@@ -9,14 +9,14 @@ from typing_extensions import Annotated, NotRequired, TypedDict
9
9
 
10
10
  class DeleteOutputPqByIDRequestTypedDict(TypedDict):
11
11
  id: str
12
- r"""Destination Id"""
12
+ r"""The <code>id</code> of the Destination to clear the PQ for."""
13
13
 
14
14
 
15
15
  class DeleteOutputPqByIDRequest(BaseModel):
16
16
  id: Annotated[
17
17
  str, FieldMetadata(path=PathParamMetadata(style="simple", explode=False))
18
18
  ]
19
- r"""Destination Id"""
19
+ r"""The <code>id</code> of the Destination to clear the PQ for."""
20
20
 
21
21
 
22
22
  class DeleteOutputPqByIDResponseTypedDict(TypedDict):
@@ -10,14 +10,14 @@ from typing_extensions import Annotated, NotRequired, TypedDict
10
10
 
11
11
  class DeletePacksByIDRequestTypedDict(TypedDict):
12
12
  id: str
13
- r"""Pack name"""
13
+ r"""The <code>id</code> of the Pack to uninstall."""
14
14
 
15
15
 
16
16
  class DeletePacksByIDRequest(BaseModel):
17
17
  id: Annotated[
18
18
  str, FieldMetadata(path=PathParamMetadata(style="simple", explode=False))
19
19
  ]
20
- r"""Pack name"""
20
+ r"""The <code>id</code> of the Pack to uninstall."""
21
21
 
22
22
 
23
23
  class DeletePacksByIDResponseTypedDict(TypedDict):
@@ -21,7 +21,7 @@ class GetConfigGroupACLTeamsByProductAndIDProduct(str, Enum):
21
21
 
22
22
 
23
23
  class GetConfigGroupACLTeamsByProductAndIDType(str, Enum):
24
- r"""resource type by which to filter access levels"""
24
+ r"""Filter for limiting the response to ACL entries for the specified RBAC resource type."""
25
25
 
26
26
  GROUPS = "groups"
27
27
  DATASETS = "datasets"
@@ -39,7 +39,7 @@ class GetConfigGroupACLTeamsByProductAndIDRequestTypedDict(TypedDict):
39
39
  id: str
40
40
  r"""The <code>id</code> of the Worker Group or Edge Fleet to get the team ACL for."""
41
41
  type: NotRequired[GetConfigGroupACLTeamsByProductAndIDType]
42
- r"""resource type by which to filter access levels"""
42
+ r"""Filter for limiting the response to ACL entries for the specified RBAC resource type."""
43
43
 
44
44
 
45
45
  class GetConfigGroupACLTeamsByProductAndIDRequest(BaseModel):
@@ -58,7 +58,7 @@ class GetConfigGroupACLTeamsByProductAndIDRequest(BaseModel):
58
58
  Optional[GetConfigGroupACLTeamsByProductAndIDType],
59
59
  FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
60
60
  ] = None
61
- r"""resource type by which to filter access levels"""
61
+ r"""Filter for limiting the response to ACL entries for the specified RBAC resource type."""
62
62
 
63
63
 
64
64
  class GetConfigGroupACLTeamsByProductAndIDResponseTypedDict(TypedDict):
@@ -11,9 +11,9 @@ from typing_extensions import Annotated, NotRequired, TypedDict
11
11
 
12
12
  class GetCriblLakeDatasetByLakeIDAndIDRequestTypedDict(TypedDict):
13
13
  lake_id: str
14
- r"""lake id that contains the Datasets"""
14
+ r"""The <code>id</code> of the Lake that contains the Lake Dataset to get."""
15
15
  id: str
16
- r"""dataset id to get"""
16
+ r"""The <code>id</code> of the Lake Dataset to get."""
17
17
 
18
18
 
19
19
  class GetCriblLakeDatasetByLakeIDAndIDRequest(BaseModel):
@@ -22,12 +22,12 @@ class GetCriblLakeDatasetByLakeIDAndIDRequest(BaseModel):
22
22
  pydantic.Field(alias="lakeId"),
23
23
  FieldMetadata(path=PathParamMetadata(style="simple", explode=False)),
24
24
  ]
25
- r"""lake id that contains the Datasets"""
25
+ r"""The <code>id</code> of the Lake that contains the Lake Dataset to get."""
26
26
 
27
27
  id: Annotated[
28
28
  str, FieldMetadata(path=PathParamMetadata(style="simple", explode=False))
29
29
  ]
30
- r"""dataset id to get"""
30
+ r"""The <code>id</code> of the Lake Dataset to get."""
31
31
 
32
32
 
33
33
  class GetCriblLakeDatasetByLakeIDAndIDResponseTypedDict(TypedDict):
@@ -11,7 +11,7 @@ from typing_extensions import Annotated, NotRequired, TypedDict
11
11
 
12
12
  class GetCriblLakeDatasetByLakeIDRequestTypedDict(TypedDict):
13
13
  lake_id: str
14
- r"""lake id that contains the Datasets"""
14
+ r"""The <code>id</code> of the Lake that contains the Lake Datasets to list."""
15
15
 
16
16
 
17
17
  class GetCriblLakeDatasetByLakeIDRequest(BaseModel):
@@ -20,7 +20,7 @@ class GetCriblLakeDatasetByLakeIDRequest(BaseModel):
20
20
  pydantic.Field(alias="lakeId"),
21
21
  FieldMetadata(path=PathParamMetadata(style="simple", explode=False)),
22
22
  ]
23
- r"""lake id that contains the Datasets"""
23
+ r"""The <code>id</code> of the Lake that contains the Lake Datasets to list."""
24
24
 
25
25
 
26
26
  class GetCriblLakeDatasetByLakeIDResponseTypedDict(TypedDict):
@@ -10,14 +10,14 @@ from typing_extensions import Annotated, NotRequired, TypedDict
10
10
 
11
11
  class GetInputByIDRequestTypedDict(TypedDict):
12
12
  id: str
13
- r"""Unique ID to GET"""
13
+ r"""The <code>id</code> of the Source to get."""
14
14
 
15
15
 
16
16
  class GetInputByIDRequest(BaseModel):
17
17
  id: Annotated[
18
18
  str, FieldMetadata(path=PathParamMetadata(style="simple", explode=False))
19
19
  ]
20
- r"""Unique ID to GET"""
20
+ r"""The <code>id</code> of the Source to get."""
21
21
 
22
22
 
23
23
  class GetInputByIDResponseTypedDict(TypedDict):
@@ -10,7 +10,7 @@ from typing_extensions import Annotated, NotRequired, TypedDict
10
10
 
11
11
  class GetMasterWorkerEntryRequestTypedDict(TypedDict):
12
12
  filter_exp: NotRequired[str]
13
- r"""Filter expression evaluated against nodes"""
13
+ r"""Filter expression to evaluate against Nodes for inclusion in the response."""
14
14
 
15
15
 
16
16
  class GetMasterWorkerEntryRequest(BaseModel):
@@ -19,7 +19,7 @@ class GetMasterWorkerEntryRequest(BaseModel):
19
19
  pydantic.Field(alias="filterExp"),
20
20
  FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
21
21
  ] = None
22
- r"""Filter expression evaluated against nodes"""
22
+ r"""Filter expression to evaluate against Nodes for inclusion in the response."""
23
23
 
24
24
 
25
25
  class GetMasterWorkerEntryResponseTypedDict(TypedDict):
@@ -10,14 +10,14 @@ from typing_extensions import Annotated, NotRequired, TypedDict
10
10
 
11
11
  class GetOutputByIDRequestTypedDict(TypedDict):
12
12
  id: str
13
- r"""Unique ID to GET"""
13
+ r"""The <code>id</code> of the Destination to get."""
14
14
 
15
15
 
16
16
  class GetOutputByIDRequest(BaseModel):
17
17
  id: Annotated[
18
18
  str, FieldMetadata(path=PathParamMetadata(style="simple", explode=False))
19
19
  ]
20
- r"""Unique ID to GET"""
20
+ r"""The <code>id</code> of the Destination to get."""
21
21
 
22
22
 
23
23
  class GetOutputByIDResponseTypedDict(TypedDict):
@@ -9,14 +9,14 @@ from typing_extensions import Annotated, NotRequired, TypedDict
9
9
 
10
10
  class GetOutputPqByIDRequestTypedDict(TypedDict):
11
11
  id: str
12
- r"""Destination Id"""
12
+ r"""The <code>id</code> of the Destination to get PQ job information for."""
13
13
 
14
14
 
15
15
  class GetOutputPqByIDRequest(BaseModel):
16
16
  id: Annotated[
17
17
  str, FieldMetadata(path=PathParamMetadata(style="simple", explode=False))
18
18
  ]
19
- r"""Destination Id"""
19
+ r"""The <code>id</code> of the Destination to get PQ job information for."""
20
20
 
21
21
 
22
22
  class GetOutputPqByIDResponseTypedDict(TypedDict):