cribl-control-plane 0.0.31__py3-none-any.whl → 0.0.33__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 (79) hide show
  1. cribl_control_plane/_version.py +4 -4
  2. cribl_control_plane/branches.py +6 -6
  3. cribl_control_plane/commits.py +36 -36
  4. cribl_control_plane/commits_files.py +16 -16
  5. cribl_control_plane/cribl.py +513 -0
  6. cribl_control_plane/destinations.py +21 -21
  7. cribl_control_plane/destinations_pq.py +10 -10
  8. cribl_control_plane/{samples.py → destinations_samples.py} +11 -11
  9. cribl_control_plane/hectokens.py +10 -10
  10. cribl_control_plane/lakedatasets.py +36 -36
  11. cribl_control_plane/models/__init__.py +342 -0
  12. cribl_control_plane/models/authconfig.py +43 -0
  13. cribl_control_plane/models/commonservicelimitconfigs.py +14 -0
  14. cribl_control_plane/models/createcribllakedatasetbylakeidop.py +2 -2
  15. cribl_control_plane/models/createinputhectokenbyidop.py +2 -2
  16. cribl_control_plane/models/createoutputtestbyidop.py +2 -2
  17. cribl_control_plane/models/createversionundoop.py +2 -2
  18. cribl_control_plane/models/deletecribllakedatasetbylakeidandidop.py +4 -4
  19. cribl_control_plane/models/deleteinputbyidop.py +2 -2
  20. cribl_control_plane/models/deleteoutputbyidop.py +2 -2
  21. cribl_control_plane/models/deleteoutputpqbyidop.py +2 -2
  22. cribl_control_plane/models/deletepacksbyidop.py +2 -2
  23. cribl_control_plane/models/edgeheartbeatmetricsmode.py +11 -0
  24. cribl_control_plane/models/getconfiggroupaclteamsbyproductandidop.py +3 -3
  25. cribl_control_plane/models/getcribllakedatasetbylakeidandidop.py +4 -4
  26. cribl_control_plane/models/getcribllakedatasetbylakeidop.py +2 -2
  27. cribl_control_plane/models/getinputbyidop.py +2 -2
  28. cribl_control_plane/models/getmasterworkerentryop.py +2 -2
  29. cribl_control_plane/models/getoutputbyidop.py +2 -2
  30. cribl_control_plane/models/getoutputpqbyidop.py +2 -2
  31. cribl_control_plane/models/getoutputsamplesbyidop.py +2 -2
  32. cribl_control_plane/models/getpacksop.py +2 -2
  33. cribl_control_plane/models/getsummaryop.py +3 -3
  34. cribl_control_plane/models/getsystemsettingsauthop.py +24 -0
  35. cribl_control_plane/models/getsystemsettingsconfop.py +24 -0
  36. cribl_control_plane/models/getsystemsettingsgitsettingsop.py +24 -0
  37. cribl_control_plane/models/getversioncountop.py +4 -4
  38. cribl_control_plane/models/getversiondiffop.py +8 -8
  39. cribl_control_plane/models/getversionfilesop.py +4 -4
  40. cribl_control_plane/models/getversionshowop.py +8 -8
  41. cribl_control_plane/models/getversionstatusop.py +2 -2
  42. cribl_control_plane/models/gitopstype.py +10 -0
  43. cribl_control_plane/models/gitsettings.py +70 -0
  44. cribl_control_plane/models/jobsettings.py +83 -0
  45. cribl_control_plane/models/limits.py +127 -0
  46. cribl_control_plane/models/listmasterworkerentryop.py +23 -23
  47. cribl_control_plane/models/rediscachelimits.py +38 -0
  48. cribl_control_plane/models/redisconnectionlimits.py +20 -0
  49. cribl_control_plane/models/redislimits.py +14 -0
  50. cribl_control_plane/models/searchsettings.py +71 -0
  51. cribl_control_plane/models/serviceslimits.py +23 -0
  52. cribl_control_plane/models/systemsettings.py +358 -0
  53. cribl_control_plane/models/systemsettingsconf.py +311 -0
  54. cribl_control_plane/models/updatecribllakedatasetbylakeidandidop.py +4 -4
  55. cribl_control_plane/models/updateinputbyidop.py +2 -2
  56. cribl_control_plane/models/updateinputhectokenbyidandtokenop.py +4 -4
  57. cribl_control_plane/models/updateoutputbyidop.py +2 -2
  58. cribl_control_plane/models/updatepacksbyidop.py +2 -2
  59. cribl_control_plane/models/updatesystemsettingsauthop.py +24 -0
  60. cribl_control_plane/models/updatesystemsettingsconfop.py +24 -0
  61. cribl_control_plane/models/updatesystemsettingsgitsettingsop.py +24 -0
  62. cribl_control_plane/models/upgradegroupsettings.py +24 -0
  63. cribl_control_plane/models/upgradepackageurls.py +20 -0
  64. cribl_control_plane/models/upgradesettings.py +36 -0
  65. cribl_control_plane/nodes.py +30 -30
  66. cribl_control_plane/packs.py +16 -16
  67. cribl_control_plane/sdk.py +3 -0
  68. cribl_control_plane/settings.py +23 -0
  69. cribl_control_plane/settings_auth.py +339 -0
  70. cribl_control_plane/settings_git.py +339 -0
  71. cribl_control_plane/sources.py +18 -18
  72. cribl_control_plane/statuses.py +6 -6
  73. cribl_control_plane/summaries.py +6 -6
  74. cribl_control_plane/system_sdk.py +17 -0
  75. cribl_control_plane/teams.py +2 -2
  76. cribl_control_plane/versions_configs.py +4 -4
  77. {cribl_control_plane-0.0.31.dist-info → cribl_control_plane-0.0.33.dist-info}/METADATA +41 -25
  78. {cribl_control_plane-0.0.31.dist-info → cribl_control_plane-0.0.33.dist-info}/RECORD +79 -51
  79. {cribl_control_plane-0.0.31.dist-info → cribl_control_plane-0.0.33.dist-info}/WHEEL +0 -0
@@ -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,
@@ -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):
@@ -0,0 +1,11 @@
1
+ """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
2
+
3
+ from __future__ import annotations
4
+ from enum import Enum
5
+
6
+
7
+ class EdgeHeartbeatMetricsMode(str, Enum):
8
+ MINIMAL = "minimal"
9
+ BASIC = "basic"
10
+ ALL = "all"
11
+ CUSTOM = "custom"
@@ -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):
@@ -10,14 +10,14 @@ from typing_extensions import Annotated, NotRequired, TypedDict
10
10
 
11
11
  class GetOutputSamplesByIDRequestTypedDict(TypedDict):
12
12
  id: str
13
- r"""Destination Id"""
13
+ r"""The <code>id</code> of the Destination to get sample event data for."""
14
14
 
15
15
 
16
16
  class GetOutputSamplesByIDRequest(BaseModel):
17
17
  id: Annotated[
18
18
  str, FieldMetadata(path=PathParamMetadata(style="simple", explode=False))
19
19
  ]
20
- r"""Destination Id"""
20
+ r"""The <code>id</code> of the Destination to get sample event data for."""
21
21
 
22
22
 
23
23
  class GetOutputSamplesByIDResponseTypedDict(TypedDict):
@@ -11,7 +11,7 @@ from typing_extensions import Annotated, NotRequired, TypedDict
11
11
 
12
12
  class GetPacksRequestTypedDict(TypedDict):
13
13
  with_: NotRequired[str]
14
- r"""Comma separated list of entities, \"outputs\", \"inputs\" """
14
+ r"""Comma-separated list of additional properties to include in the response. When set, the response includes a count of the specified properties in the Pack. Available values are <code>inputs</code> and <code>outputs</code>."""
15
15
 
16
16
 
17
17
  class GetPacksRequest(BaseModel):
@@ -20,7 +20,7 @@ class GetPacksRequest(BaseModel):
20
20
  pydantic.Field(alias="with"),
21
21
  FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
22
22
  ] = None
23
- r"""Comma separated list of entities, \"outputs\", \"inputs\" """
23
+ r"""Comma-separated list of additional properties to include in the response. When set, the response includes a count of the specified properties in the Pack. Available values are <code>inputs</code> and <code>outputs</code>."""
24
24
 
25
25
 
26
26
  class GetPacksResponseTypedDict(TypedDict):
@@ -10,7 +10,7 @@ from typing_extensions import Annotated, NotRequired, TypedDict
10
10
 
11
11
 
12
12
  class GetSummaryMode(str, Enum):
13
- r"""product filter"""
13
+ r"""Filter for limiting the response by Cribl product: Cribl Stream (<code>worker</code>) or Cribl Edge (<code>managed-edge</code>)."""
14
14
 
15
15
  WORKER = "worker"
16
16
  MANAGED_EDGE = "managed-edge"
@@ -18,7 +18,7 @@ class GetSummaryMode(str, Enum):
18
18
 
19
19
  class GetSummaryRequestTypedDict(TypedDict):
20
20
  mode: NotRequired[GetSummaryMode]
21
- r"""product filter"""
21
+ r"""Filter for limiting the response by Cribl product: Cribl Stream (<code>worker</code>) or Cribl Edge (<code>managed-edge</code>)."""
22
22
 
23
23
 
24
24
  class GetSummaryRequest(BaseModel):
@@ -26,7 +26,7 @@ class GetSummaryRequest(BaseModel):
26
26
  Optional[GetSummaryMode],
27
27
  FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
28
28
  ] = None
29
- r"""product filter"""
29
+ r"""Filter for limiting the response by Cribl product: Cribl Stream (<code>worker</code>) or Cribl Edge (<code>managed-edge</code>)."""
30
30
 
31
31
 
32
32
  class GetSummaryResponseTypedDict(TypedDict):
@@ -0,0 +1,24 @@
1
+ """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
2
+
3
+ from __future__ import annotations
4
+ from .authconfig import AuthConfig, AuthConfigTypedDict
5
+ from cribl_control_plane.types import BaseModel
6
+ from typing import List, Optional
7
+ from typing_extensions import NotRequired, TypedDict
8
+
9
+
10
+ class GetSystemSettingsAuthResponseTypedDict(TypedDict):
11
+ r"""a list of AuthConfig objects"""
12
+
13
+ count: NotRequired[int]
14
+ r"""number of items present in the items array"""
15
+ items: NotRequired[List[AuthConfigTypedDict]]
16
+
17
+
18
+ class GetSystemSettingsAuthResponse(BaseModel):
19
+ r"""a list of AuthConfig objects"""
20
+
21
+ count: Optional[int] = None
22
+ r"""number of items present in the items array"""
23
+
24
+ items: Optional[List[AuthConfig]] = None
@@ -0,0 +1,24 @@
1
+ """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
2
+
3
+ from __future__ import annotations
4
+ from .systemsettingsconf import SystemSettingsConf, SystemSettingsConfTypedDict
5
+ from cribl_control_plane.types import BaseModel
6
+ from typing import List, Optional
7
+ from typing_extensions import NotRequired, TypedDict
8
+
9
+
10
+ class GetSystemSettingsConfResponseTypedDict(TypedDict):
11
+ r"""a list of SystemSettingsConf objects"""
12
+
13
+ count: NotRequired[int]
14
+ r"""number of items present in the items array"""
15
+ items: NotRequired[List[SystemSettingsConfTypedDict]]
16
+
17
+
18
+ class GetSystemSettingsConfResponse(BaseModel):
19
+ r"""a list of SystemSettingsConf objects"""
20
+
21
+ count: Optional[int] = None
22
+ r"""number of items present in the items array"""
23
+
24
+ items: Optional[List[SystemSettingsConf]] = None
@@ -0,0 +1,24 @@
1
+ """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
2
+
3
+ from __future__ import annotations
4
+ from .gitsettings import GitSettings, GitSettingsTypedDict
5
+ from cribl_control_plane.types import BaseModel
6
+ from typing import List, Optional
7
+ from typing_extensions import NotRequired, TypedDict
8
+
9
+
10
+ class GetSystemSettingsGitSettingsResponseTypedDict(TypedDict):
11
+ r"""a list of GitSettings objects"""
12
+
13
+ count: NotRequired[int]
14
+ r"""number of items present in the items array"""
15
+ items: NotRequired[List[GitSettingsTypedDict]]
16
+
17
+
18
+ class GetSystemSettingsGitSettingsResponse(BaseModel):
19
+ r"""a list of GitSettings objects"""
20
+
21
+ count: Optional[int] = None
22
+ r"""number of items present in the items array"""
23
+
24
+ items: Optional[List[GitSettings]] = None
@@ -10,9 +10,9 @@ from typing_extensions import Annotated, NotRequired, TypedDict
10
10
 
11
11
  class GetVersionCountRequestTypedDict(TypedDict):
12
12
  group: NotRequired[str]
13
- r"""Group ID"""
13
+ r"""The <code>id</code> of the Worker Group or Edge Fleet to get the count for."""
14
14
  id: NotRequired[str]
15
- r"""Commit ID"""
15
+ r"""The Git commit hash to use as the starting point for the count."""
16
16
 
17
17
 
18
18
  class GetVersionCountRequest(BaseModel):
@@ -20,14 +20,14 @@ class GetVersionCountRequest(BaseModel):
20
20
  Optional[str],
21
21
  FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
22
22
  ] = None
23
- r"""Group ID"""
23
+ r"""The <code>id</code> of the Worker Group or Edge Fleet to get the count for."""
24
24
 
25
25
  id: Annotated[
26
26
  Optional[str],
27
27
  pydantic.Field(alias="ID"),
28
28
  FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
29
29
  ] = None
30
- r"""Commit ID"""
30
+ r"""The Git commit hash to use as the starting point for the count."""
31
31
 
32
32
 
33
33
  class GetVersionCountResponseTypedDict(TypedDict):
@@ -10,13 +10,13 @@ from typing_extensions import Annotated, NotRequired, TypedDict
10
10
 
11
11
  class GetVersionDiffRequestTypedDict(TypedDict):
12
12
  commit: NotRequired[str]
13
- r"""Commit hash (default is HEAD)"""
13
+ r"""The Git commit hash to get the diff for."""
14
14
  group: NotRequired[str]
15
- r"""Group ID"""
15
+ r"""The <code>id</code> of the Worker Group or Edge Fleet to get the diff for."""
16
16
  filename: NotRequired[str]
17
- r"""Filename"""
17
+ r"""The relative path of the file to get the diff for."""
18
18
  diff_line_limit: NotRequired[float]
19
- r"""Limit maximum lines in the diff"""
19
+ r"""Number of lines of the diff to return. Default is 1000. Set to <code>0</code> to return the full diff, regardless of the number of lines."""
20
20
 
21
21
 
22
22
  class GetVersionDiffRequest(BaseModel):
@@ -24,26 +24,26 @@ class GetVersionDiffRequest(BaseModel):
24
24
  Optional[str],
25
25
  FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
26
26
  ] = None
27
- r"""Commit hash (default is HEAD)"""
27
+ r"""The Git commit hash to get the diff for."""
28
28
 
29
29
  group: Annotated[
30
30
  Optional[str],
31
31
  FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
32
32
  ] = None
33
- r"""Group ID"""
33
+ r"""The <code>id</code> of the Worker Group or Edge Fleet to get the diff for."""
34
34
 
35
35
  filename: Annotated[
36
36
  Optional[str],
37
37
  FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
38
38
  ] = None
39
- r"""Filename"""
39
+ r"""The relative path of the file to get the diff for."""
40
40
 
41
41
  diff_line_limit: Annotated[
42
42
  Optional[float],
43
43
  pydantic.Field(alias="diffLineLimit"),
44
44
  FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
45
45
  ] = None
46
- r"""Limit maximum lines in the diff"""
46
+ r"""Number of lines of the diff to return. Default is 1000. Set to <code>0</code> to return the full diff, regardless of the number of lines."""
47
47
 
48
48
 
49
49
  class GetVersionDiffResponseTypedDict(TypedDict):
@@ -11,9 +11,9 @@ from typing_extensions import Annotated, NotRequired, TypedDict
11
11
 
12
12
  class GetVersionFilesRequestTypedDict(TypedDict):
13
13
  group: NotRequired[str]
14
- r"""Group ID"""
14
+ r"""The <code>id</code> of the Worker Group or Edge Fleet to get file names and status for."""
15
15
  id: NotRequired[str]
16
- r"""Commit ID"""
16
+ r"""The Git commit hash to use as the starting point for the request."""
17
17
 
18
18
 
19
19
  class GetVersionFilesRequest(BaseModel):
@@ -21,14 +21,14 @@ class GetVersionFilesRequest(BaseModel):
21
21
  Optional[str],
22
22
  FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
23
23
  ] = None
24
- r"""Group ID"""
24
+ r"""The <code>id</code> of the Worker Group or Edge Fleet to get file names and status for."""
25
25
 
26
26
  id: Annotated[
27
27
  Optional[str],
28
28
  pydantic.Field(alias="ID"),
29
29
  FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
30
30
  ] = None
31
- r"""Commit ID"""
31
+ r"""The Git commit hash to use as the starting point for the request."""
32
32
 
33
33
 
34
34
  class GetVersionFilesResponseTypedDict(TypedDict):
@@ -10,13 +10,13 @@ from typing_extensions import Annotated, NotRequired, TypedDict
10
10
 
11
11
  class GetVersionShowRequestTypedDict(TypedDict):
12
12
  commit: NotRequired[str]
13
- r"""Commit hash (default is HEAD)"""
13
+ r"""The Git commit hash to retrieve the diff and log message for."""
14
14
  group: NotRequired[str]
15
- r"""Group ID"""
15
+ r"""The <code>id</code> of the Worker Group or Edge Fleet to get the diff and log message for."""
16
16
  filename: NotRequired[str]
17
- r"""Filename"""
17
+ r"""The relative path of the file to get the diff and log message for."""
18
18
  diff_line_limit: NotRequired[float]
19
- r"""Limit maximum lines in the diff"""
19
+ r"""Number of lines of the diff to return. Default is 1000. Set to <code>0</code> to return the full diff, regardless of the number of lines."""
20
20
 
21
21
 
22
22
  class GetVersionShowRequest(BaseModel):
@@ -24,26 +24,26 @@ class GetVersionShowRequest(BaseModel):
24
24
  Optional[str],
25
25
  FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
26
26
  ] = None
27
- r"""Commit hash (default is HEAD)"""
27
+ r"""The Git commit hash to retrieve the diff and log message for."""
28
28
 
29
29
  group: Annotated[
30
30
  Optional[str],
31
31
  FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
32
32
  ] = None
33
- r"""Group ID"""
33
+ r"""The <code>id</code> of the Worker Group or Edge Fleet to get the diff and log message for."""
34
34
 
35
35
  filename: Annotated[
36
36
  Optional[str],
37
37
  FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
38
38
  ] = None
39
- r"""Filename"""
39
+ r"""The relative path of the file to get the diff and log message for."""
40
40
 
41
41
  diff_line_limit: Annotated[
42
42
  Optional[float],
43
43
  pydantic.Field(alias="diffLineLimit"),
44
44
  FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
45
45
  ] = None
46
- r"""Limit maximum lines in the diff"""
46
+ r"""Number of lines of the diff to return. Default is 1000. Set to <code>0</code> to return the full diff, regardless of the number of lines."""
47
47
 
48
48
 
49
49
  class GetVersionShowResponseTypedDict(TypedDict):
@@ -10,7 +10,7 @@ from typing_extensions import Annotated, NotRequired, TypedDict
10
10
 
11
11
  class GetVersionStatusRequestTypedDict(TypedDict):
12
12
  group: NotRequired[str]
13
- r"""Group ID"""
13
+ r"""The <code>id</code> of the Worker Group or Edge Fleet to get the status for."""
14
14
 
15
15
 
16
16
  class GetVersionStatusRequest(BaseModel):
@@ -18,7 +18,7 @@ class GetVersionStatusRequest(BaseModel):
18
18
  Optional[str],
19
19
  FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
20
20
  ] = None
21
- r"""Group ID"""
21
+ r"""The <code>id</code> of the Worker Group or Edge Fleet to get the status for."""
22
22
 
23
23
 
24
24
  class GetVersionStatusResponseTypedDict(TypedDict):
@@ -0,0 +1,10 @@
1
+ """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
2
+
3
+ from __future__ import annotations
4
+ from enum import Enum
5
+
6
+
7
+ class GitOpsType(str, Enum):
8
+ NONE = "none"
9
+ PULL = "pull"
10
+ PUSH = "push"